clang  5.0.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 37
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 Retrieve all ranges from all files that were skipped by the
631  * preprocessor.
632  *
633  * The preprocessor will skip lines when they are surrounded by an
634  * if/ifdef/ifndef directive whose condition does not evaluate to true.
635  */
637 
638 /**
639  * \brief Destroy the given \c CXSourceRangeList.
640  */
642 
643 /**
644  * @}
645  */
646 
647 /**
648  * \defgroup CINDEX_DIAG Diagnostic reporting
649  *
650  * @{
651  */
652 
653 /**
654  * \brief Describes the severity of a particular diagnostic.
655  */
657  /**
658  * \brief A diagnostic that has been suppressed, e.g., by a command-line
659  * option.
660  */
662 
663  /**
664  * \brief This diagnostic is a note that should be attached to the
665  * previous (non-note) diagnostic.
666  */
668 
669  /**
670  * \brief This diagnostic indicates suspicious code that may not be
671  * wrong.
672  */
674 
675  /**
676  * \brief This diagnostic indicates that the code is ill-formed.
677  */
679 
680  /**
681  * \brief This diagnostic indicates that the code is ill-formed such
682  * that future parser recovery is unlikely to produce useful
683  * results.
684  */
686 };
687 
688 /**
689  * \brief A single diagnostic, containing the diagnostic's severity,
690  * location, text, source ranges, and fix-it hints.
691  */
692 typedef void *CXDiagnostic;
693 
694 /**
695  * \brief A group of CXDiagnostics.
696  */
697 typedef void *CXDiagnosticSet;
698 
699 /**
700  * \brief Determine the number of diagnostics in a CXDiagnosticSet.
701  */
702 CINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags);
703 
704 /**
705  * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet.
706  *
707  * \param Diags the CXDiagnosticSet to query.
708  * \param Index the zero-based diagnostic number to retrieve.
709  *
710  * \returns the requested diagnostic. This diagnostic must be freed
711  * via a call to \c clang_disposeDiagnostic().
712  */
713 CINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags,
714  unsigned Index);
715 
716 /**
717  * \brief Describes the kind of error that occurred (if any) in a call to
718  * \c clang_loadDiagnostics.
719  */
721  /**
722  * \brief Indicates that no error occurred.
723  */
725 
726  /**
727  * \brief Indicates that an unknown error occurred while attempting to
728  * deserialize diagnostics.
729  */
731 
732  /**
733  * \brief Indicates that the file containing the serialized diagnostics
734  * could not be opened.
735  */
737 
738  /**
739  * \brief Indicates that the serialized diagnostics file is invalid or
740  * corrupt.
741  */
743 };
744 
745 /**
746  * \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode
747  * file.
748  *
749  * \param file The name of the file to deserialize.
750  * \param error A pointer to a enum value recording if there was a problem
751  * deserializing the diagnostics.
752  * \param errorString A pointer to a CXString for recording the error string
753  * if the file was not successfully loaded.
754  *
755  * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise. These
756  * diagnostics should be released using clang_disposeDiagnosticSet().
757  */
758 CINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file,
759  enum CXLoadDiag_Error *error,
760  CXString *errorString);
761 
762 /**
763  * \brief Release a CXDiagnosticSet and all of its contained diagnostics.
764  */
765 CINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags);
766 
767 /**
768  * \brief Retrieve the child diagnostics of a CXDiagnostic.
769  *
770  * This CXDiagnosticSet does not need to be released by
771  * clang_disposeDiagnosticSet.
772  */
773 CINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D);
774 
775 /**
776  * \brief Determine the number of diagnostics produced for the given
777  * translation unit.
778  */
779 CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit);
780 
781 /**
782  * \brief Retrieve a diagnostic associated with the given translation unit.
783  *
784  * \param Unit the translation unit to query.
785  * \param Index the zero-based diagnostic number to retrieve.
786  *
787  * \returns the requested diagnostic. This diagnostic must be freed
788  * via a call to \c clang_disposeDiagnostic().
789  */
790 CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit,
791  unsigned Index);
792 
793 /**
794  * \brief Retrieve the complete set of diagnostics associated with a
795  * translation unit.
796  *
797  * \param Unit the translation unit to query.
798  */
799 CINDEX_LINKAGE CXDiagnosticSet
800  clang_getDiagnosticSetFromTU(CXTranslationUnit Unit);
801 
802 /**
803  * \brief Destroy a diagnostic.
804  */
805 CINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic);
806 
807 /**
808  * \brief Options to control the display of diagnostics.
809  *
810  * The values in this enum are meant to be combined to customize the
811  * behavior of \c clang_formatDiagnostic().
812  */
814  /**
815  * \brief Display the source-location information where the
816  * diagnostic was located.
817  *
818  * When set, diagnostics will be prefixed by the file, line, and
819  * (optionally) column to which the diagnostic refers. For example,
820  *
821  * \code
822  * test.c:28: warning: extra tokens at end of #endif directive
823  * \endcode
824  *
825  * This option corresponds to the clang flag \c -fshow-source-location.
826  */
828 
829  /**
830  * \brief If displaying the source-location information of the
831  * diagnostic, also include the column number.
832  *
833  * This option corresponds to the clang flag \c -fshow-column.
834  */
836 
837  /**
838  * \brief If displaying the source-location information of the
839  * diagnostic, also include information about source ranges in a
840  * machine-parsable format.
841  *
842  * This option corresponds to the clang flag
843  * \c -fdiagnostics-print-source-range-info.
844  */
846 
847  /**
848  * \brief Display the option name associated with this diagnostic, if any.
849  *
850  * The option name displayed (e.g., -Wconversion) will be placed in brackets
851  * after the diagnostic text. This option corresponds to the clang flag
852  * \c -fdiagnostics-show-option.
853  */
855 
856  /**
857  * \brief Display the category number associated with this diagnostic, if any.
858  *
859  * The category number is displayed within brackets after the diagnostic text.
860  * This option corresponds to the clang flag
861  * \c -fdiagnostics-show-category=id.
862  */
864 
865  /**
866  * \brief Display the category name associated with this diagnostic, if any.
867  *
868  * The category name is displayed within brackets after the diagnostic text.
869  * This option corresponds to the clang flag
870  * \c -fdiagnostics-show-category=name.
871  */
873 };
874 
875 /**
876  * \brief Format the given diagnostic in a manner that is suitable for display.
877  *
878  * This routine will format the given diagnostic to a string, rendering
879  * the diagnostic according to the various options given. The
880  * \c clang_defaultDiagnosticDisplayOptions() function returns the set of
881  * options that most closely mimics the behavior of the clang compiler.
882  *
883  * \param Diagnostic The diagnostic to print.
884  *
885  * \param Options A set of options that control the diagnostic display,
886  * created by combining \c CXDiagnosticDisplayOptions values.
887  *
888  * \returns A new string containing for formatted diagnostic.
889  */
890 CINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic,
891  unsigned Options);
892 
893 /**
894  * \brief Retrieve the set of display options most similar to the
895  * default behavior of the clang compiler.
896  *
897  * \returns A set of display options suitable for use with \c
898  * clang_formatDiagnostic().
899  */
901 
902 /**
903  * \brief Determine the severity of the given diagnostic.
904  */
906 clang_getDiagnosticSeverity(CXDiagnostic);
907 
908 /**
909  * \brief Retrieve the source location of the given diagnostic.
910  *
911  * This location is where Clang would print the caret ('^') when
912  * displaying the diagnostic on the command line.
913  */
915 
916 /**
917  * \brief Retrieve the text of the given diagnostic.
918  */
920 
921 /**
922  * \brief Retrieve the name of the command-line option that enabled this
923  * diagnostic.
924  *
925  * \param Diag The diagnostic to be queried.
926  *
927  * \param Disable If non-NULL, will be set to the option that disables this
928  * diagnostic (if any).
929  *
930  * \returns A string that contains the command-line option used to enable this
931  * warning, such as "-Wconversion" or "-pedantic".
932  */
934  CXString *Disable);
935 
936 /**
937  * \brief Retrieve the category number for this diagnostic.
938  *
939  * Diagnostics can be categorized into groups along with other, related
940  * diagnostics (e.g., diagnostics under the same warning flag). This routine
941  * retrieves the category number for the given diagnostic.
942  *
943  * \returns The number of the category that contains this diagnostic, or zero
944  * if this diagnostic is uncategorized.
945  */
946 CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic);
947 
948 /**
949  * \brief Retrieve the name of a particular diagnostic category. This
950  * is now deprecated. Use clang_getDiagnosticCategoryText()
951  * instead.
952  *
953  * \param Category A diagnostic category number, as returned by
954  * \c clang_getDiagnosticCategory().
955  *
956  * \returns The name of the given diagnostic category.
957  */
960 
961 /**
962  * \brief Retrieve the diagnostic category text for a given diagnostic.
963  *
964  * \returns The text of the given diagnostic category.
965  */
967 
968 /**
969  * \brief Determine the number of source ranges associated with the given
970  * diagnostic.
971  */
972 CINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic);
973 
974 /**
975  * \brief Retrieve a source range associated with the diagnostic.
976  *
977  * A diagnostic's source ranges highlight important elements in the source
978  * code. On the command line, Clang displays source ranges by
979  * underlining them with '~' characters.
980  *
981  * \param Diagnostic the diagnostic whose range is being extracted.
982  *
983  * \param Range the zero-based index specifying which range to
984  *
985  * \returns the requested source range.
986  */
988  unsigned Range);
989 
990 /**
991  * \brief Determine the number of fix-it hints associated with the
992  * given diagnostic.
993  */
994 CINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic);
995 
996 /**
997  * \brief Retrieve the replacement information for a given fix-it.
998  *
999  * Fix-its are described in terms of a source range whose contents
1000  * should be replaced by a string. This approach generalizes over
1001  * three kinds of operations: removal of source code (the range covers
1002  * the code to be removed and the replacement string is empty),
1003  * replacement of source code (the range covers the code to be
1004  * replaced and the replacement string provides the new code), and
1005  * insertion (both the start and end of the range point at the
1006  * insertion location, and the replacement string provides the text to
1007  * insert).
1008  *
1009  * \param Diagnostic The diagnostic whose fix-its are being queried.
1010  *
1011  * \param FixIt The zero-based index of the fix-it.
1012  *
1013  * \param ReplacementRange The source range whose contents will be
1014  * replaced with the returned replacement string. Note that source
1015  * ranges are half-open ranges [a, b), so the source code should be
1016  * replaced from a and up to (but not including) b.
1017  *
1018  * \returns A string containing text that should be replace the source
1019  * code indicated by the \c ReplacementRange.
1020  */
1021 CINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic,
1022  unsigned FixIt,
1023  CXSourceRange *ReplacementRange);
1024 
1025 /**
1026  * @}
1027  */
1028 
1029 /**
1030  * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation
1031  *
1032  * The routines in this group provide the ability to create and destroy
1033  * translation units from files, either by parsing the contents of the files or
1034  * by reading in a serialized representation of a translation unit.
1035  *
1036  * @{
1037  */
1038 
1039 /**
1040  * \brief Get the original translation unit source file name.
1041  */
1043 clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
1044 
1045 /**
1046  * \brief Return the CXTranslationUnit for a given source file and the provided
1047  * command line arguments one would pass to the compiler.
1048  *
1049  * Note: The 'source_filename' argument is optional. If the caller provides a
1050  * NULL pointer, the name of the source file is expected to reside in the
1051  * specified command line arguments.
1052  *
1053  * Note: When encountered in 'clang_command_line_args', the following options
1054  * are ignored:
1055  *
1056  * '-c'
1057  * '-emit-ast'
1058  * '-fsyntax-only'
1059  * '-o <output file>' (both '-o' and '<output file>' are ignored)
1060  *
1061  * \param CIdx The index object with which the translation unit will be
1062  * associated.
1063  *
1064  * \param source_filename The name of the source file to load, or NULL if the
1065  * source file is included in \p clang_command_line_args.
1066  *
1067  * \param num_clang_command_line_args The number of command-line arguments in
1068  * \p clang_command_line_args.
1069  *
1070  * \param clang_command_line_args The command-line arguments that would be
1071  * passed to the \c clang executable if it were being invoked out-of-process.
1072  * These command-line options will be parsed and will affect how the translation
1073  * unit is parsed. Note that the following options are ignored: '-c',
1074  * '-emit-ast', '-fsyntax-only' (which is the default), and '-o <output file>'.
1075  *
1076  * \param num_unsaved_files the number of unsaved file entries in \p
1077  * unsaved_files.
1078  *
1079  * \param unsaved_files the files that have not yet been saved to disk
1080  * but may be required for code completion, including the contents of
1081  * those files. The contents and name of these files (as specified by
1082  * CXUnsavedFile) are copied when necessary, so the client only needs to
1083  * guarantee their validity until the call to this function returns.
1084  */
1086  CXIndex CIdx,
1087  const char *source_filename,
1088  int num_clang_command_line_args,
1089  const char * const *clang_command_line_args,
1090  unsigned num_unsaved_files,
1091  struct CXUnsavedFile *unsaved_files);
1092 
1093 /**
1094  * \brief Same as \c clang_createTranslationUnit2, but returns
1095  * the \c CXTranslationUnit instead of an error code. In case of an error this
1096  * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1097  * error codes.
1098  */
1100  CXIndex CIdx,
1101  const char *ast_filename);
1102 
1103 /**
1104  * \brief Create a translation unit from an AST file (\c -emit-ast).
1105  *
1106  * \param[out] out_TU A non-NULL pointer to store the created
1107  * \c CXTranslationUnit.
1108  *
1109  * \returns Zero on success, otherwise returns an error code.
1110  */
1112  CXIndex CIdx,
1113  const char *ast_filename,
1114  CXTranslationUnit *out_TU);
1115 
1116 /**
1117  * \brief Flags that control the creation of translation units.
1118  *
1119  * The enumerators in this enumeration type are meant to be bitwise
1120  * ORed together to specify which options should be used when
1121  * constructing the translation unit.
1122  */
1124  /**
1125  * \brief Used to indicate that no special translation-unit options are
1126  * needed.
1127  */
1129 
1130  /**
1131  * \brief Used to indicate that the parser should construct a "detailed"
1132  * preprocessing record, including all macro definitions and instantiations.
1133  *
1134  * Constructing a detailed preprocessing record requires more memory
1135  * and time to parse, since the information contained in the record
1136  * is usually not retained. However, it can be useful for
1137  * applications that require more detailed information about the
1138  * behavior of the preprocessor.
1139  */
1141 
1142  /**
1143  * \brief Used to indicate that the translation unit is incomplete.
1144  *
1145  * When a translation unit is considered "incomplete", semantic
1146  * analysis that is typically performed at the end of the
1147  * translation unit will be suppressed. For example, this suppresses
1148  * the completion of tentative declarations in C and of
1149  * instantiation of implicitly-instantiation function templates in
1150  * C++. This option is typically used when parsing a header with the
1151  * intent of producing a precompiled header.
1152  */
1154 
1155  /**
1156  * \brief Used to indicate that the translation unit should be built with an
1157  * implicit precompiled header for the preamble.
1158  *
1159  * An implicit precompiled header is used as an optimization when a
1160  * particular translation unit is likely to be reparsed many times
1161  * when the sources aren't changing that often. In this case, an
1162  * implicit precompiled header will be built containing all of the
1163  * initial includes at the top of the main file (what we refer to as
1164  * the "preamble" of the file). In subsequent parses, if the
1165  * preamble or the files in it have not changed, \c
1166  * clang_reparseTranslationUnit() will re-use the implicit
1167  * precompiled header to improve parsing performance.
1168  */
1170 
1171  /**
1172  * \brief Used to indicate that the translation unit should cache some
1173  * code-completion results with each reparse of the source file.
1174  *
1175  * Caching of code-completion results is a performance optimization that
1176  * introduces some overhead to reparsing but improves the performance of
1177  * code-completion operations.
1178  */
1180 
1181  /**
1182  * \brief Used to indicate that the translation unit will be serialized with
1183  * \c clang_saveTranslationUnit.
1184  *
1185  * This option is typically used when parsing a header with the intent of
1186  * producing a precompiled header.
1187  */
1189 
1190  /**
1191  * \brief DEPRECATED: Enabled chained precompiled preambles in C++.
1192  *
1193  * Note: this is a *temporary* option that is available only while
1194  * we are testing C++ precompiled preamble support. It is deprecated.
1195  */
1197 
1198  /**
1199  * \brief Used to indicate that function/method bodies should be skipped while
1200  * parsing.
1201  *
1202  * This option can be used to search for declarations/definitions while
1203  * ignoring the usages.
1204  */
1206 
1207  /**
1208  * \brief Used to indicate that brief documentation comments should be
1209  * included into the set of code completions returned from this translation
1210  * unit.
1211  */
1213 
1214  /**
1215  * \brief Used to indicate that the precompiled preamble should be created on
1216  * the first parse. Otherwise it will be created on the first reparse. This
1217  * trades runtime on the first parse (serializing the preamble takes time) for
1218  * reduced runtime on the second parse (can now reuse the preamble).
1219  */
1221 
1222  /**
1223  * \brief Do not stop processing when fatal errors are encountered.
1224  *
1225  * When fatal errors are encountered while parsing a translation unit,
1226  * semantic analysis is typically stopped early when compiling code. A common
1227  * source for fatal errors are unresolvable include files. For the
1228  * purposes of an IDE, this is undesirable behavior and as much information
1229  * as possible should be reported. Use this flag to enable this behavior.
1230  */
1232 };
1233 
1234 /**
1235  * \brief Returns the set of flags that is suitable for parsing a translation
1236  * unit that is being edited.
1237  *
1238  * The set of flags returned provide options for \c clang_parseTranslationUnit()
1239  * to indicate that the translation unit is likely to be reparsed many times,
1240  * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly
1241  * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag
1242  * set contains an unspecified set of optimizations (e.g., the precompiled
1243  * preamble) geared toward improving the performance of these routines. The
1244  * set of optimizations enabled may change from one version to the next.
1245  */
1247 
1248 /**
1249  * \brief Same as \c clang_parseTranslationUnit2, but returns
1250  * the \c CXTranslationUnit instead of an error code. In case of an error this
1251  * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1252  * error codes.
1253  */
1254 CINDEX_LINKAGE CXTranslationUnit
1255 clang_parseTranslationUnit(CXIndex CIdx,
1256  const char *source_filename,
1257  const char *const *command_line_args,
1258  int num_command_line_args,
1259  struct CXUnsavedFile *unsaved_files,
1260  unsigned num_unsaved_files,
1261  unsigned options);
1262 
1263 /**
1264  * \brief Parse the given source file and the translation unit corresponding
1265  * to that file.
1266  *
1267  * This routine is the main entry point for the Clang C API, providing the
1268  * ability to parse a source file into a translation unit that can then be
1269  * queried by other functions in the API. This routine accepts a set of
1270  * command-line arguments so that the compilation can be configured in the same
1271  * way that the compiler is configured on the command line.
1272  *
1273  * \param CIdx The index object with which the translation unit will be
1274  * associated.
1275  *
1276  * \param source_filename The name of the source file to load, or NULL if the
1277  * source file is included in \c command_line_args.
1278  *
1279  * \param command_line_args The command-line arguments that would be
1280  * passed to the \c clang executable if it were being invoked out-of-process.
1281  * These command-line options will be parsed and will affect how the translation
1282  * unit is parsed. Note that the following options are ignored: '-c',
1283  * '-emit-ast', '-fsyntax-only' (which is the default), and '-o <output file>'.
1284  *
1285  * \param num_command_line_args The number of command-line arguments in
1286  * \c command_line_args.
1287  *
1288  * \param unsaved_files the files that have not yet been saved to disk
1289  * but may be required for parsing, including the contents of
1290  * those files. The contents and name of these files (as specified by
1291  * CXUnsavedFile) are copied when necessary, so the client only needs to
1292  * guarantee their validity until the call to this function returns.
1293  *
1294  * \param num_unsaved_files the number of unsaved file entries in \p
1295  * unsaved_files.
1296  *
1297  * \param options A bitmask of options that affects how the translation unit
1298  * is managed but not its compilation. This should be a bitwise OR of the
1299  * CXTranslationUnit_XXX flags.
1300  *
1301  * \param[out] out_TU A non-NULL pointer to store the created
1302  * \c CXTranslationUnit, describing the parsed code and containing any
1303  * diagnostics produced by the compiler.
1304  *
1305  * \returns Zero on success, otherwise returns an error code.
1306  */
1308 clang_parseTranslationUnit2(CXIndex CIdx,
1309  const char *source_filename,
1310  const char *const *command_line_args,
1311  int num_command_line_args,
1312  struct CXUnsavedFile *unsaved_files,
1313  unsigned num_unsaved_files,
1314  unsigned options,
1315  CXTranslationUnit *out_TU);
1316 
1317 /**
1318  * \brief Same as clang_parseTranslationUnit2 but requires a full command line
1319  * for \c command_line_args including argv[0]. This is useful if the standard
1320  * library paths are relative to the binary.
1321  */
1323  CXIndex CIdx, const char *source_filename,
1324  const char *const *command_line_args, int num_command_line_args,
1325  struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
1326  unsigned options, CXTranslationUnit *out_TU);
1327 
1328 /**
1329  * \brief Flags that control how translation units are saved.
1330  *
1331  * The enumerators in this enumeration type are meant to be bitwise
1332  * ORed together to specify which options should be used when
1333  * saving the translation unit.
1334  */
1336  /**
1337  * \brief Used to indicate that no special saving options are needed.
1338  */
1340 };
1341 
1342 /**
1343  * \brief Returns the set of flags that is suitable for saving a translation
1344  * unit.
1345  *
1346  * The set of flags returned provide options for
1347  * \c clang_saveTranslationUnit() by default. The returned flag
1348  * set contains an unspecified set of options that save translation units with
1349  * the most commonly-requested data.
1350  */
1351 CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU);
1352 
1353 /**
1354  * \brief Describes the kind of error that occurred (if any) in a call to
1355  * \c clang_saveTranslationUnit().
1356  */
1358  /**
1359  * \brief Indicates that no error occurred while saving a translation unit.
1360  */
1362 
1363  /**
1364  * \brief Indicates that an unknown error occurred while attempting to save
1365  * the file.
1366  *
1367  * This error typically indicates that file I/O failed when attempting to
1368  * write the file.
1369  */
1371 
1372  /**
1373  * \brief Indicates that errors during translation prevented this attempt
1374  * to save the translation unit.
1375  *
1376  * Errors that prevent the translation unit from being saved can be
1377  * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic().
1378  */
1380 
1381  /**
1382  * \brief Indicates that the translation unit to be saved was somehow
1383  * invalid (e.g., NULL).
1384  */
1386 };
1387 
1388 /**
1389  * \brief Saves a translation unit into a serialized representation of
1390  * that translation unit on disk.
1391  *
1392  * Any translation unit that was parsed without error can be saved
1393  * into a file. The translation unit can then be deserialized into a
1394  * new \c CXTranslationUnit with \c clang_createTranslationUnit() or,
1395  * if it is an incomplete translation unit that corresponds to a
1396  * header, used as a precompiled header when parsing other translation
1397  * units.
1398  *
1399  * \param TU The translation unit to save.
1400  *
1401  * \param FileName The file to which the translation unit will be saved.
1402  *
1403  * \param options A bitmask of options that affects how the translation unit
1404  * is saved. This should be a bitwise OR of the
1405  * CXSaveTranslationUnit_XXX flags.
1406  *
1407  * \returns A value that will match one of the enumerators of the CXSaveError
1408  * enumeration. Zero (CXSaveError_None) indicates that the translation unit was
1409  * saved successfully, while a non-zero value indicates that a problem occurred.
1410  */
1411 CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU,
1412  const char *FileName,
1413  unsigned options);
1414 
1415 /**
1416  * \brief Destroy the specified CXTranslationUnit object.
1417  */
1418 CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit);
1419 
1420 /**
1421  * \brief Flags that control the reparsing of translation units.
1422  *
1423  * The enumerators in this enumeration type are meant to be bitwise
1424  * ORed together to specify which options should be used when
1425  * reparsing the translation unit.
1426  */
1428  /**
1429  * \brief Used to indicate that no special reparsing options are needed.
1430  */
1432 };
1433 
1434 /**
1435  * \brief Returns the set of flags that is suitable for reparsing a translation
1436  * unit.
1437  *
1438  * The set of flags returned provide options for
1439  * \c clang_reparseTranslationUnit() by default. The returned flag
1440  * set contains an unspecified set of optimizations geared toward common uses
1441  * of reparsing. The set of optimizations enabled may change from one version
1442  * to the next.
1443  */
1444 CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU);
1445 
1446 /**
1447  * \brief Reparse the source files that produced this translation unit.
1448  *
1449  * This routine can be used to re-parse the source files that originally
1450  * created the given translation unit, for example because those source files
1451  * have changed (either on disk or as passed via \p unsaved_files). The
1452  * source code will be reparsed with the same command-line options as it
1453  * was originally parsed.
1454  *
1455  * Reparsing a translation unit invalidates all cursors and source locations
1456  * that refer into that translation unit. This makes reparsing a translation
1457  * unit semantically equivalent to destroying the translation unit and then
1458  * creating a new translation unit with the same command-line arguments.
1459  * However, it may be more efficient to reparse a translation
1460  * unit using this routine.
1461  *
1462  * \param TU The translation unit whose contents will be re-parsed. The
1463  * translation unit must originally have been built with
1464  * \c clang_createTranslationUnitFromSourceFile().
1465  *
1466  * \param num_unsaved_files The number of unsaved file entries in \p
1467  * unsaved_files.
1468  *
1469  * \param unsaved_files The files that have not yet been saved to disk
1470  * but may be required for parsing, including the contents of
1471  * those files. The contents and name of these files (as specified by
1472  * CXUnsavedFile) are copied when necessary, so the client only needs to
1473  * guarantee their validity until the call to this function returns.
1474  *
1475  * \param options A bitset of options composed of the flags in CXReparse_Flags.
1476  * The function \c clang_defaultReparseOptions() produces a default set of
1477  * options recommended for most uses, based on the translation unit.
1478  *
1479  * \returns 0 if the sources could be reparsed. A non-zero error code will be
1480  * returned if reparsing was impossible, such that the translation unit is
1481  * invalid. In such cases, the only valid call for \c TU is
1482  * \c clang_disposeTranslationUnit(TU). The error codes returned by this
1483  * routine are described by the \c CXErrorCode enum.
1484  */
1485 CINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU,
1486  unsigned num_unsaved_files,
1487  struct CXUnsavedFile *unsaved_files,
1488  unsigned options);
1489 
1490 /**
1491  * \brief Categorizes how memory is being used by a translation unit.
1492  */
1511 
1514 };
1515 
1516 /**
1517  * \brief Returns the human-readable null-terminated C string that represents
1518  * the name of the memory category. This string should never be freed.
1519  */
1522 
1523 typedef struct CXTUResourceUsageEntry {
1524  /* \brief The memory usage category. */
1526  /* \brief Amount of resources used.
1527  The units will depend on the resource kind. */
1528  unsigned long amount;
1530 
1531 /**
1532  * \brief The memory usage of a CXTranslationUnit, broken into categories.
1533  */
1534 typedef struct CXTUResourceUsage {
1535  /* \brief Private data member, used for queries. */
1536  void *data;
1537 
1538  /* \brief The number of entries in the 'entries' array. */
1539  unsigned numEntries;
1540 
1541  /* \brief An array of key-value pairs, representing the breakdown of memory
1542  usage. */
1544 
1546 
1547 /**
1548  * \brief Return the memory usage of a translation unit. This object
1549  * should be released with clang_disposeCXTUResourceUsage().
1550  */
1552 
1554 
1555 /**
1556  * @}
1557  */
1558 
1559 /**
1560  * \brief Describes the kind of entity that a cursor refers to.
1561  */
1563  /* Declarations */
1564  /**
1565  * \brief A declaration whose specific kind is not exposed via this
1566  * interface.
1567  *
1568  * Unexposed declarations have the same operations as any other kind
1569  * of declaration; one can extract their location information,
1570  * spelling, find their definitions, etc. However, the specific kind
1571  * of the declaration is not reported.
1572  */
1574  /** \brief A C or C++ struct. */
1576  /** \brief A C or C++ union. */
1578  /** \brief A C++ class. */
1580  /** \brief An enumeration. */
1582  /**
1583  * \brief A field (in C) or non-static data member (in C++) in a
1584  * struct, union, or C++ class.
1585  */
1587  /** \brief An enumerator constant. */
1589  /** \brief A function. */
1591  /** \brief A variable. */
1593  /** \brief A function or method parameter. */
1595  /** \brief An Objective-C \@interface. */
1597  /** \brief An Objective-C \@interface for a category. */
1599  /** \brief An Objective-C \@protocol declaration. */
1601  /** \brief An Objective-C \@property declaration. */
1603  /** \brief An Objective-C instance variable. */
1605  /** \brief An Objective-C instance method. */
1607  /** \brief An Objective-C class method. */
1609  /** \brief An Objective-C \@implementation. */
1611  /** \brief An Objective-C \@implementation for a category. */
1613  /** \brief A typedef. */
1615  /** \brief A C++ class method. */
1617  /** \brief A C++ namespace. */
1619  /** \brief A linkage specification, e.g. 'extern "C"'. */
1621  /** \brief A C++ constructor. */
1623  /** \brief A C++ destructor. */
1625  /** \brief A C++ conversion function. */
1627  /** \brief A C++ template type parameter. */
1629  /** \brief A C++ non-type template parameter. */
1631  /** \brief A C++ template template parameter. */
1633  /** \brief A C++ function template. */
1635  /** \brief A C++ class template. */
1637  /** \brief A C++ class template partial specialization. */
1639  /** \brief A C++ namespace alias declaration. */
1641  /** \brief A C++ using directive. */
1643  /** \brief A C++ using declaration. */
1645  /** \brief A C++ alias declaration */
1647  /** \brief An Objective-C \@synthesize definition. */
1649  /** \brief An Objective-C \@dynamic definition. */
1651  /** \brief An access specifier. */
1653 
1656 
1657  /* References */
1658  CXCursor_FirstRef = 40, /* Decl references */
1662  /**
1663  * \brief A reference to a type declaration.
1664  *
1665  * A type reference occurs anywhere where a type is named but not
1666  * declared. For example, given:
1667  *
1668  * \code
1669  * typedef unsigned size_type;
1670  * size_type size;
1671  * \endcode
1672  *
1673  * The typedef is a declaration of size_type (CXCursor_TypedefDecl),
1674  * while the type of the variable "size" is referenced. The cursor
1675  * referenced by the type of size is the typedef for size_type.
1676  */
1679  /**
1680  * \brief A reference to a class template, function template, template
1681  * template parameter, or class template partial specialization.
1682  */
1684  /**
1685  * \brief A reference to a namespace or namespace alias.
1686  */
1688  /**
1689  * \brief A reference to a member of a struct, union, or class that occurs in
1690  * some non-expression context, e.g., a designated initializer.
1691  */
1693  /**
1694  * \brief A reference to a labeled statement.
1695  *
1696  * This cursor kind is used to describe the jump to "start_over" in the
1697  * goto statement in the following example:
1698  *
1699  * \code
1700  * start_over:
1701  * ++counter;
1702  *
1703  * goto start_over;
1704  * \endcode
1705  *
1706  * A label reference cursor refers to a label statement.
1707  */
1709 
1710  /**
1711  * \brief A reference to a set of overloaded functions or function templates
1712  * that has not yet been resolved to a specific function or function template.
1713  *
1714  * An overloaded declaration reference cursor occurs in C++ templates where
1715  * a dependent name refers to a function. For example:
1716  *
1717  * \code
1718  * template<typename T> void swap(T&, T&);
1719  *
1720  * struct X { ... };
1721  * void swap(X&, X&);
1722  *
1723  * template<typename T>
1724  * void reverse(T* first, T* last) {
1725  * while (first < last - 1) {
1726  * swap(*first, *--last);
1727  * ++first;
1728  * }
1729  * }
1730  *
1731  * struct Y { };
1732  * void swap(Y&, Y&);
1733  * \endcode
1734  *
1735  * Here, the identifier "swap" is associated with an overloaded declaration
1736  * reference. In the template definition, "swap" refers to either of the two
1737  * "swap" functions declared above, so both results will be available. At
1738  * instantiation time, "swap" may also refer to other functions found via
1739  * argument-dependent lookup (e.g., the "swap" function at the end of the
1740  * example).
1741  *
1742  * The functions \c clang_getNumOverloadedDecls() and
1743  * \c clang_getOverloadedDecl() can be used to retrieve the definitions
1744  * referenced by this cursor.
1745  */
1747 
1748  /**
1749  * \brief A reference to a variable that occurs in some non-expression
1750  * context, e.g., a C++ lambda capture list.
1751  */
1753 
1755 
1756  /* Error conditions */
1763 
1764  /* Expressions */
1766 
1767  /**
1768  * \brief An expression whose specific kind is not exposed via this
1769  * interface.
1770  *
1771  * Unexposed expressions have the same operations as any other kind
1772  * of expression; one can extract their location information,
1773  * spelling, children, etc. However, the specific kind of the
1774  * expression is not reported.
1775  */
1777 
1778  /**
1779  * \brief An expression that refers to some value declaration, such
1780  * as a function, variable, or enumerator.
1781  */
1783 
1784  /**
1785  * \brief An expression that refers to a member of a struct, union,
1786  * class, Objective-C class, etc.
1787  */
1789 
1790  /** \brief An expression that calls a function. */
1792 
1793  /** \brief An expression that sends a message to an Objective-C
1794  object or class. */
1796 
1797  /** \brief An expression that represents a block literal. */
1799 
1800  /** \brief An integer literal.
1801  */
1803 
1804  /** \brief A floating point number literal.
1805  */
1807 
1808  /** \brief An imaginary number literal.
1809  */
1811 
1812  /** \brief A string literal.
1813  */
1815 
1816  /** \brief A character literal.
1817  */
1819 
1820  /** \brief A parenthesized expression, e.g. "(1)".
1821  *
1822  * This AST node is only formed if full location information is requested.
1823  */
1825 
1826  /** \brief This represents the unary-expression's (except sizeof and
1827  * alignof).
1828  */
1830 
1831  /** \brief [C99 6.5.2.1] Array Subscripting.
1832  */
1834 
1835  /** \brief A builtin binary operation expression such as "x + y" or
1836  * "x <= y".
1837  */
1839 
1840  /** \brief Compound assignment such as "+=".
1841  */
1843 
1844  /** \brief The ?: ternary operator.
1845  */
1847 
1848  /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++
1849  * (C++ [expr.cast]), which uses the syntax (Type)expr.
1850  *
1851  * For example: (int)f.
1852  */
1854 
1855  /** \brief [C99 6.5.2.5]
1856  */
1858 
1859  /** \brief Describes an C or C++ initializer list.
1860  */
1862 
1863  /** \brief The GNU address of label extension, representing &&label.
1864  */
1866 
1867  /** \brief This is the GNU Statement Expression extension: ({int X=4; X;})
1868  */
1870 
1871  /** \brief Represents a C11 generic selection.
1872  */
1874 
1875  /** \brief Implements the GNU __null extension, which is a name for a null
1876  * pointer constant that has integral type (e.g., int or long) and is the same
1877  * size and alignment as a pointer.
1878  *
1879  * The __null extension is typically only used by system headers, which define
1880  * NULL as __null in C++ rather than using 0 (which is an integer that may not
1881  * match the size of a pointer).
1882  */
1884 
1885  /** \brief C++'s static_cast<> expression.
1886  */
1888 
1889  /** \brief C++'s dynamic_cast<> expression.
1890  */
1892 
1893  /** \brief C++'s reinterpret_cast<> expression.
1894  */
1896 
1897  /** \brief C++'s const_cast<> expression.
1898  */
1900 
1901  /** \brief Represents an explicit C++ type conversion that uses "functional"
1902  * notion (C++ [expr.type.conv]).
1903  *
1904  * Example:
1905  * \code
1906  * x = int(0.5);
1907  * \endcode
1908  */
1910 
1911  /** \brief A C++ typeid expression (C++ [expr.typeid]).
1912  */
1914 
1915  /** \brief [C++ 2.13.5] C++ Boolean Literal.
1916  */
1918 
1919  /** \brief [C++0x 2.14.7] C++ Pointer Literal.
1920  */
1922 
1923  /** \brief Represents the "this" expression in C++
1924  */
1926 
1927  /** \brief [C++ 15] C++ Throw Expression.
1928  *
1929  * This handles 'throw' and 'throw' assignment-expression. When
1930  * assignment-expression isn't present, Op will be null.
1931  */
1933 
1934  /** \brief A new expression for memory allocation and constructor calls, e.g:
1935  * "new CXXNewExpr(foo)".
1936  */
1938 
1939  /** \brief A delete expression for memory deallocation and destructor calls,
1940  * e.g. "delete[] pArray".
1941  */
1943 
1944  /** \brief A unary expression. (noexcept, sizeof, or other traits)
1945  */
1947 
1948  /** \brief An Objective-C string literal i.e. @"foo".
1949  */
1951 
1952  /** \brief An Objective-C \@encode expression.
1953  */
1955 
1956  /** \brief An Objective-C \@selector expression.
1957  */
1959 
1960  /** \brief An Objective-C \@protocol expression.
1961  */
1963 
1964  /** \brief An Objective-C "bridged" cast expression, which casts between
1965  * Objective-C pointers and C pointers, transferring ownership in the process.
1966  *
1967  * \code
1968  * NSString *str = (__bridge_transfer NSString *)CFCreateString();
1969  * \endcode
1970  */
1972 
1973  /** \brief Represents a C++0x pack expansion that produces a sequence of
1974  * expressions.
1975  *
1976  * A pack expansion expression contains a pattern (which itself is an
1977  * expression) followed by an ellipsis. For example:
1978  *
1979  * \code
1980  * template<typename F, typename ...Types>
1981  * void forward(F f, Types &&...args) {
1982  * f(static_cast<Types&&>(args)...);
1983  * }
1984  * \endcode
1985  */
1987 
1988  /** \brief Represents an expression that computes the length of a parameter
1989  * pack.
1990  *
1991  * \code
1992  * template<typename ...Types>
1993  * struct count {
1994  * static const unsigned value = sizeof...(Types);
1995  * };
1996  * \endcode
1997  */
1999 
2000  /* \brief Represents a C++ lambda expression that produces a local function
2001  * object.
2002  *
2003  * \code
2004  * void abssort(float *x, unsigned N) {
2005  * std::sort(x, x + N,
2006  * [](float a, float b) {
2007  * return std::abs(a) < std::abs(b);
2008  * });
2009  * }
2010  * \endcode
2011  */
2013 
2014  /** \brief Objective-c Boolean Literal.
2015  */
2017 
2018  /** \brief Represents the "self" expression in an Objective-C method.
2019  */
2021 
2022  /** \brief OpenMP 4.0 [2.4, Array Section].
2023  */
2025 
2026  /** \brief Represents an @available(...) check.
2027  */
2029 
2031 
2032  /* Statements */
2034  /**
2035  * \brief A statement whose specific kind is not exposed via this
2036  * interface.
2037  *
2038  * Unexposed statements have the same operations as any other kind of
2039  * statement; one can extract their location information, spelling,
2040  * children, etc. However, the specific kind of the statement is not
2041  * reported.
2042  */
2044 
2045  /** \brief A labelled statement in a function.
2046  *
2047  * This cursor kind is used to describe the "start_over:" label statement in
2048  * the following example:
2049  *
2050  * \code
2051  * start_over:
2052  * ++counter;
2053  * \endcode
2054  *
2055  */
2057 
2058  /** \brief A group of statements like { stmt stmt }.
2059  *
2060  * This cursor kind is used to describe compound statements, e.g. function
2061  * bodies.
2062  */
2064 
2065  /** \brief A case statement.
2066  */
2068 
2069  /** \brief A default statement.
2070  */
2072 
2073  /** \brief An if statement
2074  */
2076 
2077  /** \brief A switch statement.
2078  */
2080 
2081  /** \brief A while statement.
2082  */
2084 
2085  /** \brief A do statement.
2086  */
2088 
2089  /** \brief A for statement.
2090  */
2092 
2093  /** \brief A goto statement.
2094  */
2096 
2097  /** \brief An indirect goto statement.
2098  */
2100 
2101  /** \brief A continue statement.
2102  */
2104 
2105  /** \brief A break statement.
2106  */
2108 
2109  /** \brief A return statement.
2110  */
2112 
2113  /** \brief A GCC inline assembly statement extension.
2114  */
2117 
2118  /** \brief Objective-C's overall \@try-\@catch-\@finally statement.
2119  */
2121 
2122  /** \brief Objective-C's \@catch statement.
2123  */
2125 
2126  /** \brief Objective-C's \@finally statement.
2127  */
2129 
2130  /** \brief Objective-C's \@throw statement.
2131  */
2133 
2134  /** \brief Objective-C's \@synchronized statement.
2135  */
2137 
2138  /** \brief Objective-C's autorelease pool statement.
2139  */
2141 
2142  /** \brief Objective-C's collection statement.
2143  */
2145 
2146  /** \brief C++'s catch statement.
2147  */
2149 
2150  /** \brief C++'s try statement.
2151  */
2153 
2154  /** \brief C++'s for (* : *) statement.
2155  */
2157 
2158  /** \brief Windows Structured Exception Handling's try statement.
2159  */
2161 
2162  /** \brief Windows Structured Exception Handling's except statement.
2163  */
2165 
2166  /** \brief Windows Structured Exception Handling's finally statement.
2167  */
2169 
2170  /** \brief A MS inline assembly statement extension.
2171  */
2173 
2174  /** \brief The null statement ";": C99 6.8.3p3.
2175  *
2176  * This cursor kind is used to describe the null statement.
2177  */
2179 
2180  /** \brief Adaptor class for mixing declarations with statements and
2181  * expressions.
2182  */
2184 
2185  /** \brief OpenMP parallel directive.
2186  */
2188 
2189  /** \brief OpenMP SIMD directive.
2190  */
2192 
2193  /** \brief OpenMP for directive.
2194  */
2196 
2197  /** \brief OpenMP sections directive.
2198  */
2200 
2201  /** \brief OpenMP section directive.
2202  */
2204 
2205  /** \brief OpenMP single directive.
2206  */
2208 
2209  /** \brief OpenMP parallel for directive.
2210  */
2212 
2213  /** \brief OpenMP parallel sections directive.
2214  */
2216 
2217  /** \brief OpenMP task directive.
2218  */
2220 
2221  /** \brief OpenMP master directive.
2222  */
2224 
2225  /** \brief OpenMP critical directive.
2226  */
2228 
2229  /** \brief OpenMP taskyield directive.
2230  */
2232 
2233  /** \brief OpenMP barrier directive.
2234  */
2236 
2237  /** \brief OpenMP taskwait directive.
2238  */
2240 
2241  /** \brief OpenMP flush directive.
2242  */
2244 
2245  /** \brief Windows Structured Exception Handling's leave statement.
2246  */
2248 
2249  /** \brief OpenMP ordered directive.
2250  */
2252 
2253  /** \brief OpenMP atomic directive.
2254  */
2256 
2257  /** \brief OpenMP for SIMD directive.
2258  */
2260 
2261  /** \brief OpenMP parallel for SIMD directive.
2262  */
2264 
2265  /** \brief OpenMP target directive.
2266  */
2268 
2269  /** \brief OpenMP teams directive.
2270  */
2272 
2273  /** \brief OpenMP taskgroup directive.
2274  */
2276 
2277  /** \brief OpenMP cancellation point directive.
2278  */
2280 
2281  /** \brief OpenMP cancel directive.
2282  */
2284 
2285  /** \brief OpenMP target data directive.
2286  */
2288 
2289  /** \brief OpenMP taskloop directive.
2290  */
2292 
2293  /** \brief OpenMP taskloop simd directive.
2294  */
2296 
2297  /** \brief OpenMP distribute directive.
2298  */
2300 
2301  /** \brief OpenMP target enter data directive.
2302  */
2304 
2305  /** \brief OpenMP target exit data directive.
2306  */
2308 
2309  /** \brief OpenMP target parallel directive.
2310  */
2312 
2313  /** \brief OpenMP target parallel for directive.
2314  */
2316 
2317  /** \brief OpenMP target update directive.
2318  */
2320 
2321  /** \brief OpenMP distribute parallel for directive.
2322  */
2324 
2325  /** \brief OpenMP distribute parallel for simd directive.
2326  */
2328 
2329  /** \brief OpenMP distribute simd directive.
2330  */
2332 
2333  /** \brief OpenMP target parallel for simd directive.
2334  */
2336 
2337  /** \brief OpenMP target simd directive.
2338  */
2340 
2341  /** \brief OpenMP teams distribute directive.
2342  */
2344 
2345  /** \brief OpenMP teams distribute simd directive.
2346  */
2348 
2349  /** \brief OpenMP teams distribute parallel for simd directive.
2350  */
2352 
2353  /** \brief OpenMP teams distribute parallel for directive.
2354  */
2356 
2357  /** \brief OpenMP target teams directive.
2358  */
2360 
2361  /** \brief OpenMP target teams distribute directive.
2362  */
2364 
2365  /** \brief OpenMP target teams distribute parallel for directive.
2366  */
2368 
2369  /** \brief OpenMP target teams distribute parallel for simd directive.
2370  */
2372 
2373  /** \brief OpenMP target teams distribute simd directive.
2374  */
2376 
2378 
2379  /**
2380  * \brief Cursor that represents the translation unit itself.
2381  *
2382  * The translation unit cursor exists primarily to act as the root
2383  * cursor for traversing the contents of a translation unit.
2384  */
2386 
2387  /* Attributes */
2389  /**
2390  * \brief An attribute whose specific kind is not exposed via this
2391  * interface.
2392  */
2394 
2415 
2416  /* Preprocessing */
2424 
2425  /* Extra Declarations */
2426  /**
2427  * \brief A module import declaration.
2428  */
2431  /**
2432  * \brief A static_assert or _Static_assert node
2433  */
2435  /**
2436  * \brief a friend declaration.
2437  */
2441 
2442  /**
2443  * \brief A code completion overload candidate.
2444  */
2446 };
2447 
2448 /**
2449  * \brief A cursor representing some element in the abstract syntax tree for
2450  * a translation unit.
2451  *
2452  * The cursor abstraction unifies the different kinds of entities in a
2453  * program--declaration, statements, expressions, references to declarations,
2454  * etc.--under a single "cursor" abstraction with a common set of operations.
2455  * Common operation for a cursor include: getting the physical location in
2456  * a source file where the cursor points, getting the name associated with a
2457  * cursor, and retrieving cursors for any child nodes of a particular cursor.
2458  *
2459  * Cursors can be produced in two specific ways.
2460  * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
2461  * from which one can use clang_visitChildren() to explore the rest of the
2462  * translation unit. clang_getCursor() maps from a physical source location
2463  * to the entity that resides at that location, allowing one to map from the
2464  * source code into the AST.
2465  */
2466 typedef struct {
2468  int xdata;
2469  const void *data[3];
2470 } CXCursor;
2471 
2472 /**
2473  * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
2474  *
2475  * @{
2476  */
2477 
2478 /**
2479  * \brief Retrieve the NULL cursor, which represents no entity.
2480  */
2482 
2483 /**
2484  * \brief Retrieve the cursor that represents the given translation unit.
2485  *
2486  * The translation unit cursor can be used to start traversing the
2487  * various declarations within the given translation unit.
2488  */
2490 
2491 /**
2492  * \brief Determine whether two cursors are equivalent.
2493  */
2495 
2496 /**
2497  * \brief Returns non-zero if \p cursor is null.
2498  */
2500 
2501 /**
2502  * \brief Compute a hash value for the given cursor.
2503  */
2505 
2506 /**
2507  * \brief Retrieve the kind of the given cursor.
2508  */
2510 
2511 /**
2512  * \brief Determine whether the given cursor kind represents a declaration.
2513  */
2515 
2516 /**
2517  * \brief Determine whether the given cursor kind represents a simple
2518  * reference.
2519  *
2520  * Note that other kinds of cursors (such as expressions) can also refer to
2521  * other cursors. Use clang_getCursorReferenced() to determine whether a
2522  * particular cursor refers to another entity.
2523  */
2525 
2526 /**
2527  * \brief Determine whether the given cursor kind represents an expression.
2528  */
2530 
2531 /**
2532  * \brief Determine whether the given cursor kind represents a statement.
2533  */
2535 
2536 /**
2537  * \brief Determine whether the given cursor kind represents an attribute.
2538  */
2540 
2541 /**
2542  * \brief Determine whether the given cursor has any attributes.
2543  */
2545 
2546 /**
2547  * \brief Determine whether the given cursor kind represents an invalid
2548  * cursor.
2549  */
2551 
2552 /**
2553  * \brief Determine whether the given cursor kind represents a translation
2554  * unit.
2555  */
2557 
2558 /***
2559  * \brief Determine whether the given cursor represents a preprocessing
2560  * element, such as a preprocessor directive or macro instantiation.
2561  */
2563 
2564 /***
2565  * \brief Determine whether the given cursor represents a currently
2566  * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
2567  */
2569 
2570 /**
2571  * \brief Describe the linkage of the entity referred to by a cursor.
2572  */
2574  /** \brief This value indicates that no linkage information is available
2575  * for a provided CXCursor. */
2577  /**
2578  * \brief This is the linkage for variables, parameters, and so on that
2579  * have automatic storage. This covers normal (non-extern) local variables.
2580  */
2582  /** \brief This is the linkage for static variables and static functions. */
2584  /** \brief This is the linkage for entities with external linkage that live
2585  * in C++ anonymous namespaces.*/
2587  /** \brief This is the linkage for entities with true, external linkage. */
2589 };
2590 
2591 /**
2592  * \brief Determine the linkage of the entity referred to by a given cursor.
2593  */
2595 
2597  /** \brief This value indicates that no visibility information is available
2598  * for a provided CXCursor. */
2600 
2601  /** \brief Symbol not seen by the linker. */
2603  /** \brief Symbol seen by the linker but resolves to a symbol inside this object. */
2605  /** \brief Symbol seen by the linker and acts like a normal symbol. */
2607 };
2608 
2609 /**
2610  * \brief Describe the visibility of the entity referred to by a cursor.
2611  *
2612  * This returns the default visibility if not explicitly specified by
2613  * a visibility attribute. The default visibility may be changed by
2614  * commandline arguments.
2615  *
2616  * \param cursor The cursor to query.
2617  *
2618  * \returns The visibility of the cursor.
2619  */
2621 
2622 /**
2623  * \brief Determine the availability of the entity that this cursor refers to,
2624  * taking the current target platform into account.
2625  *
2626  * \param cursor The cursor to query.
2627  *
2628  * \returns The availability of the cursor.
2629  */
2632 
2633 /**
2634  * Describes the availability of a given entity on a particular platform, e.g.,
2635  * a particular class might only be available on Mac OS 10.7 or newer.
2636  */
2637 typedef struct CXPlatformAvailability {
2638  /**
2639  * \brief A string that describes the platform for which this structure
2640  * provides availability information.
2641  *
2642  * Possible values are "ios" or "macos".
2643  */
2645  /**
2646  * \brief The version number in which this entity was introduced.
2647  */
2649  /**
2650  * \brief The version number in which this entity was deprecated (but is
2651  * still available).
2652  */
2654  /**
2655  * \brief The version number in which this entity was obsoleted, and therefore
2656  * is no longer available.
2657  */
2659  /**
2660  * \brief Whether the entity is unconditionally unavailable on this platform.
2661  */
2663  /**
2664  * \brief An optional message to provide to a user of this API, e.g., to
2665  * suggest replacement APIs.
2666  */
2669 
2670 /**
2671  * \brief Determine the availability of the entity that this cursor refers to
2672  * on any platforms for which availability information is known.
2673  *
2674  * \param cursor The cursor to query.
2675  *
2676  * \param always_deprecated If non-NULL, will be set to indicate whether the
2677  * entity is deprecated on all platforms.
2678  *
2679  * \param deprecated_message If non-NULL, will be set to the message text
2680  * provided along with the unconditional deprecation of this entity. The client
2681  * is responsible for deallocating this string.
2682  *
2683  * \param always_unavailable If non-NULL, will be set to indicate whether the
2684  * entity is unavailable on all platforms.
2685  *
2686  * \param unavailable_message If non-NULL, will be set to the message text
2687  * provided along with the unconditional unavailability of this entity. The
2688  * client is responsible for deallocating this string.
2689  *
2690  * \param availability If non-NULL, an array of CXPlatformAvailability instances
2691  * that will be populated with platform availability information, up to either
2692  * the number of platforms for which availability information is available (as
2693  * returned by this function) or \c availability_size, whichever is smaller.
2694  *
2695  * \param availability_size The number of elements available in the
2696  * \c availability array.
2697  *
2698  * \returns The number of platforms (N) for which availability information is
2699  * available (which is unrelated to \c availability_size).
2700  *
2701  * Note that the client is responsible for calling
2702  * \c clang_disposeCXPlatformAvailability to free each of the
2703  * platform-availability structures returned. There are
2704  * \c min(N, availability_size) such structures.
2705  */
2706 CINDEX_LINKAGE int
2708  int *always_deprecated,
2709  CXString *deprecated_message,
2710  int *always_unavailable,
2711  CXString *unavailable_message,
2712  CXPlatformAvailability *availability,
2713  int availability_size);
2714 
2715 /**
2716  * \brief Free the memory associated with a \c CXPlatformAvailability structure.
2717  */
2718 CINDEX_LINKAGE void
2720 
2721 /**
2722  * \brief Describe the "language" of the entity referred to by a cursor.
2723  */
2729 };
2730 
2731 /**
2732  * \brief Determine the "language" of the entity referred to by a given cursor.
2733  */
2735 
2736 /**
2737  * \brief Returns the translation unit that a cursor originated from.
2738  */
2740 
2741 /**
2742  * \brief A fast container representing a set of CXCursors.
2743  */
2744 typedef struct CXCursorSetImpl *CXCursorSet;
2745 
2746 /**
2747  * \brief Creates an empty CXCursorSet.
2748  */
2749 CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void);
2750 
2751 /**
2752  * \brief Disposes a CXCursorSet and releases its associated memory.
2753  */
2754 CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
2755 
2756 /**
2757  * \brief Queries a CXCursorSet to see if it contains a specific CXCursor.
2758  *
2759  * \returns non-zero if the set contains the specified cursor.
2760 */
2761 CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
2762  CXCursor cursor);
2763 
2764 /**
2765  * \brief Inserts a CXCursor into a CXCursorSet.
2766  *
2767  * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
2768 */
2769 CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
2770  CXCursor cursor);
2771 
2772 /**
2773  * \brief Determine the semantic parent of the given cursor.
2774  *
2775  * The semantic parent of a cursor is the cursor that semantically contains
2776  * the given \p cursor. For many declarations, the lexical and semantic parents
2777  * are equivalent (the lexical parent is returned by
2778  * \c clang_getCursorLexicalParent()). They diverge when declarations or
2779  * definitions are provided out-of-line. For example:
2780  *
2781  * \code
2782  * class C {
2783  * void f();
2784  * };
2785  *
2786  * void C::f() { }
2787  * \endcode
2788  *
2789  * In the out-of-line definition of \c C::f, the semantic parent is
2790  * the class \c C, of which this function is a member. The lexical parent is
2791  * the place where the declaration actually occurs in the source code; in this
2792  * case, the definition occurs in the translation unit. In general, the
2793  * lexical parent for a given entity can change without affecting the semantics
2794  * of the program, and the lexical parent of different declarations of the
2795  * same entity may be different. Changing the semantic parent of a declaration,
2796  * on the other hand, can have a major impact on semantics, and redeclarations
2797  * of a particular entity should all have the same semantic context.
2798  *
2799  * In the example above, both declarations of \c C::f have \c C as their
2800  * semantic context, while the lexical context of the first \c C::f is \c C
2801  * and the lexical context of the second \c C::f is the translation unit.
2802  *
2803  * For global declarations, the semantic parent is the translation unit.
2804  */
2806 
2807 /**
2808  * \brief Determine the lexical parent of the given cursor.
2809  *
2810  * The lexical parent of a cursor is the cursor in which the given \p cursor
2811  * was actually written. For many declarations, the lexical and semantic parents
2812  * are equivalent (the semantic parent is returned by
2813  * \c clang_getCursorSemanticParent()). They diverge when declarations or
2814  * definitions are provided out-of-line. For example:
2815  *
2816  * \code
2817  * class C {
2818  * void f();
2819  * };
2820  *
2821  * void C::f() { }
2822  * \endcode
2823  *
2824  * In the out-of-line definition of \c C::f, the semantic parent is
2825  * the class \c C, of which this function is a member. The lexical parent is
2826  * the place where the declaration actually occurs in the source code; in this
2827  * case, the definition occurs in the translation unit. In general, the
2828  * lexical parent for a given entity can change without affecting the semantics
2829  * of the program, and the lexical parent of different declarations of the
2830  * same entity may be different. Changing the semantic parent of a declaration,
2831  * on the other hand, can have a major impact on semantics, and redeclarations
2832  * of a particular entity should all have the same semantic context.
2833  *
2834  * In the example above, both declarations of \c C::f have \c C as their
2835  * semantic context, while the lexical context of the first \c C::f is \c C
2836  * and the lexical context of the second \c C::f is the translation unit.
2837  *
2838  * For declarations written in the global scope, the lexical parent is
2839  * the translation unit.
2840  */
2842 
2843 /**
2844  * \brief Determine the set of methods that are overridden by the given
2845  * method.
2846  *
2847  * In both Objective-C and C++, a method (aka virtual member function,
2848  * in C++) can override a virtual method in a base class. For
2849  * Objective-C, a method is said to override any method in the class's
2850  * base class, its protocols, or its categories' protocols, that has the same
2851  * selector and is of the same kind (class or instance).
2852  * If no such method exists, the search continues to the class's superclass,
2853  * its protocols, and its categories, and so on. A method from an Objective-C
2854  * implementation is considered to override the same methods as its
2855  * corresponding method in the interface.
2856  *
2857  * For C++, a virtual member function overrides any virtual member
2858  * function with the same signature that occurs in its base
2859  * classes. With multiple inheritance, a virtual member function can
2860  * override several virtual member functions coming from different
2861  * base classes.
2862  *
2863  * In all cases, this function determines the immediate overridden
2864  * method, rather than all of the overridden methods. For example, if
2865  * a method is originally declared in a class A, then overridden in B
2866  * (which in inherits from A) and also in C (which inherited from B),
2867  * then the only overridden method returned from this function when
2868  * invoked on C's method will be B's method. The client may then
2869  * invoke this function again, given the previously-found overridden
2870  * methods, to map out the complete method-override set.
2871  *
2872  * \param cursor A cursor representing an Objective-C or C++
2873  * method. This routine will compute the set of methods that this
2874  * method overrides.
2875  *
2876  * \param overridden A pointer whose pointee will be replaced with a
2877  * pointer to an array of cursors, representing the set of overridden
2878  * methods. If there are no overridden methods, the pointee will be
2879  * set to NULL. The pointee must be freed via a call to
2880  * \c clang_disposeOverriddenCursors().
2881  *
2882  * \param num_overridden A pointer to the number of overridden
2883  * functions, will be set to the number of overridden functions in the
2884  * array pointed to by \p overridden.
2885  */
2887  CXCursor **overridden,
2888  unsigned *num_overridden);
2889 
2890 /**
2891  * \brief Free the set of overridden cursors returned by \c
2892  * clang_getOverriddenCursors().
2893  */
2895 
2896 /**
2897  * \brief Retrieve the file that is included by the given inclusion directive
2898  * cursor.
2899  */
2901 
2902 /**
2903  * @}
2904  */
2905 
2906 /**
2907  * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
2908  *
2909  * Cursors represent a location within the Abstract Syntax Tree (AST). These
2910  * routines help map between cursors and the physical locations where the
2911  * described entities occur in the source code. The mapping is provided in
2912  * both directions, so one can map from source code to the AST and back.
2913  *
2914  * @{
2915  */
2916 
2917 /**
2918  * \brief Map a source location to the cursor that describes the entity at that
2919  * location in the source code.
2920  *
2921  * clang_getCursor() maps an arbitrary source location within a translation
2922  * unit down to the most specific cursor that describes the entity at that
2923  * location. For example, given an expression \c x + y, invoking
2924  * clang_getCursor() with a source location pointing to "x" will return the
2925  * cursor for "x"; similarly for "y". If the cursor points anywhere between
2926  * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
2927  * will return a cursor referring to the "+" expression.
2928  *
2929  * \returns a cursor representing the entity at the given source location, or
2930  * a NULL cursor if no such entity can be found.
2931  */
2933 
2934 /**
2935  * \brief Retrieve the physical location of the source constructor referenced
2936  * by the given cursor.
2937  *
2938  * The location of a declaration is typically the location of the name of that
2939  * declaration, where the name of that declaration would occur if it is
2940  * unnamed, or some keyword that introduces that particular declaration.
2941  * The location of a reference is where that reference occurs within the
2942  * source code.
2943  */
2945 
2946 /**
2947  * \brief Retrieve the physical extent of the source construct referenced by
2948  * the given cursor.
2949  *
2950  * The extent of a cursor starts with the file/line/column pointing at the
2951  * first character within the source construct that the cursor refers to and
2952  * ends with the last character within that source construct. For a
2953  * declaration, the extent covers the declaration itself. For a reference,
2954  * the extent covers the location of the reference (e.g., where the referenced
2955  * entity was actually used).
2956  */
2958 
2959 /**
2960  * @}
2961  */
2962 
2963 /**
2964  * \defgroup CINDEX_TYPES Type information for CXCursors
2965  *
2966  * @{
2967  */
2968 
2969 /**
2970  * \brief Describes the kind of type
2971  */
2973  /**
2974  * \brief Represents an invalid type (e.g., where no type is available).
2975  */
2977 
2978  /**
2979  * \brief A type whose specific kind is not exposed via this
2980  * interface.
2981  */
2983 
2984  /* Builtin types */
3017 
3037 
3038  /**
3039  * \brief Represents a type that was referred to using an elaborated type keyword.
3040  *
3041  * E.g., struct S, or via a qualified name, e.g., N::M::type, or both.
3042  */
3044 };
3045 
3046 /**
3047  * \brief Describes the calling convention of a function type
3048  */
3066 
3069 };
3070 
3071 /**
3072  * \brief The type of an element in the abstract syntax tree.
3073  *
3074  */
3075 typedef struct {
3077  void *data[2];
3078 } CXType;
3079 
3080 /**
3081  * \brief Retrieve the type of a CXCursor (if any).
3082  */
3084 
3085 /**
3086  * \brief Pretty-print the underlying type using the rules of the
3087  * language of the translation unit from which it came.
3088  *
3089  * If the type is invalid, an empty string is returned.
3090  */
3092 
3093 /**
3094  * \brief Retrieve the underlying type of a typedef declaration.
3095  *
3096  * If the cursor does not reference a typedef declaration, an invalid type is
3097  * returned.
3098  */
3100 
3101 /**
3102  * \brief Retrieve the integer type of an enum declaration.
3103  *
3104  * If the cursor does not reference an enum declaration, an invalid type is
3105  * returned.
3106  */
3108 
3109 /**
3110  * \brief Retrieve the integer value of an enum constant declaration as a signed
3111  * long long.
3112  *
3113  * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned.
3114  * Since this is also potentially a valid constant value, the kind of the cursor
3115  * must be verified before calling this function.
3116  */
3118 
3119 /**
3120  * \brief Retrieve the integer value of an enum constant declaration as an unsigned
3121  * long long.
3122  *
3123  * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned.
3124  * Since this is also potentially a valid constant value, the kind of the cursor
3125  * must be verified before calling this function.
3126  */
3128 
3129 /**
3130  * \brief Retrieve the bit width of a bit field declaration as an integer.
3131  *
3132  * If a cursor that is not a bit field declaration is passed in, -1 is returned.
3133  */
3135 
3136 /**
3137  * \brief Retrieve the number of non-variadic arguments associated with a given
3138  * cursor.
3139  *
3140  * The number of arguments can be determined for calls as well as for
3141  * declarations of functions or methods. For other cursors -1 is returned.
3142  */
3144 
3145 /**
3146  * \brief Retrieve the argument cursor of a function or method.
3147  *
3148  * The argument cursor can be determined for calls as well as for declarations
3149  * of functions or methods. For other cursors and for invalid indices, an
3150  * invalid cursor is returned.
3151  */
3153 
3154 /**
3155  * \brief Describes the kind of a template argument.
3156  *
3157  * See the definition of llvm::clang::TemplateArgument::ArgKind for full
3158  * element descriptions.
3159  */
3170  /* Indicates an error case, preventing the kind from being deduced. */
3172 };
3173 
3174 /**
3175  *\brief Returns the number of template args of a function decl representing a
3176  * template specialization.
3177  *
3178  * If the argument cursor cannot be converted into a template function
3179  * declaration, -1 is returned.
3180  *
3181  * For example, for the following declaration and specialization:
3182  * template <typename T, int kInt, bool kBool>
3183  * void foo() { ... }
3184  *
3185  * template <>
3186  * void foo<float, -7, true>();
3187  *
3188  * The value 3 would be returned from this call.
3189  */
3191 
3192 /**
3193  * \brief Retrieve the kind of the I'th template argument of the CXCursor C.
3194  *
3195  * If the argument CXCursor does not represent a FunctionDecl, an invalid
3196  * template argument kind is returned.
3197  *
3198  * For example, for the following declaration and specialization:
3199  * template <typename T, int kInt, bool kBool>
3200  * void foo() { ... }
3201  *
3202  * template <>
3203  * void foo<float, -7, true>();
3204  *
3205  * For I = 0, 1, and 2, Type, Integral, and Integral will be returned,
3206  * respectively.
3207  */
3209  CXCursor C, unsigned I);
3210 
3211 /**
3212  * \brief Retrieve a CXType representing the type of a TemplateArgument of a
3213  * function decl representing a template specialization.
3214  *
3215  * If the argument CXCursor does not represent a FunctionDecl whose I'th
3216  * template argument has a kind of CXTemplateArgKind_Integral, an invalid type
3217  * is returned.
3218  *
3219  * For example, for the following declaration and specialization:
3220  * template <typename T, int kInt, bool kBool>
3221  * void foo() { ... }
3222  *
3223  * template <>
3224  * void foo<float, -7, true>();
3225  *
3226  * If called with I = 0, "float", will be returned.
3227  * Invalid types will be returned for I == 1 or 2.
3228  */
3230  unsigned I);
3231 
3232 /**
3233  * \brief Retrieve the value of an Integral TemplateArgument (of a function
3234  * decl representing a template specialization) as a signed long long.
3235  *
3236  * It is undefined to call this function on a CXCursor that does not represent a
3237  * FunctionDecl or whose I'th template argument is not an integral value.
3238  *
3239  * For example, for the following declaration and specialization:
3240  * template <typename T, int kInt, bool kBool>
3241  * void foo() { ... }
3242  *
3243  * template <>
3244  * void foo<float, -7, true>();
3245  *
3246  * If called with I = 1 or 2, -7 or true will be returned, respectively.
3247  * For I == 0, this function's behavior is undefined.
3248  */
3250  unsigned I);
3251 
3252 /**
3253  * \brief Retrieve the value of an Integral TemplateArgument (of a function
3254  * decl representing a template specialization) as an unsigned long long.
3255  *
3256  * It is undefined to call this function on a CXCursor that does not represent a
3257  * FunctionDecl or whose I'th template argument is not an integral value.
3258  *
3259  * For example, for the following declaration and specialization:
3260  * template <typename T, int kInt, bool kBool>
3261  * void foo() { ... }
3262  *
3263  * template <>
3264  * void foo<float, 2147483649, true>();
3265  *
3266  * If called with I = 1 or 2, 2147483649 or true will be returned, respectively.
3267  * For I == 0, this function's behavior is undefined.
3268  */
3270  CXCursor C, unsigned I);
3271 
3272 /**
3273  * \brief Determine whether two CXTypes represent the same type.
3274  *
3275  * \returns non-zero if the CXTypes represent the same type and
3276  * zero otherwise.
3277  */
3279 
3280 /**
3281  * \brief Return the canonical type for a CXType.
3282  *
3283  * Clang's type system explicitly models typedefs and all the ways
3284  * a specific type can be represented. The canonical type is the underlying
3285  * type with all the "sugar" removed. For example, if 'T' is a typedef
3286  * for 'int', the canonical type for 'T' would be 'int'.
3287  */
3289 
3290 /**
3291  * \brief Determine whether a CXType has the "const" qualifier set,
3292  * without looking through typedefs that may have added "const" at a
3293  * different level.
3294  */
3296 
3297 /**
3298  * \brief Determine whether a CXCursor that is a macro, is
3299  * function like.
3300  */
3302 
3303 /**
3304  * \brief Determine whether a CXCursor that is a macro, is a
3305  * builtin one.
3306  */
3308 
3309 /**
3310  * \brief Determine whether a CXCursor that is a function declaration, is an
3311  * inline declaration.
3312  */
3314 
3315 /**
3316  * \brief Determine whether a CXType has the "volatile" qualifier set,
3317  * without looking through typedefs that may have added "volatile" at
3318  * a different level.
3319  */
3321 
3322 /**
3323  * \brief Determine whether a CXType has the "restrict" qualifier set,
3324  * without looking through typedefs that may have added "restrict" at a
3325  * different level.
3326  */
3328 
3329 /**
3330  * \brief For pointer types, returns the type of the pointee.
3331  */
3333 
3334 /**
3335  * \brief Return the cursor for the declaration of the given type.
3336  */
3338 
3339 /**
3340  * Returns the Objective-C type encoding for the specified declaration.
3341  */
3343 
3344 /**
3345  * Returns the Objective-C type encoding for the specified CXType.
3346  */
3348 
3349 /**
3350  * \brief Retrieve the spelling of a given CXTypeKind.
3351  */
3353 
3354 /**
3355  * \brief Retrieve the calling convention associated with a function type.
3356  *
3357  * If a non-function type is passed in, CXCallingConv_Invalid is returned.
3358  */
3360 
3361 /**
3362  * \brief Retrieve the return type associated with a function type.
3363  *
3364  * If a non-function type is passed in, an invalid type is returned.
3365  */
3367 
3368 /**
3369  * \brief Retrieve the number of non-variadic parameters associated with a
3370  * function type.
3371  *
3372  * If a non-function type is passed in, -1 is returned.
3373  */
3375 
3376 /**
3377  * \brief Retrieve the type of a parameter of a function type.
3378  *
3379  * If a non-function type is passed in or the function does not have enough
3380  * parameters, an invalid type is returned.
3381  */
3383 
3384 /**
3385  * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise.
3386  */
3388 
3389 /**
3390  * \brief Retrieve the return type associated with a given cursor.
3391  *
3392  * This only returns a valid type if the cursor refers to a function or method.
3393  */
3395 
3396 /**
3397  * \brief Return 1 if the CXType is a POD (plain old data) type, and 0
3398  * otherwise.
3399  */
3401 
3402 /**
3403  * \brief Return the element type of an array, complex, or vector type.
3404  *
3405  * If a type is passed in that is not an array, complex, or vector type,
3406  * an invalid type is returned.
3407  */
3409 
3410 /**
3411  * \brief Return the number of elements of an array or vector type.
3412  *
3413  * If a type is passed in that is not an array or vector type,
3414  * -1 is returned.
3415  */
3417 
3418 /**
3419  * \brief Return the element type of an array type.
3420  *
3421  * If a non-array type is passed in, an invalid type is returned.
3422  */
3424 
3425 /**
3426  * \brief Return the array size of a constant array.
3427  *
3428  * If a non-array type is passed in, -1 is returned.
3429  */
3431 
3432 /**
3433  * \brief Retrieve the type named by the qualified-id.
3434  *
3435  * If a non-elaborated type is passed in, an invalid type is returned.
3436  */
3438 
3439 /**
3440  * \brief Determine if a typedef is 'transparent' tag.
3441  *
3442  * A typedef is considered 'transparent' if it shares a name and spelling
3443  * location with its underlying tag type, as is the case with the NS_ENUM macro.
3444  *
3445  * \returns non-zero if transparent and zero otherwise.
3446  */
3448 
3449 /**
3450  * \brief List the possible error codes for \c clang_Type_getSizeOf,
3451  * \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and
3452  * \c clang_Cursor_getOffsetOf.
3453  *
3454  * A value of this enumeration type can be returned if the target type is not
3455  * a valid argument to sizeof, alignof or offsetof.
3456  */
3458  /**
3459  * \brief Type is of kind CXType_Invalid.
3460  */
3462  /**
3463  * \brief The type is an incomplete Type.
3464  */
3466  /**
3467  * \brief The type is a dependent Type.
3468  */
3470  /**
3471  * \brief The type is not a constant size type.
3472  */
3474  /**
3475  * \brief The Field name is not valid for this record.
3476  */
3478 };
3479 
3480 /**
3481  * \brief Return the alignment of a type in bytes as per C++[expr.alignof]
3482  * standard.
3483  *
3484  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3485  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3486  * is returned.
3487  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3488  * returned.
3489  * If the type declaration is not a constant size type,
3490  * CXTypeLayoutError_NotConstantSize is returned.
3491  */
3493 
3494 /**
3495  * \brief Return the class type of an member pointer type.
3496  *
3497  * If a non-member-pointer type is passed in, an invalid type is returned.
3498  */
3500 
3501 /**
3502  * \brief Return the size of a type in bytes as per C++[expr.sizeof] standard.
3503  *
3504  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3505  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3506  * is returned.
3507  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3508  * returned.
3509  */
3511 
3512 /**
3513  * \brief Return the offset of a field named S in a record of type T in bits
3514  * as it would be returned by __offsetof__ as per C++11[18.2p4]
3515  *
3516  * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
3517  * is returned.
3518  * If the field's type declaration is an incomplete type,
3519  * CXTypeLayoutError_Incomplete is returned.
3520  * If the field's type declaration is a dependent type,
3521  * CXTypeLayoutError_Dependent is returned.
3522  * If the field's name S is not found,
3523  * CXTypeLayoutError_InvalidFieldName is returned.
3524  */
3525 CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S);
3526 
3527 /**
3528  * \brief Return the offset of the field represented by the Cursor.
3529  *
3530  * If the cursor is not a field declaration, -1 is returned.
3531  * If the cursor semantic parent is not a record field declaration,
3532  * CXTypeLayoutError_Invalid is returned.
3533  * If the field's type declaration is an incomplete type,
3534  * CXTypeLayoutError_Incomplete is returned.
3535  * If the field's type declaration is a dependent type,
3536  * CXTypeLayoutError_Dependent is returned.
3537  * If the field's name S is not found,
3538  * CXTypeLayoutError_InvalidFieldName is returned.
3539  */
3541 
3542 /**
3543  * \brief Determine whether the given cursor represents an anonymous record
3544  * declaration.
3545  */
3547 
3549  /** \brief No ref-qualifier was provided. */
3551  /** \brief An lvalue ref-qualifier was provided (\c &). */
3553  /** \brief An rvalue ref-qualifier was provided (\c &&). */
3555 };
3556 
3557 /**
3558  * \brief Returns the number of template arguments for given template
3559  * specialization, or -1 if type \c T is not a template specialization.
3560  */
3562 
3563 /**
3564  * \brief Returns the type template argument of a template class specialization
3565  * at given index.
3566  *
3567  * This function only returns template type arguments and does not handle
3568  * template template arguments or variadic packs.
3569  */
3571 
3572 /**
3573  * \brief Retrieve the ref-qualifier kind of a function or method.
3574  *
3575  * The ref-qualifier is returned for C++ functions or methods. For other types
3576  * or non-C++ declarations, CXRefQualifier_None is returned.
3577  */
3579 
3580 /**
3581  * \brief Returns non-zero if the cursor specifies a Record member that is a
3582  * bitfield.
3583  */
3585 
3586 /**
3587  * \brief Returns 1 if the base class specified by the cursor with kind
3588  * CX_CXXBaseSpecifier is virtual.
3589  */
3591 
3592 /**
3593  * \brief Represents the C++ access control level to a base class for a
3594  * cursor with kind CX_CXXBaseSpecifier.
3595  */
3601 };
3602 
3603 /**
3604  * \brief Returns the access control level for the referenced object.
3605  *
3606  * If the cursor refers to a C++ declaration, its access control level within its
3607  * parent scope is returned. Otherwise, if the cursor refers to a base specifier or
3608  * access specifier, the specifier itself is returned.
3609  */
3611 
3612 /**
3613  * \brief Represents the storage classes as declared in the source. CX_SC_Invalid
3614  * was added for the case that the passed cursor in not a declaration.
3615  */
3625 };
3626 
3627 /**
3628  * \brief Returns the storage class for a function or variable declaration.
3629  *
3630  * If the passed in Cursor is not a function or variable declaration,
3631  * CX_SC_Invalid is returned else the storage class.
3632  */
3634 
3635 /**
3636  * \brief Determine the number of overloaded declarations referenced by a
3637  * \c CXCursor_OverloadedDeclRef cursor.
3638  *
3639  * \param cursor The cursor whose overloaded declarations are being queried.
3640  *
3641  * \returns The number of overloaded declarations referenced by \c cursor. If it
3642  * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
3643  */
3645 
3646 /**
3647  * \brief Retrieve a cursor for one of the overloaded declarations referenced
3648  * by a \c CXCursor_OverloadedDeclRef cursor.
3649  *
3650  * \param cursor The cursor whose overloaded declarations are being queried.
3651  *
3652  * \param index The zero-based index into the set of overloaded declarations in
3653  * the cursor.
3654  *
3655  * \returns A cursor representing the declaration referenced by the given
3656  * \c cursor at the specified \c index. If the cursor does not have an
3657  * associated set of overloaded declarations, or if the index is out of bounds,
3658  * returns \c clang_getNullCursor();
3659  */
3661  unsigned index);
3662 
3663 /**
3664  * @}
3665  */
3666 
3667 /**
3668  * \defgroup CINDEX_ATTRIBUTES Information for attributes
3669  *
3670  * @{
3671  */
3672 
3673 /**
3674  * \brief For cursors representing an iboutletcollection attribute,
3675  * this function returns the collection element type.
3676  *
3677  */
3679 
3680 /**
3681  * @}
3682  */
3683 
3684 /**
3685  * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
3686  *
3687  * These routines provide the ability to traverse the abstract syntax tree
3688  * using cursors.
3689  *
3690  * @{
3691  */
3692 
3693 /**
3694  * \brief Describes how the traversal of the children of a particular
3695  * cursor should proceed after visiting a particular child cursor.
3696  *
3697  * A value of this enumeration type should be returned by each
3698  * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
3699  */
3701  /**
3702  * \brief Terminates the cursor traversal.
3703  */
3705  /**
3706  * \brief Continues the cursor traversal with the next sibling of
3707  * the cursor just visited, without visiting its children.
3708  */
3710  /**
3711  * \brief Recursively traverse the children of this cursor, using
3712  * the same visitor and client data.
3713  */
3715 };
3716 
3717 /**
3718  * \brief Visitor invoked for each cursor found by a traversal.
3719  *
3720  * This visitor function will be invoked for each cursor found by
3721  * clang_visitCursorChildren(). Its first argument is the cursor being
3722  * visited, its second argument is the parent visitor for that cursor,
3723  * and its third argument is the client data provided to
3724  * clang_visitCursorChildren().
3725  *
3726  * The visitor should return one of the \c CXChildVisitResult values
3727  * to direct clang_visitCursorChildren().
3728  */
3730  CXCursor parent,
3731  CXClientData client_data);
3732 
3733 /**
3734  * \brief Visit the children of a particular cursor.
3735  *
3736  * This function visits all the direct children of the given cursor,
3737  * invoking the given \p visitor function with the cursors of each
3738  * visited child. The traversal may be recursive, if the visitor returns
3739  * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
3740  * the visitor returns \c CXChildVisit_Break.
3741  *
3742  * \param parent the cursor whose child may be visited. All kinds of
3743  * cursors can be visited, including invalid cursors (which, by
3744  * definition, have no children).
3745  *
3746  * \param visitor the visitor function that will be invoked for each
3747  * child of \p parent.
3748  *
3749  * \param client_data pointer data supplied by the client, which will
3750  * be passed to the visitor each time it is invoked.
3751  *
3752  * \returns a non-zero value if the traversal was terminated
3753  * prematurely by the visitor returning \c CXChildVisit_Break.
3754  */
3756  CXCursorVisitor visitor,
3757  CXClientData client_data);
3758 #ifdef __has_feature
3759 # if __has_feature(blocks)
3760 /**
3761  * \brief Visitor invoked for each cursor found by a traversal.
3762  *
3763  * This visitor block will be invoked for each cursor found by
3764  * clang_visitChildrenWithBlock(). Its first argument is the cursor being
3765  * visited, its second argument is the parent visitor for that cursor.
3766  *
3767  * The visitor should return one of the \c CXChildVisitResult values
3768  * to direct clang_visitChildrenWithBlock().
3769  */
3770 typedef enum CXChildVisitResult
3771  (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
3772 
3773 /**
3774  * Visits the children of a cursor using the specified block. Behaves
3775  * identically to clang_visitChildren() in all other respects.
3776  */
3777 CINDEX_LINKAGE unsigned clang_visitChildrenWithBlock(CXCursor parent,
3778  CXCursorVisitorBlock block);
3779 # endif
3780 #endif
3781 
3782 /**
3783  * @}
3784  */
3785 
3786 /**
3787  * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
3788  *
3789  * These routines provide the ability to determine references within and
3790  * across translation units, by providing the names of the entities referenced
3791  * by cursors, follow reference cursors to the declarations they reference,
3792  * and associate declarations with their definitions.
3793  *
3794  * @{
3795  */
3796 
3797 /**
3798  * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced
3799  * by the given cursor.
3800  *
3801  * A Unified Symbol Resolution (USR) is a string that identifies a particular
3802  * entity (function, class, variable, etc.) within a program. USRs can be
3803  * compared across translation units to determine, e.g., when references in
3804  * one translation refer to an entity defined in another translation unit.
3805  */
3807 
3808 /**
3809  * \brief Construct a USR for a specified Objective-C class.
3810  */
3811 CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
3812 
3813 /**
3814  * \brief Construct a USR for a specified Objective-C category.
3815  */
3817  clang_constructUSR_ObjCCategory(const char *class_name,
3818  const char *category_name);
3819 
3820 /**
3821  * \brief Construct a USR for a specified Objective-C protocol.
3822  */
3824  clang_constructUSR_ObjCProtocol(const char *protocol_name);
3825 
3826 /**
3827  * \brief Construct a USR for a specified Objective-C instance variable and
3828  * the USR for its containing class.
3829  */
3831  CXString classUSR);
3832 
3833 /**
3834  * \brief Construct a USR for a specified Objective-C method and
3835  * the USR for its containing class.
3836  */
3838  unsigned isInstanceMethod,
3839  CXString classUSR);
3840 
3841 /**
3842  * \brief Construct a USR for a specified Objective-C property and the USR
3843  * for its containing class.
3844  */
3846  CXString classUSR);
3847 
3848 /**
3849  * \brief Retrieve a name for the entity referenced by this cursor.
3850  */
3852 
3853 /**
3854  * \brief Retrieve a range for a piece that forms the cursors spelling name.
3855  * Most of the times there is only one range for the complete spelling but for
3856  * Objective-C methods and Objective-C message expressions, there are multiple
3857  * pieces for each selector identifier.
3858  *
3859  * \param pieceIndex the index of the spelling name piece. If this is greater
3860  * than the actual number of pieces, it will return a NULL (invalid) range.
3861  *
3862  * \param options Reserved.
3863  */
3865  unsigned pieceIndex,
3866  unsigned options);
3867 
3868 /**
3869  * \brief Retrieve the display name for the entity referenced by this cursor.
3870  *
3871  * The display name contains extra information that helps identify the cursor,
3872  * such as the parameters of a function or template or the arguments of a
3873  * class template specialization.
3874  */
3876 
3877 /** \brief For a cursor that is a reference, retrieve a cursor representing the
3878  * entity that it references.
3879  *
3880  * Reference cursors refer to other entities in the AST. For example, an
3881  * Objective-C superclass reference cursor refers to an Objective-C class.
3882  * This function produces the cursor for the Objective-C class from the
3883  * cursor for the superclass reference. If the input cursor is a declaration or
3884  * definition, it returns that declaration or definition unchanged.
3885  * Otherwise, returns the NULL cursor.
3886  */
3888 
3889 /**
3890  * \brief For a cursor that is either a reference to or a declaration
3891  * of some entity, retrieve a cursor that describes the definition of
3892  * that entity.
3893  *
3894  * Some entities can be declared multiple times within a translation
3895  * unit, but only one of those declarations can also be a
3896  * definition. For example, given:
3897  *
3898  * \code
3899  * int f(int, int);
3900  * int g(int x, int y) { return f(x, y); }
3901  * int f(int a, int b) { return a + b; }
3902  * int f(int, int);
3903  * \endcode
3904  *
3905  * there are three declarations of the function "f", but only the
3906  * second one is a definition. The clang_getCursorDefinition()
3907  * function will take any cursor pointing to a declaration of "f"
3908  * (the first or fourth lines of the example) or a cursor referenced
3909  * that uses "f" (the call to "f' inside "g") and will return a
3910  * declaration cursor pointing to the definition (the second "f"
3911  * declaration).
3912  *
3913  * If given a cursor for which there is no corresponding definition,
3914  * e.g., because there is no definition of that entity within this
3915  * translation unit, returns a NULL cursor.
3916  */
3918 
3919 /**
3920  * \brief Determine whether the declaration pointed to by this cursor
3921  * is also a definition of that entity.
3922  */
3924 
3925 /**
3926  * \brief Retrieve the canonical cursor corresponding to the given cursor.
3927  *
3928  * In the C family of languages, many kinds of entities can be declared several
3929  * times within a single translation unit. For example, a structure type can
3930  * be forward-declared (possibly multiple times) and later defined:
3931  *
3932  * \code
3933  * struct X;
3934  * struct X;
3935  * struct X {
3936  * int member;
3937  * };
3938  * \endcode
3939  *
3940  * The declarations and the definition of \c X are represented by three
3941  * different cursors, all of which are declarations of the same underlying
3942  * entity. One of these cursor is considered the "canonical" cursor, which
3943  * is effectively the representative for the underlying entity. One can
3944  * determine if two cursors are declarations of the same underlying entity by
3945  * comparing their canonical cursors.
3946  *
3947  * \returns The canonical cursor for the entity referred to by the given cursor.
3948  */
3950 
3951 /**
3952  * \brief If the cursor points to a selector identifier in an Objective-C
3953  * method or message expression, this returns the selector index.
3954  *
3955  * After getting a cursor with #clang_getCursor, this can be called to
3956  * determine if the location points to a selector identifier.
3957  *
3958  * \returns The selector index if the cursor is an Objective-C method or message
3959  * expression and the cursor is pointing to a selector identifier, or -1
3960  * otherwise.
3961  */
3963 
3964 /**
3965  * \brief Given a cursor pointing to a C++ method call or an Objective-C
3966  * message, returns non-zero if the method/message is "dynamic", meaning:
3967  *
3968  * For a C++ method: the call is virtual.
3969  * For an Objective-C message: the receiver is an object instance, not 'super'
3970  * or a specific class.
3971  *
3972  * If the method/message is "static" or the cursor does not point to a
3973  * method/message, it will return zero.
3974  */
3976 
3977 /**
3978  * \brief Given a cursor pointing to an Objective-C message, returns the CXType
3979  * of the receiver.
3980  */
3982 
3983 /**
3984  * \brief Property attributes for a \c CXCursor_ObjCPropertyDecl.
3985  */
3986 typedef enum {
4002 
4003 /**
4004  * \brief Given a cursor that represents a property declaration, return the
4005  * associated property attributes. The bits are formed from
4006  * \c CXObjCPropertyAttrKind.
4007  *
4008  * \param reserved Reserved for future use, pass 0.
4009  */
4011  unsigned reserved);
4012 
4013 /**
4014  * \brief 'Qualifiers' written next to the return and parameter types in
4015  * Objective-C method declarations.
4016  */
4017 typedef enum {
4026 
4027 /**
4028  * \brief Given a cursor that represents an Objective-C method or parameter
4029  * declaration, return the associated Objective-C qualifiers for the return
4030  * type or the parameter respectively. The bits are formed from
4031  * CXObjCDeclQualifierKind.
4032  */
4034 
4035 /**
4036  * \brief Given a cursor that represents an Objective-C method or property
4037  * declaration, return non-zero if the declaration was affected by "@optional".
4038  * Returns zero if the cursor is not such a declaration or it is "@required".
4039  */
4041 
4042 /**
4043  * \brief Returns non-zero if the given cursor is a variadic function or method.
4044  */
4046 
4047 /**
4048  * \brief Given a cursor that represents a declaration, return the associated
4049  * comment's source range. The range may include multiple consecutive comments
4050  * with whitespace in between.
4051  */
4053 
4054 /**
4055  * \brief Given a cursor that represents a declaration, return the associated
4056  * comment text, including comment markers.
4057  */
4059 
4060 /**
4061  * \brief Given a cursor that represents a documentable entity (e.g.,
4062  * declaration), return the associated \\brief paragraph; otherwise return the
4063  * first paragraph.
4064  */
4066 
4067 /**
4068  * @}
4069  */
4070 
4071 /** \defgroup CINDEX_MANGLE Name Mangling API Functions
4072  *
4073  * @{
4074  */
4075 
4076 /**
4077  * \brief Retrieve the CXString representing the mangled name of the cursor.
4078  */
4080 
4081 /**
4082  * \brief Retrieve the CXStrings representing the mangled symbols of the C++
4083  * constructor or destructor at the cursor.
4084  */
4086 
4087 /**
4088  * @}
4089  */
4090 
4091 /**
4092  * \defgroup CINDEX_MODULE Module introspection
4093  *
4094  * The functions in this group provide access to information about modules.
4095  *
4096  * @{
4097  */
4098 
4099 typedef void *CXModule;
4100 
4101 /**
4102  * \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module.
4103  */
4105 
4106 /**
4107  * \brief Given a CXFile header file, return the module that contains it, if one
4108  * exists.
4109  */
4110 CINDEX_LINKAGE CXModule clang_getModuleForFile(CXTranslationUnit, CXFile);
4111 
4112 /**
4113  * \param Module a module object.
4114  *
4115  * \returns the module file where the provided module object came from.
4116  */
4117 CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module);
4118 
4119 /**
4120  * \param Module a module object.
4121  *
4122  * \returns the parent of a sub-module or NULL if the given module is top-level,
4123  * e.g. for 'std.vector' it will return the 'std' module.
4124  */
4125 CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module);
4126 
4127 /**
4128  * \param Module a module object.
4129  *
4130  * \returns the name of the module, e.g. for the 'std.vector' sub-module it
4131  * will return "vector".
4132  */
4134 
4135 /**
4136  * \param Module a module object.
4137  *
4138  * \returns the full name of the module, e.g. "std.vector".
4139  */
4141 
4142 /**
4143  * \param Module a module object.
4144  *
4145  * \returns non-zero if the module is a system one.
4146  */
4147 CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module);
4148 
4149 /**
4150  * \param Module a module object.
4151  *
4152  * \returns the number of top level headers associated with this module.
4153  */
4154 CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit,
4155  CXModule Module);
4156 
4157 /**
4158  * \param Module a module object.
4159  *
4160  * \param Index top level header index (zero-based).
4161  *
4162  * \returns the specified top level header associated with the module.
4163  */
4165 CXFile clang_Module_getTopLevelHeader(CXTranslationUnit,
4166  CXModule Module, unsigned Index);
4167 
4168 /**
4169  * @}
4170  */
4171 
4172 /**
4173  * \defgroup CINDEX_CPP C++ AST introspection
4174  *
4175  * The routines in this group provide access information in the ASTs specific
4176  * to C++ language features.
4177  *
4178  * @{
4179  */
4180 
4181 /**
4182  * \brief Determine if a C++ constructor is a converting constructor.
4183  */
4185 
4186 /**
4187  * \brief Determine if a C++ constructor is a copy constructor.
4188  */
4190 
4191 /**
4192  * \brief Determine if a C++ constructor is the default constructor.
4193  */
4195 
4196 /**
4197  * \brief Determine if a C++ constructor is a move constructor.
4198  */
4200 
4201 /**
4202  * \brief Determine if a C++ field is declared 'mutable'.
4203  */
4205 
4206 /**
4207  * \brief Determine if a C++ method is declared '= default'.
4208  */
4210 
4211 /**
4212  * \brief Determine if a C++ member function or member function template is
4213  * pure virtual.
4214  */
4216 
4217 /**
4218  * \brief Determine if a C++ member function or member function template is
4219  * declared 'static'.
4220  */
4222 
4223 /**
4224  * \brief Determine if a C++ member function or member function template is
4225  * explicitly declared 'virtual' or if it overrides a virtual method from
4226  * one of the base classes.
4227  */
4229 
4230 /**
4231  * \brief Determine if a C++ member function or member function template is
4232  * declared 'const'.
4233  */
4235 
4236 /**
4237  * \brief Given a cursor that represents a template, determine
4238  * the cursor kind of the specializations would be generated by instantiating
4239  * the template.
4240  *
4241  * This routine can be used to determine what flavor of function template,
4242  * class template, or class template partial specialization is stored in the
4243  * cursor. For example, it can describe whether a class template cursor is
4244  * declared with "struct", "class" or "union".
4245  *
4246  * \param C The cursor to query. This cursor should represent a template
4247  * declaration.
4248  *
4249  * \returns The cursor kind of the specializations that would be generated
4250  * by instantiating the template \p C. If \p C is not a template, returns
4251  * \c CXCursor_NoDeclFound.
4252  */
4254 
4255 /**
4256  * \brief Given a cursor that may represent a specialization or instantiation
4257  * of a template, retrieve the cursor that represents the template that it
4258  * specializes or from which it was instantiated.
4259  *
4260  * This routine determines the template involved both for explicit
4261  * specializations of templates and for implicit instantiations of the template,
4262  * both of which are referred to as "specializations". For a class template
4263  * specialization (e.g., \c std::vector<bool>), this routine will return
4264  * either the primary template (\c std::vector) or, if the specialization was
4265  * instantiated from a class template partial specialization, the class template
4266  * partial specialization. For a class template partial specialization and a
4267  * function template specialization (including instantiations), this
4268  * this routine will return the specialized template.
4269  *
4270  * For members of a class template (e.g., member functions, member classes, or
4271  * static data members), returns the specialized or instantiated member.
4272  * Although not strictly "templates" in the C++ language, members of class
4273  * templates have the same notions of specializations and instantiations that
4274  * templates do, so this routine treats them similarly.
4275  *
4276  * \param C A cursor that may be a specialization of a template or a member
4277  * of a template.
4278  *
4279  * \returns If the given cursor is a specialization or instantiation of a
4280  * template or a member thereof, the template or member that it specializes or
4281  * from which it was instantiated. Otherwise, returns a NULL cursor.
4282  */
4284 
4285 /**
4286  * \brief Given a cursor that references something else, return the source range
4287  * covering that reference.
4288  *
4289  * \param C A cursor pointing to a member reference, a declaration reference, or
4290  * an operator call.
4291  * \param NameFlags A bitset with three independent flags:
4292  * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
4293  * CXNameRange_WantSinglePiece.
4294  * \param PieceIndex For contiguous names or when passing the flag
4295  * CXNameRange_WantSinglePiece, only one piece with index 0 is
4296  * available. When the CXNameRange_WantSinglePiece flag is not passed for a
4297  * non-contiguous names, this index can be used to retrieve the individual
4298  * pieces of the name. See also CXNameRange_WantSinglePiece.
4299  *
4300  * \returns The piece of the name pointed to by the given cursor. If there is no
4301  * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
4302  */
4304  unsigned NameFlags,
4305  unsigned PieceIndex);
4306 
4308  /**
4309  * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
4310  * range.
4311  */
4313 
4314  /**
4315  * \brief Include the explicit template arguments, e.g. <int> in x.f<int>,
4316  * in the range.
4317  */
4319 
4320  /**
4321  * \brief If the name is non-contiguous, return the full spanning range.
4322  *
4323  * Non-contiguous names occur in Objective-C when a selector with two or more
4324  * parameters is used, or in C++ when using an operator:
4325  * \code
4326  * [object doSomething:here withValue:there]; // Objective-C
4327  * return some_vector[1]; // C++
4328  * \endcode
4329  */
4331 };
4332 
4333 /**
4334  * @}
4335  */
4336 
4337 /**
4338  * \defgroup CINDEX_LEX Token extraction and manipulation
4339  *
4340  * The routines in this group provide access to the tokens within a
4341  * translation unit, along with a semantic mapping of those tokens to
4342  * their corresponding cursors.
4343  *
4344  * @{
4345  */
4346 
4347 /**
4348  * \brief Describes a kind of token.
4349  */
4350 typedef enum CXTokenKind {
4351  /**
4352  * \brief A token that contains some kind of punctuation.
4353  */
4355 
4356  /**
4357  * \brief A language keyword.
4358  */
4360 
4361  /**
4362  * \brief An identifier (that is not a keyword).
4363  */
4365 
4366  /**
4367  * \brief A numeric, string, or character literal.
4368  */
4370 
4371  /**
4372  * \brief A comment.
4373  */
4375 } CXTokenKind;
4376 
4377 /**
4378  * \brief Describes a single preprocessing token.
4379  */
4380 typedef struct {
4381  unsigned int_data[4];
4382  void *ptr_data;
4383 } CXToken;
4384 
4385 /**
4386  * \brief Determine the kind of the given token.
4387  */
4389 
4390 /**
4391  * \brief Determine the spelling of the given token.
4392  *
4393  * The spelling of a token is the textual representation of that token, e.g.,
4394  * the text of an identifier or keyword.
4395  */
4397 
4398 /**
4399  * \brief Retrieve the source location of the given token.
4400  */
4402  CXToken);
4403 
4404 /**
4405  * \brief Retrieve a source range that covers the given token.
4406  */
4408 
4409 /**
4410  * \brief Tokenize the source code described by the given range into raw
4411  * lexical tokens.
4412  *
4413  * \param TU the translation unit whose text is being tokenized.
4414  *
4415  * \param Range the source range in which text should be tokenized. All of the
4416  * tokens produced by tokenization will fall within this source range,
4417  *
4418  * \param Tokens this pointer will be set to point to the array of tokens
4419  * that occur within the given source range. The returned pointer must be
4420  * freed with clang_disposeTokens() before the translation unit is destroyed.
4421  *
4422  * \param NumTokens will be set to the number of tokens in the \c *Tokens
4423  * array.
4424  *
4425  */
4426 CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
4427  CXToken **Tokens, unsigned *NumTokens);
4428 
4429 /**
4430  * \brief Annotate the given set of tokens by providing cursors for each token
4431  * that can be mapped to a specific entity within the abstract syntax tree.
4432  *
4433  * This token-annotation routine is equivalent to invoking
4434  * clang_getCursor() for the source locations of each of the
4435  * tokens. The cursors provided are filtered, so that only those
4436  * cursors that have a direct correspondence to the token are
4437  * accepted. For example, given a function call \c f(x),
4438  * clang_getCursor() would provide the following cursors:
4439  *
4440  * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
4441  * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
4442  * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
4443  *
4444  * Only the first and last of these cursors will occur within the
4445  * annotate, since the tokens "f" and "x' directly refer to a function
4446  * and a variable, respectively, but the parentheses are just a small
4447  * part of the full syntax of the function call expression, which is
4448  * not provided as an annotation.
4449  *
4450  * \param TU the translation unit that owns the given tokens.
4451  *
4452  * \param Tokens the set of tokens to annotate.
4453  *
4454  * \param NumTokens the number of tokens in \p Tokens.
4455  *
4456  * \param Cursors an array of \p NumTokens cursors, whose contents will be
4457  * replaced with the cursors corresponding to each token.
4458  */
4459 CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
4460  CXToken *Tokens, unsigned NumTokens,
4461  CXCursor *Cursors);
4462 
4463 /**
4464  * \brief Free the given set of tokens.
4465  */
4466 CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
4467  CXToken *Tokens, unsigned NumTokens);
4468 
4469 /**
4470  * @}
4471  */
4472 
4473 /**
4474  * \defgroup CINDEX_DEBUG Debugging facilities
4475  *
4476  * These routines are used for testing and debugging, only, and should not
4477  * be relied upon.
4478  *
4479  * @{
4480  */
4481 
4482 /* for debug/testing */
4485  const char **startBuf,
4486  const char **endBuf,
4487  unsigned *startLine,
4488  unsigned *startColumn,
4489  unsigned *endLine,
4490  unsigned *endColumn);
4492 CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
4493  unsigned stack_size);
4494 
4495 /**
4496  * @}
4497  */
4498 
4499 /**
4500  * \defgroup CINDEX_CODE_COMPLET Code completion
4501  *
4502  * Code completion involves taking an (incomplete) source file, along with
4503  * knowledge of where the user is actively editing that file, and suggesting
4504  * syntactically- and semantically-valid constructs that the user might want to
4505  * use at that particular point in the source code. These data structures and
4506  * routines provide support for code completion.
4507  *
4508  * @{
4509  */
4510 
4511 /**
4512  * \brief A semantic string that describes a code-completion result.
4513  *
4514  * A semantic string that describes the formatting of a code-completion
4515  * result as a single "template" of text that should be inserted into the
4516  * source buffer when a particular code-completion result is selected.
4517  * Each semantic string is made up of some number of "chunks", each of which
4518  * contains some text along with a description of what that text means, e.g.,
4519  * the name of the entity being referenced, whether the text chunk is part of
4520  * the template, or whether it is a "placeholder" that the user should replace
4521  * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
4522  * description of the different kinds of chunks.
4523  */
4524 typedef void *CXCompletionString;
4525 
4526 /**
4527  * \brief A single result of code completion.
4528  */
4529 typedef struct {
4530  /**
4531  * \brief The kind of entity that this completion refers to.
4532  *
4533  * The cursor kind will be a macro, keyword, or a declaration (one of the
4534  * *Decl cursor kinds), describing the entity that the completion is
4535  * referring to.
4536  *
4537  * \todo In the future, we would like to provide a full cursor, to allow
4538  * the client to extract additional information from declaration.
4539  */
4540  enum CXCursorKind CursorKind;
4541 
4542  /**
4543  * \brief The code-completion string that describes how to insert this
4544  * code-completion result into the editing buffer.
4545  */
4546  CXCompletionString CompletionString;
4548 
4549 /**
4550  * \brief Describes a single piece of text within a code-completion string.
4551  *
4552  * Each "chunk" within a code-completion string (\c CXCompletionString) is
4553  * either a piece of text with a specific "kind" that describes how that text
4554  * should be interpreted by the client or is another completion string.
4555  */
4557  /**
4558  * \brief A code-completion string that describes "optional" text that
4559  * could be a part of the template (but is not required).
4560  *
4561  * The Optional chunk is the only kind of chunk that has a code-completion
4562  * string for its representation, which is accessible via
4563  * \c clang_getCompletionChunkCompletionString(). The code-completion string
4564  * describes an additional part of the template that is completely optional.
4565  * For example, optional chunks can be used to describe the placeholders for
4566  * arguments that match up with defaulted function parameters, e.g. given:
4567  *
4568  * \code
4569  * void f(int x, float y = 3.14, double z = 2.71828);
4570  * \endcode
4571  *
4572  * The code-completion string for this function would contain:
4573  * - a TypedText chunk for "f".
4574  * - a LeftParen chunk for "(".
4575  * - a Placeholder chunk for "int x"
4576  * - an Optional chunk containing the remaining defaulted arguments, e.g.,
4577  * - a Comma chunk for ","
4578  * - a Placeholder chunk for "float y"
4579  * - an Optional chunk containing the last defaulted argument:
4580  * - a Comma chunk for ","
4581  * - a Placeholder chunk for "double z"
4582  * - a RightParen chunk for ")"
4583  *
4584  * There are many ways to handle Optional chunks. Two simple approaches are:
4585  * - Completely ignore optional chunks, in which case the template for the
4586  * function "f" would only include the first parameter ("int x").
4587  * - Fully expand all optional chunks, in which case the template for the
4588  * function "f" would have all of the parameters.
4589  */
4591  /**
4592  * \brief Text that a user would be expected to type to get this
4593  * code-completion result.
4594  *
4595  * There will be exactly one "typed text" chunk in a semantic string, which
4596  * will typically provide the spelling of a keyword or the name of a
4597  * declaration that could be used at the current code point. Clients are
4598  * expected to filter the code-completion results based on the text in this
4599  * chunk.
4600  */
4602  /**
4603  * \brief Text that should be inserted as part of a code-completion result.
4604  *
4605  * A "text" chunk represents text that is part of the template to be
4606  * inserted into user code should this particular code-completion result
4607  * be selected.
4608  */
4610  /**
4611  * \brief Placeholder text that should be replaced by the user.
4612  *
4613  * A "placeholder" chunk marks a place where the user should insert text
4614  * into the code-completion template. For example, placeholders might mark
4615  * the function parameters for a function declaration, to indicate that the
4616  * user should provide arguments for each of those parameters. The actual
4617  * text in a placeholder is a suggestion for the text to display before
4618  * the user replaces the placeholder with real code.
4619  */
4621  /**
4622  * \brief Informative text that should be displayed but never inserted as
4623  * part of the template.
4624  *
4625  * An "informative" chunk contains annotations that can be displayed to
4626  * help the user decide whether a particular code-completion result is the
4627  * right option, but which is not part of the actual template to be inserted
4628  * by code completion.
4629  */
4631  /**
4632  * \brief Text that describes the current parameter when code-completion is
4633  * referring to function call, message send, or template specialization.
4634  *
4635  * A "current parameter" chunk occurs when code-completion is providing
4636  * information about a parameter corresponding to the argument at the
4637  * code-completion point. For example, given a function
4638  *
4639  * \code
4640  * int add(int x, int y);
4641  * \endcode
4642  *
4643  * and the source code \c add(, where the code-completion point is after the
4644  * "(", the code-completion string will contain a "current parameter" chunk
4645  * for "int x", indicating that the current argument will initialize that
4646  * parameter. After typing further, to \c add(17, (where the code-completion
4647  * point is after the ","), the code-completion string will contain a
4648  * "current paremeter" chunk to "int y".
4649  */
4651  /**
4652  * \brief A left parenthesis ('('), used to initiate a function call or
4653  * signal the beginning of a function parameter list.
4654  */
4656  /**
4657  * \brief A right parenthesis (')'), used to finish a function call or
4658  * signal the end of a function parameter list.
4659  */
4661  /**
4662  * \brief A left bracket ('[').
4663  */
4665  /**
4666  * \brief A right bracket (']').
4667  */
4669  /**
4670  * \brief A left brace ('{').
4671  */
4673  /**
4674  * \brief A right brace ('}').
4675  */
4677  /**
4678  * \brief A left angle bracket ('<').
4679  */
4681  /**
4682  * \brief A right angle bracket ('>').
4683  */
4685  /**
4686  * \brief A comma separator (',').
4687  */
4689  /**
4690  * \brief Text that specifies the result type of a given result.
4691  *
4692  * This special kind of informative chunk is not meant to be inserted into
4693  * the text buffer. Rather, it is meant to illustrate the type that an
4694  * expression using the given completion string would have.
4695  */
4697  /**
4698  * \brief A colon (':').
4699  */
4701  /**
4702  * \brief A semicolon (';').
4703  */
4705  /**
4706  * \brief An '=' sign.
4707  */
4709  /**
4710  * Horizontal space (' ').
4711  */
4713  /**
4714  * Vertical space ('\n'), after which it is generally a good idea to
4715  * perform indentation.
4716  */
4718 };
4719 
4720 /**
4721  * \brief Determine the kind of a particular chunk within a completion string.
4722  *
4723  * \param completion_string the completion string to query.
4724  *
4725  * \param chunk_number the 0-based index of the chunk in the completion string.
4726  *
4727  * \returns the kind of the chunk at the index \c chunk_number.
4728  */
4730 clang_getCompletionChunkKind(CXCompletionString completion_string,
4731  unsigned chunk_number);
4732 
4733 /**
4734  * \brief Retrieve the text associated with a particular chunk within a
4735  * completion string.
4736  *
4737  * \param completion_string the completion string to query.
4738  *
4739  * \param chunk_number the 0-based index of the chunk in the completion string.
4740  *
4741  * \returns the text associated with the chunk at index \c chunk_number.
4742  */
4744 clang_getCompletionChunkText(CXCompletionString completion_string,
4745  unsigned chunk_number);
4746 
4747 /**
4748  * \brief Retrieve the completion string associated with a particular chunk
4749  * within a completion string.
4750  *
4751  * \param completion_string the completion string to query.
4752  *
4753  * \param chunk_number the 0-based index of the chunk in the completion string.
4754  *
4755  * \returns the completion string associated with the chunk at index
4756  * \c chunk_number.
4757  */
4758 CINDEX_LINKAGE CXCompletionString
4759 clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
4760  unsigned chunk_number);
4761 
4762 /**
4763  * \brief Retrieve the number of chunks in the given code-completion string.
4764  */
4765 CINDEX_LINKAGE unsigned
4766 clang_getNumCompletionChunks(CXCompletionString completion_string);
4767 
4768 /**
4769  * \brief Determine the priority of this code completion.
4770  *
4771  * The priority of a code completion indicates how likely it is that this
4772  * particular completion is the completion that the user will select. The
4773  * priority is selected by various internal heuristics.
4774  *
4775  * \param completion_string The completion string to query.
4776  *
4777  * \returns The priority of this completion string. Smaller values indicate
4778  * higher-priority (more likely) completions.
4779  */
4780 CINDEX_LINKAGE unsigned
4781 clang_getCompletionPriority(CXCompletionString completion_string);
4782 
4783 /**
4784  * \brief Determine the availability of the entity that this code-completion
4785  * string refers to.
4786  *
4787  * \param completion_string The completion string to query.
4788  *
4789  * \returns The availability of the completion string.
4790  */
4792 clang_getCompletionAvailability(CXCompletionString completion_string);
4793 
4794 /**
4795  * \brief Retrieve the number of annotations associated with the given
4796  * completion string.
4797  *
4798  * \param completion_string the completion string to query.
4799  *
4800  * \returns the number of annotations associated with the given completion
4801  * string.
4802  */
4803 CINDEX_LINKAGE unsigned
4804 clang_getCompletionNumAnnotations(CXCompletionString completion_string);
4805 
4806 /**
4807  * \brief Retrieve the annotation associated with the given completion string.
4808  *
4809  * \param completion_string the completion string to query.
4810  *
4811  * \param annotation_number the 0-based index of the annotation of the
4812  * completion string.
4813  *
4814  * \returns annotation string associated with the completion at index
4815  * \c annotation_number, or a NULL string if that annotation is not available.
4816  */
4818 clang_getCompletionAnnotation(CXCompletionString completion_string,
4819  unsigned annotation_number);
4820 
4821 /**
4822  * \brief Retrieve the parent context of the given completion string.
4823  *
4824  * The parent context of a completion string is the semantic parent of
4825  * the declaration (if any) that the code completion represents. For example,
4826  * a code completion for an Objective-C method would have the method's class
4827  * or protocol as its context.
4828  *
4829  * \param completion_string The code completion string whose parent is
4830  * being queried.
4831  *
4832  * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
4833  *
4834  * \returns The name of the completion parent, e.g., "NSObject" if
4835  * the completion string represents a method in the NSObject class.
4836  */
4838 clang_getCompletionParent(CXCompletionString completion_string,
4839  enum CXCursorKind *kind);
4840 
4841 /**
4842  * \brief Retrieve the brief documentation comment attached to the declaration
4843  * that corresponds to the given completion string.
4844  */
4846 clang_getCompletionBriefComment(CXCompletionString completion_string);
4847 
4848 /**
4849  * \brief Retrieve a completion string for an arbitrary declaration or macro
4850  * definition cursor.
4851  *
4852  * \param cursor The cursor to query.
4853  *
4854  * \returns A non-context-sensitive completion string for declaration and macro
4855  * definition cursors, or NULL for other kinds of cursors.
4856  */
4857 CINDEX_LINKAGE CXCompletionString
4859 
4860 /**
4861  * \brief Contains the results of code-completion.
4862  *
4863  * This data structure contains the results of code completion, as
4864  * produced by \c clang_codeCompleteAt(). Its contents must be freed by
4865  * \c clang_disposeCodeCompleteResults.
4866  */
4867 typedef struct {
4868  /**
4869  * \brief The code-completion results.
4870  */
4872 
4873  /**
4874  * \brief The number of code-completion results stored in the
4875  * \c Results array.
4876  */
4877  unsigned NumResults;
4879 
4880 /**
4881  * \brief Flags that can be passed to \c clang_codeCompleteAt() to
4882  * modify its behavior.
4883  *
4884  * The enumerators in this enumeration can be bitwise-OR'd together to
4885  * provide multiple options to \c clang_codeCompleteAt().
4886  */
4888  /**
4889  * \brief Whether to include macros within the set of code
4890  * completions returned.
4891  */
4893 
4894  /**
4895  * \brief Whether to include code patterns for language constructs
4896  * within the set of code completions, e.g., for loops.
4897  */
4899 
4900  /**
4901  * \brief Whether to include brief documentation within the set of code
4902  * completions returned.
4903  */
4905 };
4906 
4907 /**
4908  * \brief Bits that represent the context under which completion is occurring.
4909  *
4910  * The enumerators in this enumeration may be bitwise-OR'd together if multiple
4911  * contexts are occurring simultaneously.
4912  */
4914  /**
4915  * \brief The context for completions is unexposed, as only Clang results
4916  * should be included. (This is equivalent to having no context bits set.)
4917  */
4919 
4920  /**
4921  * \brief Completions for any possible type should be included in the results.
4922  */
4924 
4925  /**
4926  * \brief Completions for any possible value (variables, function calls, etc.)
4927  * should be included in the results.
4928  */
4930  /**
4931  * \brief Completions for values that resolve to an Objective-C object should
4932  * be included in the results.
4933  */
4935  /**
4936  * \brief Completions for values that resolve to an Objective-C selector
4937  * should be included in the results.
4938  */
4940  /**
4941  * \brief Completions for values that resolve to a C++ class type should be
4942  * included in the results.
4943  */
4945 
4946  /**
4947  * \brief Completions for fields of the member being accessed using the dot
4948  * operator should be included in the results.
4949  */
4951  /**
4952  * \brief Completions for fields of the member being accessed using the arrow
4953  * operator should be included in the results.
4954  */
4956  /**
4957  * \brief Completions for properties of the Objective-C object being accessed
4958  * using the dot operator should be included in the results.
4959  */
4961 
4962  /**
4963  * \brief Completions for enum tags should be included in the results.
4964  */
4966  /**
4967  * \brief Completions for union tags should be included in the results.
4968  */
4970  /**
4971  * \brief Completions for struct tags should be included in the results.
4972  */
4974 
4975  /**
4976  * \brief Completions for C++ class names should be included in the results.
4977  */
4979  /**
4980  * \brief Completions for C++ namespaces and namespace aliases should be
4981  * included in the results.
4982  */
4984  /**
4985  * \brief Completions for C++ nested name specifiers should be included in
4986  * the results.
4987  */
4989 
4990  /**
4991  * \brief Completions for Objective-C interfaces (classes) should be included
4992  * in the results.
4993  */
4995  /**
4996  * \brief Completions for Objective-C protocols should be included in
4997  * the results.
4998  */
5000  /**
5001  * \brief Completions for Objective-C categories should be included in
5002  * the results.
5003  */
5005  /**
5006  * \brief Completions for Objective-C instance messages should be included
5007  * in the results.
5008  */
5010  /**
5011  * \brief Completions for Objective-C class messages should be included in
5012  * the results.
5013  */
5015  /**
5016  * \brief Completions for Objective-C selector names should be included in
5017  * the results.
5018  */
5020 
5021  /**
5022  * \brief Completions for preprocessor macro names should be included in
5023  * the results.
5024  */
5026 
5027  /**
5028  * \brief Natural language completions should be included in the results.
5029  */
5031 
5032  /**
5033  * \brief The current context is unknown, so set all contexts.
5034  */
5036 };
5037 
5038 /**
5039  * \brief Returns a default set of code-completion options that can be
5040  * passed to\c clang_codeCompleteAt().
5041  */
5043 
5044 /**
5045  * \brief Perform code completion at a given location in a translation unit.
5046  *
5047  * This function performs code completion at a particular file, line, and
5048  * column within source code, providing results that suggest potential
5049  * code snippets based on the context of the completion. The basic model
5050  * for code completion is that Clang will parse a complete source file,
5051  * performing syntax checking up to the location where code-completion has
5052  * been requested. At that point, a special code-completion token is passed
5053  * to the parser, which recognizes this token and determines, based on the
5054  * current location in the C/Objective-C/C++ grammar and the state of
5055  * semantic analysis, what completions to provide. These completions are
5056  * returned via a new \c CXCodeCompleteResults structure.
5057  *
5058  * Code completion itself is meant to be triggered by the client when the
5059  * user types punctuation characters or whitespace, at which point the
5060  * code-completion location will coincide with the cursor. For example, if \c p
5061  * is a pointer, code-completion might be triggered after the "-" and then
5062  * after the ">" in \c p->. When the code-completion location is afer the ">",
5063  * the completion results will provide, e.g., the members of the struct that
5064  * "p" points to. The client is responsible for placing the cursor at the
5065  * beginning of the token currently being typed, then filtering the results
5066  * based on the contents of the token. For example, when code-completing for
5067  * the expression \c p->get, the client should provide the location just after
5068  * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
5069  * client can filter the results based on the current token text ("get"), only
5070  * showing those results that start with "get". The intent of this interface
5071  * is to separate the relatively high-latency acquisition of code-completion
5072  * results from the filtering of results on a per-character basis, which must
5073  * have a lower latency.
5074  *
5075  * \param TU The translation unit in which code-completion should
5076  * occur. The source files for this translation unit need not be
5077  * completely up-to-date (and the contents of those source files may
5078  * be overridden via \p unsaved_files). Cursors referring into the
5079  * translation unit may be invalidated by this invocation.
5080  *
5081  * \param complete_filename The name of the source file where code
5082  * completion should be performed. This filename may be any file
5083  * included in the translation unit.
5084  *
5085  * \param complete_line The line at which code-completion should occur.
5086  *
5087  * \param complete_column The column at which code-completion should occur.
5088  * Note that the column should point just after the syntactic construct that
5089  * initiated code completion, and not in the middle of a lexical token.
5090  *
5091  * \param unsaved_files the Files that have not yet been saved to disk
5092  * but may be required for parsing or code completion, including the
5093  * contents of those files. The contents and name of these files (as
5094  * specified by CXUnsavedFile) are copied when necessary, so the
5095  * client only needs to guarantee their validity until the call to
5096  * this function returns.
5097  *
5098  * \param num_unsaved_files The number of unsaved file entries in \p
5099  * unsaved_files.
5100  *
5101  * \param options Extra options that control the behavior of code
5102  * completion, expressed as a bitwise OR of the enumerators of the
5103  * CXCodeComplete_Flags enumeration. The
5104  * \c clang_defaultCodeCompleteOptions() function returns a default set
5105  * of code-completion options.
5106  *
5107  * \returns If successful, a new \c CXCodeCompleteResults structure
5108  * containing code-completion results, which should eventually be
5109  * freed with \c clang_disposeCodeCompleteResults(). If code
5110  * completion fails, returns NULL.
5111  */
5113 CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
5114  const char *complete_filename,
5115  unsigned complete_line,
5116  unsigned complete_column,
5117  struct CXUnsavedFile *unsaved_files,
5118  unsigned num_unsaved_files,
5119  unsigned options);
5120 
5121 /**
5122  * \brief Sort the code-completion results in case-insensitive alphabetical
5123  * order.
5124  *
5125  * \param Results The set of results to sort.
5126  * \param NumResults The number of results in \p Results.
5127  */
5130  unsigned NumResults);
5131 
5132 /**
5133  * \brief Free the given set of code-completion results.
5134  */
5137 
5138 /**
5139  * \brief Determine the number of diagnostics produced prior to the
5140  * location where code completion was performed.
5141  */
5144 
5145 /**
5146  * \brief Retrieve a diagnostic associated with the given code completion.
5147  *
5148  * \param Results the code completion results to query.
5149  * \param Index the zero-based diagnostic number to retrieve.
5150  *
5151  * \returns the requested diagnostic. This diagnostic must be freed
5152  * via a call to \c clang_disposeDiagnostic().
5153  */
5156  unsigned Index);
5157 
5158 /**
5159  * \brief Determines what completions are appropriate for the context
5160  * the given code completion.
5161  *
5162  * \param Results the code completion results to query
5163  *
5164  * \returns the kinds of completions that are appropriate for use
5165  * along with the given code completion results.
5166  */
5168 unsigned long long clang_codeCompleteGetContexts(
5169  CXCodeCompleteResults *Results);
5170 
5171 /**
5172  * \brief Returns the cursor kind for the container for the current code
5173  * completion context. The container is only guaranteed to be set for
5174  * contexts where a container exists (i.e. member accesses or Objective-C
5175  * message sends); if there is not a container, this function will return
5176  * CXCursor_InvalidCode.
5177  *
5178  * \param Results the code completion results to query
5179  *
5180  * \param IsIncomplete on return, this value will be false if Clang has complete
5181  * information about the container. If Clang does not have complete
5182  * information, this value will be true.
5183  *
5184  * \returns the container kind, or CXCursor_InvalidCode if there is not a
5185  * container
5186  */
5189  CXCodeCompleteResults *Results,
5190  unsigned *IsIncomplete);
5191 
5192 /**
5193  * \brief Returns the USR for the container for the current code completion
5194  * context. If there is not a container for the current context, this
5195  * function will return the empty string.
5196  *
5197  * \param Results the code completion results to query
5198  *
5199  * \returns the USR for the container
5200  */
5203 
5204 /**
5205  * \brief Returns the currently-entered selector for an Objective-C message
5206  * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
5207  * non-empty string for CXCompletionContext_ObjCInstanceMessage and
5208  * CXCompletionContext_ObjCClassMessage.
5209  *
5210  * \param Results the code completion results to query
5211  *
5212  * \returns the selector (or partial selector) that has been entered thus far
5213  * for an Objective-C message send.
5214  */
5217 
5218 /**
5219  * @}
5220  */
5221 
5222 /**
5223  * \defgroup CINDEX_MISC Miscellaneous utility functions
5224  *
5225  * @{
5226  */
5227 
5228 /**
5229  * \brief Return a version string, suitable for showing to a user, but not
5230  * intended to be parsed (the format is not guaranteed to be stable).
5231  */
5233 
5234 /**
5235  * \brief Enable/disable crash recovery.
5236  *
5237  * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero
5238  * value enables crash recovery, while 0 disables it.
5239  */
5241 
5242  /**
5243  * \brief Visitor invoked for each file in a translation unit
5244  * (used with clang_getInclusions()).
5245  *
5246  * This visitor function will be invoked by clang_getInclusions() for each
5247  * file included (either at the top-level or by \#include directives) within
5248  * a translation unit. The first argument is the file being included, and
5249  * the second and third arguments provide the inclusion stack. The
5250  * array is sorted in order of immediate inclusion. For example,
5251  * the first element refers to the location that included 'included_file'.
5252  */
5253 typedef void (*CXInclusionVisitor)(CXFile included_file,
5254  CXSourceLocation* inclusion_stack,
5255  unsigned include_len,
5256  CXClientData client_data);
5257 
5258 /**
5259  * \brief Visit the set of preprocessor inclusions in a translation unit.
5260  * The visitor function is called with the provided data for every included
5261  * file. This does not include headers included by the PCH file (unless one
5262  * is inspecting the inclusions in the PCH file itself).
5263  */
5264 CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
5265  CXInclusionVisitor visitor,
5266  CXClientData client_data);
5267 
5268 typedef enum {
5275 
5277 
5278 } CXEvalResultKind ;
5279 
5280 /**
5281  * \brief Evaluation result of a cursor
5282  */
5283 typedef void * CXEvalResult;
5284 
5285 /**
5286  * \brief If cursor is a statement declaration tries to evaluate the
5287  * statement and if its variable, tries to evaluate its initializer,
5288  * into its corresponding type.
5289  */
5291 
5292 /**
5293  * \brief Returns the kind of the evaluated result.
5294  */
5296 
5297 /**
5298  * \brief Returns the evaluation result as integer if the
5299  * kind is Int.
5300  */
5301 CINDEX_LINKAGE int clang_EvalResult_getAsInt(CXEvalResult E);
5302 
5303 /**
5304  * \brief Returns the evaluation result as a long long integer if the
5305  * kind is Int. This prevents overflows that may happen if the result is
5306  * returned with clang_EvalResult_getAsInt.
5307  */
5308 CINDEX_LINKAGE long long clang_EvalResult_getAsLongLong(CXEvalResult E);
5309 
5310 /**
5311  * \brief Returns a non-zero value if the kind is Int and the evaluation
5312  * result resulted in an unsigned integer.
5313  */
5314 CINDEX_LINKAGE unsigned clang_EvalResult_isUnsignedInt(CXEvalResult E);
5315 
5316 /**
5317  * \brief Returns the evaluation result as an unsigned integer if
5318  * the kind is Int and clang_EvalResult_isUnsignedInt is non-zero.
5319  */
5320 CINDEX_LINKAGE unsigned long long clang_EvalResult_getAsUnsigned(CXEvalResult E);
5321 
5322 /**
5323  * \brief Returns the evaluation result as double if the
5324  * kind is double.
5325  */
5326 CINDEX_LINKAGE double clang_EvalResult_getAsDouble(CXEvalResult E);
5327 
5328 /**
5329  * \brief Returns the evaluation result as a constant string if the
5330  * kind is other than Int or float. User must not free this pointer,
5331  * instead call clang_EvalResult_dispose on the CXEvalResult returned
5332  * by clang_Cursor_Evaluate.
5333  */
5334 CINDEX_LINKAGE const char* clang_EvalResult_getAsStr(CXEvalResult E);
5335 
5336 /**
5337  * \brief Disposes the created Eval memory.
5338  */
5339 CINDEX_LINKAGE void clang_EvalResult_dispose(CXEvalResult E);
5340 /**
5341  * @}
5342  */
5343 
5344 /** \defgroup CINDEX_REMAPPING Remapping functions
5345  *
5346  * @{
5347  */
5348 
5349 /**
5350  * \brief A remapping of original source files and their translated files.
5351  */
5352 typedef void *CXRemapping;
5353 
5354 /**
5355  * \brief Retrieve a remapping.
5356  *
5357  * \param path the path that contains metadata about remappings.
5358  *
5359  * \returns the requested remapping. This remapping must be freed
5360  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5361  */
5362 CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
5363 
5364 /**
5365  * \brief Retrieve a remapping.
5366  *
5367  * \param filePaths pointer to an array of file paths containing remapping info.
5368  *
5369  * \param numFiles number of file paths.
5370  *
5371  * \returns the requested remapping. This remapping must be freed
5372  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5373  */
5375 CXRemapping clang_getRemappingsFromFileList(const char **filePaths,
5376  unsigned numFiles);
5377 
5378 /**
5379  * \brief Determine the number of remappings.
5380  */
5381 CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
5382 
5383 /**
5384  * \brief Get the original and the associated filename from the remapping.
5385  *
5386  * \param original If non-NULL, will be set to the original filename.
5387  *
5388  * \param transformed If non-NULL, will be set to the filename that the original
5389  * is associated with.
5390  */
5391 CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
5392  CXString *original, CXString *transformed);
5393 
5394 /**
5395  * \brief Dispose the remapping.
5396  */
5397 CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
5398 
5399 /**
5400  * @}
5401  */
5402 
5403 /** \defgroup CINDEX_HIGH Higher level API functions
5404  *
5405  * @{
5406  */
5407 
5411 };
5412 
5413 typedef struct CXCursorAndRangeVisitor {
5414  void *context;
5415  enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
5417 
5418 typedef enum {
5419  /**
5420  * \brief Function returned successfully.
5421  */
5423  /**
5424  * \brief One of the parameters was invalid for the function.
5425  */
5427  /**
5428  * \brief The function was terminated by a callback (e.g. it returned
5429  * CXVisit_Break)
5430  */
5432 
5433 } CXResult;
5434 
5435 /**
5436  * \brief Find references of a declaration in a specific file.
5437  *
5438  * \param cursor pointing to a declaration or a reference of one.
5439  *
5440  * \param file to search for references.
5441  *
5442  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5443  * each reference found.
5444  * The CXSourceRange will point inside the file; if the reference is inside
5445  * a macro (and not a macro argument) the CXSourceRange will be invalid.
5446  *
5447  * \returns one of the CXResult enumerators.
5448  */
5450  CXCursorAndRangeVisitor visitor);
5451 
5452 /**
5453  * \brief Find #import/#include directives in a specific file.
5454  *
5455  * \param TU translation unit containing the file to query.
5456  *
5457  * \param file to search for #import/#include directives.
5458  *
5459  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5460  * each directive found.
5461  *
5462  * \returns one of the CXResult enumerators.
5463  */
5464 CINDEX_LINKAGE CXResult clang_findIncludesInFile(CXTranslationUnit TU,
5465  CXFile file,
5466  CXCursorAndRangeVisitor visitor);
5467 
5468 #ifdef __has_feature
5469 # if __has_feature(blocks)
5470 
5471 typedef enum CXVisitorResult
5472  (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange);
5473 
5475 CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile,
5476  CXCursorAndRangeVisitorBlock);
5477 
5479 CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile,
5480  CXCursorAndRangeVisitorBlock);
5481 
5482 # endif
5483 #endif
5484 
5485 /**
5486  * \brief The client's data object that is associated with a CXFile.
5487  */
5488 typedef void *CXIdxClientFile;
5489 
5490 /**
5491  * \brief The client's data object that is associated with a semantic entity.
5492  */
5493 typedef void *CXIdxClientEntity;
5494 
5495 /**
5496  * \brief The client's data object that is associated with a semantic container
5497  * of entities.
5498  */
5499 typedef void *CXIdxClientContainer;
5500 
5501 /**
5502  * \brief The client's data object that is associated with an AST file (PCH
5503  * or module).
5504  */
5505 typedef void *CXIdxClientASTFile;
5506 
5507 /**
5508  * \brief Source location passed to index callbacks.
5509  */
5510 typedef struct {
5511  void *ptr_data[2];
5512  unsigned int_data;
5513 } CXIdxLoc;
5514 
5515 /**
5516  * \brief Data for ppIncludedFile callback.
5517  */
5518 typedef struct {
5519  /**
5520  * \brief Location of '#' in the \#include/\#import directive.
5521  */
5523  /**
5524  * \brief Filename as written in the \#include/\#import directive.
5525  */
5526  const char *filename;
5527  /**
5528  * \brief The actual file that the \#include/\#import directive resolved to.
5529  */
5530  CXFile file;
5533  /**
5534  * \brief Non-zero if the directive was automatically turned into a module
5535  * import.
5536  */
5539 
5540 /**
5541  * \brief Data for IndexerCallbacks#importedASTFile.
5542  */
5543 typedef struct {
5544  /**
5545  * \brief Top level AST file containing the imported PCH, module or submodule.
5546  */
5547  CXFile file;
5548  /**
5549  * \brief The imported module or NULL if the AST file is a PCH.
5550  */
5551  CXModule module;
5552  /**
5553  * \brief Location where the file is imported. Applicable only for modules.
5554  */
5556  /**
5557  * \brief Non-zero if an inclusion directive was automatically turned into
5558  * a module import. Applicable only for modules.
5559  */
5561 
5563 
5564 typedef enum {
5571 
5575 
5580 
5584 
5596 
5597 } CXIdxEntityKind;
5598 
5599 typedef enum {
5605 
5606 /**
5607  * \brief Extra C++ template information for an entity. This can apply to:
5608  * CXIdxEntity_Function
5609  * CXIdxEntity_CXXClass
5610  * CXIdxEntity_CXXStaticMethod
5611  * CXIdxEntity_CXXInstanceMethod
5612  * CXIdxEntity_CXXConstructor
5613  * CXIdxEntity_CXXConversionFunction
5614  * CXIdxEntity_CXXTypeAlias
5615  */
5616 typedef enum {
5622 
5623 typedef enum {
5628 } CXIdxAttrKind;
5629 
5630 typedef struct {
5632  CXCursor cursor;
5634 } CXIdxAttrInfo;
5635 
5636 typedef struct {
5640  const char *name;
5641  const char *USR;
5642  CXCursor cursor;
5643  const CXIdxAttrInfo *const *attributes;
5644  unsigned numAttributes;
5645 } CXIdxEntityInfo;
5646 
5647 typedef struct {
5648  CXCursor cursor;
5650 
5651 typedef struct {
5654  CXCursor classCursor;
5657 
5658 typedef enum {
5661 
5662 typedef struct {
5664  CXCursor cursor;
5667  /**
5668  * \brief Generally same as #semanticContainer but can be different in
5669  * cases like out-of-line C++ member functions.
5670  */
5676  /**
5677  * \brief Whether the declaration exists in code or was created implicitly
5678  * by the compiler, e.g. implicit Objective-C methods for properties.
5679  */
5681  const CXIdxAttrInfo *const *attributes;
5682  unsigned numAttributes;
5683 
5684  unsigned flags;
5685 
5686 } CXIdxDeclInfo;
5687 
5688 typedef enum {
5693 
5694 typedef struct {
5698 
5699 typedef struct {
5701  CXCursor cursor;
5704