clang  4.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 35
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 
2346 
2347  /**
2348  * \brief Cursor that represents the translation unit itself.
2349  *
2350  * The translation unit cursor exists primarily to act as the root
2351  * cursor for traversing the contents of a translation unit.
2352  */
2354 
2355  /* Attributes */
2357  /**
2358  * \brief An attribute whose specific kind is not exposed via this
2359  * interface.
2360  */
2362 
2383 
2384  /* Preprocessing */
2392 
2393  /* Extra Declarations */
2394  /**
2395  * \brief A module import declaration.
2396  */
2399  /**
2400  * \brief A static_assert or _Static_assert node
2401  */
2405 
2406  /**
2407  * \brief A code completion overload candidate.
2408  */
2410 };
2411 
2412 /**
2413  * \brief A cursor representing some element in the abstract syntax tree for
2414  * a translation unit.
2415  *
2416  * The cursor abstraction unifies the different kinds of entities in a
2417  * program--declaration, statements, expressions, references to declarations,
2418  * etc.--under a single "cursor" abstraction with a common set of operations.
2419  * Common operation for a cursor include: getting the physical location in
2420  * a source file where the cursor points, getting the name associated with a
2421  * cursor, and retrieving cursors for any child nodes of a particular cursor.
2422  *
2423  * Cursors can be produced in two specific ways.
2424  * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
2425  * from which one can use clang_visitChildren() to explore the rest of the
2426  * translation unit. clang_getCursor() maps from a physical source location
2427  * to the entity that resides at that location, allowing one to map from the
2428  * source code into the AST.
2429  */
2430 typedef struct {
2432  int xdata;
2433  const void *data[3];
2434 } CXCursor;
2435 
2436 /**
2437  * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
2438  *
2439  * @{
2440  */
2441 
2442 /**
2443  * \brief Retrieve the NULL cursor, which represents no entity.
2444  */
2446 
2447 /**
2448  * \brief Retrieve the cursor that represents the given translation unit.
2449  *
2450  * The translation unit cursor can be used to start traversing the
2451  * various declarations within the given translation unit.
2452  */
2454 
2455 /**
2456  * \brief Determine whether two cursors are equivalent.
2457  */
2459 
2460 /**
2461  * \brief Returns non-zero if \p cursor is null.
2462  */
2464 
2465 /**
2466  * \brief Compute a hash value for the given cursor.
2467  */
2469 
2470 /**
2471  * \brief Retrieve the kind of the given cursor.
2472  */
2474 
2475 /**
2476  * \brief Determine whether the given cursor kind represents a declaration.
2477  */
2479 
2480 /**
2481  * \brief Determine whether the given cursor kind represents a simple
2482  * reference.
2483  *
2484  * Note that other kinds of cursors (such as expressions) can also refer to
2485  * other cursors. Use clang_getCursorReferenced() to determine whether a
2486  * particular cursor refers to another entity.
2487  */
2489 
2490 /**
2491  * \brief Determine whether the given cursor kind represents an expression.
2492  */
2494 
2495 /**
2496  * \brief Determine whether the given cursor kind represents a statement.
2497  */
2499 
2500 /**
2501  * \brief Determine whether the given cursor kind represents an attribute.
2502  */
2504 
2505 /**
2506  * \brief Determine whether the given cursor has any attributes.
2507  */
2509 
2510 /**
2511  * \brief Determine whether the given cursor kind represents an invalid
2512  * cursor.
2513  */
2515 
2516 /**
2517  * \brief Determine whether the given cursor kind represents a translation
2518  * unit.
2519  */
2521 
2522 /***
2523  * \brief Determine whether the given cursor represents a preprocessing
2524  * element, such as a preprocessor directive or macro instantiation.
2525  */
2527 
2528 /***
2529  * \brief Determine whether the given cursor represents a currently
2530  * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
2531  */
2533 
2534 /**
2535  * \brief Describe the linkage of the entity referred to by a cursor.
2536  */
2538  /** \brief This value indicates that no linkage information is available
2539  * for a provided CXCursor. */
2541  /**
2542  * \brief This is the linkage for variables, parameters, and so on that
2543  * have automatic storage. This covers normal (non-extern) local variables.
2544  */
2546  /** \brief This is the linkage for static variables and static functions. */
2548  /** \brief This is the linkage for entities with external linkage that live
2549  * in C++ anonymous namespaces.*/
2551  /** \brief This is the linkage for entities with true, external linkage. */
2553 };
2554 
2555 /**
2556  * \brief Determine the linkage of the entity referred to by a given cursor.
2557  */
2559 
2561  /** \brief This value indicates that no visibility information is available
2562  * for a provided CXCursor. */
2564 
2565  /** \brief Symbol not seen by the linker. */
2567  /** \brief Symbol seen by the linker but resolves to a symbol inside this object. */
2569  /** \brief Symbol seen by the linker and acts like a normal symbol. */
2571 };
2572 
2573 /**
2574  * \brief Describe the visibility of the entity referred to by a cursor.
2575  *
2576  * This returns the default visibility if not explicitly specified by
2577  * a visibility attribute. The default visibility may be changed by
2578  * commandline arguments.
2579  *
2580  * \param cursor The cursor to query.
2581  *
2582  * \returns The visibility of the cursor.
2583  */
2585 
2586 /**
2587  * \brief Determine the availability of the entity that this cursor refers to,
2588  * taking the current target platform into account.
2589  *
2590  * \param cursor The cursor to query.
2591  *
2592  * \returns The availability of the cursor.
2593  */
2596 
2597 /**
2598  * Describes the availability of a given entity on a particular platform, e.g.,
2599  * a particular class might only be available on Mac OS 10.7 or newer.
2600  */
2601 typedef struct CXPlatformAvailability {
2602  /**
2603  * \brief A string that describes the platform for which this structure
2604  * provides availability information.
2605  *
2606  * Possible values are "ios" or "macos".
2607  */
2609  /**
2610  * \brief The version number in which this entity was introduced.
2611  */
2613  /**
2614  * \brief The version number in which this entity was deprecated (but is
2615  * still available).
2616  */
2618  /**
2619  * \brief The version number in which this entity was obsoleted, and therefore
2620  * is no longer available.
2621  */
2623  /**
2624  * \brief Whether the entity is unconditionally unavailable on this platform.
2625  */
2627  /**
2628  * \brief An optional message to provide to a user of this API, e.g., to
2629  * suggest replacement APIs.
2630  */
2633 
2634 /**
2635  * \brief Determine the availability of the entity that this cursor refers to
2636  * on any platforms for which availability information is known.
2637  *
2638  * \param cursor The cursor to query.
2639  *
2640  * \param always_deprecated If non-NULL, will be set to indicate whether the
2641  * entity is deprecated on all platforms.
2642  *
2643  * \param deprecated_message If non-NULL, will be set to the message text
2644  * provided along with the unconditional deprecation of this entity. The client
2645  * is responsible for deallocating this string.
2646  *
2647  * \param always_unavailable If non-NULL, will be set to indicate whether the
2648  * entity is unavailable on all platforms.
2649  *
2650  * \param unavailable_message If non-NULL, will be set to the message text
2651  * provided along with the unconditional unavailability of this entity. The
2652  * client is responsible for deallocating this string.
2653  *
2654  * \param availability If non-NULL, an array of CXPlatformAvailability instances
2655  * that will be populated with platform availability information, up to either
2656  * the number of platforms for which availability information is available (as
2657  * returned by this function) or \c availability_size, whichever is smaller.
2658  *
2659  * \param availability_size The number of elements available in the
2660  * \c availability array.
2661  *
2662  * \returns The number of platforms (N) for which availability information is
2663  * available (which is unrelated to \c availability_size).
2664  *
2665  * Note that the client is responsible for calling
2666  * \c clang_disposeCXPlatformAvailability to free each of the
2667  * platform-availability structures returned. There are
2668  * \c min(N, availability_size) such structures.
2669  */
2670 CINDEX_LINKAGE int
2672  int *always_deprecated,
2673  CXString *deprecated_message,
2674  int *always_unavailable,
2675  CXString *unavailable_message,
2676  CXPlatformAvailability *availability,
2677  int availability_size);
2678 
2679 /**
2680  * \brief Free the memory associated with a \c CXPlatformAvailability structure.
2681  */
2682 CINDEX_LINKAGE void
2684 
2685 /**
2686  * \brief Describe the "language" of the entity referred to by a cursor.
2687  */
2693 };
2694 
2695 /**
2696  * \brief Determine the "language" of the entity referred to by a given cursor.
2697  */
2699 
2700 /**
2701  * \brief Returns the translation unit that a cursor originated from.
2702  */
2704 
2705 /**
2706  * \brief A fast container representing a set of CXCursors.
2707  */
2708 typedef struct CXCursorSetImpl *CXCursorSet;
2709 
2710 /**
2711  * \brief Creates an empty CXCursorSet.
2712  */
2713 CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void);
2714 
2715 /**
2716  * \brief Disposes a CXCursorSet and releases its associated memory.
2717  */
2718 CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
2719 
2720 /**
2721  * \brief Queries a CXCursorSet to see if it contains a specific CXCursor.
2722  *
2723  * \returns non-zero if the set contains the specified cursor.
2724 */
2725 CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
2726  CXCursor cursor);
2727 
2728 /**
2729  * \brief Inserts a CXCursor into a CXCursorSet.
2730  *
2731  * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
2732 */
2733 CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
2734  CXCursor cursor);
2735 
2736 /**
2737  * \brief Determine the semantic parent of the given cursor.
2738  *
2739  * The semantic parent of a cursor is the cursor that semantically contains
2740  * the given \p cursor. For many declarations, the lexical and semantic parents
2741  * are equivalent (the lexical parent is returned by
2742  * \c clang_getCursorLexicalParent()). They diverge when declarations or
2743  * definitions are provided out-of-line. For example:
2744  *
2745  * \code
2746  * class C {
2747  * void f();
2748  * };
2749  *
2750  * void C::f() { }
2751  * \endcode
2752  *
2753  * In the out-of-line definition of \c C::f, the semantic parent is
2754  * the class \c C, of which this function is a member. The lexical parent is
2755  * the place where the declaration actually occurs in the source code; in this
2756  * case, the definition occurs in the translation unit. In general, the
2757  * lexical parent for a given entity can change without affecting the semantics
2758  * of the program, and the lexical parent of different declarations of the
2759  * same entity may be different. Changing the semantic parent of a declaration,
2760  * on the other hand, can have a major impact on semantics, and redeclarations
2761  * of a particular entity should all have the same semantic context.
2762  *
2763  * In the example above, both declarations of \c C::f have \c C as their
2764  * semantic context, while the lexical context of the first \c C::f is \c C
2765  * and the lexical context of the second \c C::f is the translation unit.
2766  *
2767  * For global declarations, the semantic parent is the translation unit.
2768  */
2770 
2771 /**
2772  * \brief Determine the lexical parent of the given cursor.
2773  *
2774  * The lexical parent of a cursor is the cursor in which the given \p cursor
2775  * was actually written. For many declarations, the lexical and semantic parents
2776  * are equivalent (the semantic parent is returned by
2777  * \c clang_getCursorSemanticParent()). They diverge when declarations or
2778  * definitions are provided out-of-line. For example:
2779  *
2780  * \code
2781  * class C {
2782  * void f();
2783  * };
2784  *
2785  * void C::f() { }
2786  * \endcode
2787  *
2788  * In the out-of-line definition of \c C::f, the semantic parent is
2789  * the class \c C, of which this function is a member. The lexical parent is
2790  * the place where the declaration actually occurs in the source code; in this
2791  * case, the definition occurs in the translation unit. In general, the
2792  * lexical parent for a given entity can change without affecting the semantics
2793  * of the program, and the lexical parent of different declarations of the
2794  * same entity may be different. Changing the semantic parent of a declaration,
2795  * on the other hand, can have a major impact on semantics, and redeclarations
2796  * of a particular entity should all have the same semantic context.
2797  *
2798  * In the example above, both declarations of \c C::f have \c C as their
2799  * semantic context, while the lexical context of the first \c C::f is \c C
2800  * and the lexical context of the second \c C::f is the translation unit.
2801  *
2802  * For declarations written in the global scope, the lexical parent is
2803  * the translation unit.
2804  */
2806 
2807 /**
2808  * \brief Determine the set of methods that are overridden by the given
2809  * method.
2810  *
2811  * In both Objective-C and C++, a method (aka virtual member function,
2812  * in C++) can override a virtual method in a base class. For
2813  * Objective-C, a method is said to override any method in the class's
2814  * base class, its protocols, or its categories' protocols, that has the same
2815  * selector and is of the same kind (class or instance).
2816  * If no such method exists, the search continues to the class's superclass,
2817  * its protocols, and its categories, and so on. A method from an Objective-C
2818  * implementation is considered to override the same methods as its
2819  * corresponding method in the interface.
2820  *
2821  * For C++, a virtual member function overrides any virtual member
2822  * function with the same signature that occurs in its base
2823  * classes. With multiple inheritance, a virtual member function can
2824  * override several virtual member functions coming from different
2825  * base classes.
2826  *
2827  * In all cases, this function determines the immediate overridden
2828  * method, rather than all of the overridden methods. For example, if
2829  * a method is originally declared in a class A, then overridden in B
2830  * (which in inherits from A) and also in C (which inherited from B),
2831  * then the only overridden method returned from this function when
2832  * invoked on C's method will be B's method. The client may then
2833  * invoke this function again, given the previously-found overridden
2834  * methods, to map out the complete method-override set.
2835  *
2836  * \param cursor A cursor representing an Objective-C or C++
2837  * method. This routine will compute the set of methods that this
2838  * method overrides.
2839  *
2840  * \param overridden A pointer whose pointee will be replaced with a
2841  * pointer to an array of cursors, representing the set of overridden
2842  * methods. If there are no overridden methods, the pointee will be
2843  * set to NULL. The pointee must be freed via a call to
2844  * \c clang_disposeOverriddenCursors().
2845  *
2846  * \param num_overridden A pointer to the number of overridden
2847  * functions, will be set to the number of overridden functions in the
2848  * array pointed to by \p overridden.
2849  */
2851  CXCursor **overridden,
2852  unsigned *num_overridden);
2853 
2854 /**
2855  * \brief Free the set of overridden cursors returned by \c
2856  * clang_getOverriddenCursors().
2857  */
2859 
2860 /**
2861  * \brief Retrieve the file that is included by the given inclusion directive
2862  * cursor.
2863  */
2865 
2866 /**
2867  * @}
2868  */
2869 
2870 /**
2871  * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
2872  *
2873  * Cursors represent a location within the Abstract Syntax Tree (AST). These
2874  * routines help map between cursors and the physical locations where the
2875  * described entities occur in the source code. The mapping is provided in
2876  * both directions, so one can map from source code to the AST and back.
2877  *
2878  * @{
2879  */
2880 
2881 /**
2882  * \brief Map a source location to the cursor that describes the entity at that
2883  * location in the source code.
2884  *
2885  * clang_getCursor() maps an arbitrary source location within a translation
2886  * unit down to the most specific cursor that describes the entity at that
2887  * location. For example, given an expression \c x + y, invoking
2888  * clang_getCursor() with a source location pointing to "x" will return the
2889  * cursor for "x"; similarly for "y". If the cursor points anywhere between
2890  * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
2891  * will return a cursor referring to the "+" expression.
2892  *
2893  * \returns a cursor representing the entity at the given source location, or
2894  * a NULL cursor if no such entity can be found.
2895  */
2897 
2898 /**
2899  * \brief Retrieve the physical location of the source constructor referenced
2900  * by the given cursor.
2901  *
2902  * The location of a declaration is typically the location of the name of that
2903  * declaration, where the name of that declaration would occur if it is
2904  * unnamed, or some keyword that introduces that particular declaration.
2905  * The location of a reference is where that reference occurs within the
2906  * source code.
2907  */
2909 
2910 /**
2911  * \brief Retrieve the physical extent of the source construct referenced by
2912  * the given cursor.
2913  *
2914  * The extent of a cursor starts with the file/line/column pointing at the
2915  * first character within the source construct that the cursor refers to and
2916  * ends with the last character within that source construct. For a
2917  * declaration, the extent covers the declaration itself. For a reference,
2918  * the extent covers the location of the reference (e.g., where the referenced
2919  * entity was actually used).
2920  */
2922 
2923 /**
2924  * @}
2925  */
2926 
2927 /**
2928  * \defgroup CINDEX_TYPES Type information for CXCursors
2929  *
2930  * @{
2931  */
2932 
2933 /**
2934  * \brief Describes the kind of type
2935  */
2937  /**
2938  * \brief Represents an invalid type (e.g., where no type is available).
2939  */
2941 
2942  /**
2943  * \brief A type whose specific kind is not exposed via this
2944  * interface.
2945  */
2947 
2948  /* Builtin types */
2980 
3000 
3001  /**
3002  * \brief Represents a type that was referred to using an elaborated type keyword.
3003  *
3004  * E.g., struct S, or via a qualified name, e.g., N::M::type, or both.
3005  */
3007 };
3008 
3009 /**
3010  * \brief Describes the calling convention of a function type
3011  */
3021  /* Value 8 was PnaclCall, but it was never used, so it could safely be re-used. */
3029 
3032 };
3033 
3034 /**
3035  * \brief The type of an element in the abstract syntax tree.
3036  *
3037  */
3038 typedef struct {
3040  void *data[2];
3041 } CXType;
3042 
3043 /**
3044  * \brief Retrieve the type of a CXCursor (if any).
3045  */
3047 
3048 /**
3049  * \brief Pretty-print the underlying type using the rules of the
3050  * language of the translation unit from which it came.
3051  *
3052  * If the type is invalid, an empty string is returned.
3053  */
3055 
3056 /**
3057  * \brief Retrieve the underlying type of a typedef declaration.
3058  *
3059  * If the cursor does not reference a typedef declaration, an invalid type is
3060  * returned.
3061  */
3063 
3064 /**
3065  * \brief Retrieve the integer type of an enum declaration.
3066  *
3067  * If the cursor does not reference an enum declaration, an invalid type is
3068  * returned.
3069  */
3071 
3072 /**
3073  * \brief Retrieve the integer value of an enum constant declaration as a signed
3074  * long long.
3075  *
3076  * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned.
3077  * Since this is also potentially a valid constant value, the kind of the cursor
3078  * must be verified before calling this function.
3079  */
3081 
3082 /**
3083  * \brief Retrieve the integer value of an enum constant declaration as an unsigned
3084  * long long.
3085  *
3086  * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned.
3087  * Since this is also potentially a valid constant value, the kind of the cursor
3088  * must be verified before calling this function.
3089  */
3091 
3092 /**
3093  * \brief Retrieve the bit width of a bit field declaration as an integer.
3094  *
3095  * If a cursor that is not a bit field declaration is passed in, -1 is returned.
3096  */
3098 
3099 /**
3100  * \brief Retrieve the number of non-variadic arguments associated with a given
3101  * cursor.
3102  *
3103  * The number of arguments can be determined for calls as well as for
3104  * declarations of functions or methods. For other cursors -1 is returned.
3105  */
3107 
3108 /**
3109  * \brief Retrieve the argument cursor of a function or method.
3110  *
3111  * The argument cursor can be determined for calls as well as for declarations
3112  * of functions or methods. For other cursors and for invalid indices, an
3113  * invalid cursor is returned.
3114  */
3116 
3117 /**
3118  * \brief Describes the kind of a template argument.
3119  *
3120  * See the definition of llvm::clang::TemplateArgument::ArgKind for full
3121  * element descriptions.
3122  */
3133  /* Indicates an error case, preventing the kind from being deduced. */
3135 };
3136 
3137 /**
3138  *\brief Returns the number of template args of a function decl representing a
3139  * template specialization.
3140  *
3141  * If the argument cursor cannot be converted into a template function
3142  * declaration, -1 is returned.
3143  *
3144  * For example, for the following declaration and specialization:
3145  * template <typename T, int kInt, bool kBool>
3146  * void foo() { ... }
3147  *
3148  * template <>
3149  * void foo<float, -7, true>();
3150  *
3151  * The value 3 would be returned from this call.
3152  */
3154 
3155 /**
3156  * \brief Retrieve the kind of the I'th template argument of the CXCursor C.
3157  *
3158  * If the argument CXCursor does not represent a FunctionDecl, an invalid
3159  * template argument kind is returned.
3160  *
3161  * For example, for the following declaration and specialization:
3162  * template <typename T, int kInt, bool kBool>
3163  * void foo() { ... }
3164  *
3165  * template <>
3166  * void foo<float, -7, true>();
3167  *
3168  * For I = 0, 1, and 2, Type, Integral, and Integral will be returned,
3169  * respectively.
3170  */
3172  CXCursor C, unsigned I);
3173 
3174 /**
3175  * \brief Retrieve a CXType representing the type of a TemplateArgument of a
3176  * function decl representing a template specialization.
3177  *
3178  * If the argument CXCursor does not represent a FunctionDecl whose I'th
3179  * template argument has a kind of CXTemplateArgKind_Integral, an invalid type
3180  * is returned.
3181  *
3182  * For example, for the following declaration and specialization:
3183  * template <typename T, int kInt, bool kBool>
3184  * void foo() { ... }
3185  *
3186  * template <>
3187  * void foo<float, -7, true>();
3188  *
3189  * If called with I = 0, "float", will be returned.
3190  * Invalid types will be returned for I == 1 or 2.
3191  */
3193  unsigned I);
3194 
3195 /**
3196  * \brief Retrieve the value of an Integral TemplateArgument (of a function
3197  * decl representing a template specialization) as a signed long long.
3198  *
3199  * It is undefined to call this function on a CXCursor that does not represent a
3200  * FunctionDecl or whose I'th template argument is not an integral value.
3201  *
3202  * For example, for the following declaration and specialization:
3203  * template <typename T, int kInt, bool kBool>
3204  * void foo() { ... }
3205  *
3206  * template <>
3207  * void foo<float, -7, true>();
3208  *
3209  * If called with I = 1 or 2, -7 or true will be returned, respectively.
3210  * For I == 0, this function's behavior is undefined.
3211  */
3213  unsigned I);
3214 
3215 /**
3216  * \brief Retrieve the value of an Integral TemplateArgument (of a function
3217  * decl representing a template specialization) as an unsigned long long.
3218  *
3219  * It is undefined to call this function on a CXCursor that does not represent a
3220  * FunctionDecl or whose I'th template argument is not an integral value.
3221  *
3222  * For example, for the following declaration and specialization:
3223  * template <typename T, int kInt, bool kBool>
3224  * void foo() { ... }
3225  *
3226  * template <>
3227  * void foo<float, 2147483649, true>();
3228  *
3229  * If called with I = 1 or 2, 2147483649 or true will be returned, respectively.
3230  * For I == 0, this function's behavior is undefined.
3231  */
3233  CXCursor C, unsigned I);
3234 
3235 /**
3236  * \brief Determine whether two CXTypes represent the same type.
3237  *
3238  * \returns non-zero if the CXTypes represent the same type and
3239  * zero otherwise.
3240  */
3242 
3243 /**
3244  * \brief Return the canonical type for a CXType.
3245  *
3246  * Clang's type system explicitly models typedefs and all the ways
3247  * a specific type can be represented. The canonical type is the underlying
3248  * type with all the "sugar" removed. For example, if 'T' is a typedef
3249  * for 'int', the canonical type for 'T' would be 'int'.
3250  */
3252 
3253 /**
3254  * \brief Determine whether a CXType has the "const" qualifier set,
3255  * without looking through typedefs that may have added "const" at a
3256  * different level.
3257  */
3259 
3260 /**
3261  * \brief Determine whether a CXCursor that is a macro, is
3262  * function like.
3263  */
3265 
3266 /**
3267  * \brief Determine whether a CXCursor that is a macro, is a
3268  * builtin one.
3269  */
3271 
3272 /**
3273  * \brief Determine whether a CXCursor that is a function declaration, is an
3274  * inline declaration.
3275  */
3277 
3278 /**
3279  * \brief Determine whether a CXType has the "volatile" qualifier set,
3280  * without looking through typedefs that may have added "volatile" at
3281  * a different level.
3282  */
3284 
3285 /**
3286  * \brief Determine whether a CXType has the "restrict" qualifier set,
3287  * without looking through typedefs that may have added "restrict" at a
3288  * different level.
3289  */
3291 
3292 /**
3293  * \brief For pointer types, returns the type of the pointee.
3294  */
3296 
3297 /**
3298  * \brief Return the cursor for the declaration of the given type.
3299  */
3301 
3302 /**
3303  * Returns the Objective-C type encoding for the specified declaration.
3304  */
3306 
3307 /**
3308  * Returns the Objective-C type encoding for the specified CXType.
3309  */
3311 
3312 /**
3313  * \brief Retrieve the spelling of a given CXTypeKind.
3314  */
3316 
3317 /**
3318  * \brief Retrieve the calling convention associated with a function type.
3319  *
3320  * If a non-function type is passed in, CXCallingConv_Invalid is returned.
3321  */
3323 
3324 /**
3325  * \brief Retrieve the return type associated with a function type.
3326  *
3327  * If a non-function type is passed in, an invalid type is returned.
3328  */
3330 
3331 /**
3332  * \brief Retrieve the number of non-variadic parameters associated with a
3333  * function type.
3334  *
3335  * If a non-function type is passed in, -1 is returned.
3336  */
3338 
3339 /**
3340  * \brief Retrieve the type of a parameter of a function type.
3341  *
3342  * If a non-function type is passed in or the function does not have enough
3343  * parameters, an invalid type is returned.
3344  */
3346 
3347 /**
3348  * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise.
3349  */
3351 
3352 /**
3353  * \brief Retrieve the return type associated with a given cursor.
3354  *
3355  * This only returns a valid type if the cursor refers to a function or method.
3356  */
3358 
3359 /**
3360  * \brief Return 1 if the CXType is a POD (plain old data) type, and 0
3361  * otherwise.
3362  */
3364 
3365 /**
3366  * \brief Return the element type of an array, complex, or vector type.
3367  *
3368  * If a type is passed in that is not an array, complex, or vector type,
3369  * an invalid type is returned.
3370  */
3372 
3373 /**
3374  * \brief Return the number of elements of an array or vector type.
3375  *
3376  * If a type is passed in that is not an array or vector type,
3377  * -1 is returned.
3378  */
3380 
3381 /**
3382  * \brief Return the element type of an array type.
3383  *
3384  * If a non-array type is passed in, an invalid type is returned.
3385  */
3387 
3388 /**
3389  * \brief Return the array size of a constant array.
3390  *
3391  * If a non-array type is passed in, -1 is returned.
3392  */
3394 
3395 /**
3396  * \brief Retrieve the type named by the qualified-id.
3397  *
3398  * If a non-elaborated type is passed in, an invalid type is returned.
3399  */
3401 
3402 /**
3403  * \brief List the possible error codes for \c clang_Type_getSizeOf,
3404  * \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and
3405  * \c clang_Cursor_getOffsetOf.
3406  *
3407  * A value of this enumeration type can be returned if the target type is not
3408  * a valid argument to sizeof, alignof or offsetof.
3409  */
3411  /**
3412  * \brief Type is of kind CXType_Invalid.
3413  */
3415  /**
3416  * \brief The type is an incomplete Type.
3417  */
3419  /**
3420  * \brief The type is a dependent Type.
3421  */
3423  /**
3424  * \brief The type is not a constant size type.
3425  */
3427  /**
3428  * \brief The Field name is not valid for this record.
3429  */
3431 };
3432 
3433 /**
3434  * \brief Return the alignment of a type in bytes as per C++[expr.alignof]
3435  * standard.
3436  *
3437  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3438  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3439  * is returned.
3440  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3441  * returned.
3442  * If the type declaration is not a constant size type,
3443  * CXTypeLayoutError_NotConstantSize is returned.
3444  */
3446 
3447 /**
3448  * \brief Return the class type of an member pointer type.
3449  *
3450  * If a non-member-pointer type is passed in, an invalid type is returned.
3451  */
3453 
3454 /**
3455  * \brief Return the size of a type in bytes as per C++[expr.sizeof] standard.
3456  *
3457  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3458  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3459  * is returned.
3460  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3461  * returned.
3462  */
3464 
3465 /**
3466  * \brief Return the offset of a field named S in a record of type T in bits
3467  * as it would be returned by __offsetof__ as per C++11[18.2p4]
3468  *
3469  * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
3470  * is returned.
3471  * If the field's type declaration is an incomplete type,
3472  * CXTypeLayoutError_Incomplete is returned.
3473  * If the field's type declaration is a dependent type,
3474  * CXTypeLayoutError_Dependent is returned.
3475  * If the field's name S is not found,
3476  * CXTypeLayoutError_InvalidFieldName is returned.
3477  */
3478 CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S);
3479 
3480 /**
3481  * \brief Return the offset of the field represented by the Cursor.
3482  *
3483  * If the cursor is not a field declaration, -1 is returned.
3484  * If the cursor semantic parent is not a record field declaration,
3485  * CXTypeLayoutError_Invalid is returned.
3486  * If the field's type declaration is an incomplete type,
3487  * CXTypeLayoutError_Incomplete is returned.
3488  * If the field's type declaration is a dependent type,
3489  * CXTypeLayoutError_Dependent is returned.
3490  * If the field's name S is not found,
3491  * CXTypeLayoutError_InvalidFieldName is returned.
3492  */
3494 
3495 /**
3496  * \brief Determine whether the given cursor represents an anonymous record
3497  * declaration.
3498  */
3500 
3502  /** \brief No ref-qualifier was provided. */
3504  /** \brief An lvalue ref-qualifier was provided (\c &). */
3506  /** \brief An rvalue ref-qualifier was provided (\c &&). */
3508 };
3509 
3510 /**
3511  * \brief Returns the number of template arguments for given class template
3512  * specialization, or -1 if type \c T is not a class template specialization.
3513  *
3514  * Variadic argument packs count as only one argument, and can not be inspected
3515  * further.
3516  */
3518 
3519 /**
3520  * \brief Returns the type template argument of a template class specialization
3521  * at given index.
3522  *
3523  * This function only returns template type arguments and does not handle
3524  * template template arguments or variadic packs.
3525  */
3527 
3528 /**
3529  * \brief Retrieve the ref-qualifier kind of a function or method.
3530  *
3531  * The ref-qualifier is returned for C++ functions or methods. For other types
3532  * or non-C++ declarations, CXRefQualifier_None is returned.
3533  */
3535 
3536 /**
3537  * \brief Returns non-zero if the cursor specifies a Record member that is a
3538  * bitfield.
3539  */
3541 
3542 /**
3543  * \brief Returns 1 if the base class specified by the cursor with kind
3544  * CX_CXXBaseSpecifier is virtual.
3545  */
3547 
3548 /**
3549  * \brief Represents the C++ access control level to a base class for a
3550  * cursor with kind CX_CXXBaseSpecifier.
3551  */
3557 };
3558 
3559 /**
3560  * \brief Returns the access control level for the referenced object.
3561  *
3562  * If the cursor refers to a C++ declaration, its access control level within its
3563  * parent scope is returned. Otherwise, if the cursor refers to a base specifier or
3564  * access specifier, the specifier itself is returned.
3565  */
3567 
3568 /**
3569  * \brief Represents the storage classes as declared in the source. CX_SC_Invalid
3570  * was added for the case that the passed cursor in not a declaration.
3571  */
3581 };
3582 
3583 /**
3584  * \brief Returns the storage class for a function or variable declaration.
3585  *
3586  * If the passed in Cursor is not a function or variable declaration,
3587  * CX_SC_Invalid is returned else the storage class.
3588  */
3590 
3591 /**
3592  * \brief Determine the number of overloaded declarations referenced by a
3593  * \c CXCursor_OverloadedDeclRef cursor.
3594  *
3595  * \param cursor The cursor whose overloaded declarations are being queried.
3596  *
3597  * \returns The number of overloaded declarations referenced by \c cursor. If it
3598  * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
3599  */
3601 
3602 /**
3603  * \brief Retrieve a cursor for one of the overloaded declarations referenced
3604  * by a \c CXCursor_OverloadedDeclRef cursor.
3605  *
3606  * \param cursor The cursor whose overloaded declarations are being queried.
3607  *
3608  * \param index The zero-based index into the set of overloaded declarations in
3609  * the cursor.
3610  *
3611  * \returns A cursor representing the declaration referenced by the given
3612  * \c cursor at the specified \c index. If the cursor does not have an
3613  * associated set of overloaded declarations, or if the index is out of bounds,
3614  * returns \c clang_getNullCursor();
3615  */
3617  unsigned index);
3618 
3619 /**
3620  * @}
3621  */
3622 
3623 /**
3624  * \defgroup CINDEX_ATTRIBUTES Information for attributes
3625  *
3626  * @{
3627  */
3628 
3629 /**
3630  * \brief For cursors representing an iboutletcollection attribute,
3631  * this function returns the collection element type.
3632  *
3633  */
3635 
3636 /**
3637  * @}
3638  */
3639 
3640 /**
3641  * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
3642  *
3643  * These routines provide the ability to traverse the abstract syntax tree
3644  * using cursors.
3645  *
3646  * @{
3647  */
3648 
3649 /**
3650  * \brief Describes how the traversal of the children of a particular
3651  * cursor should proceed after visiting a particular child cursor.
3652  *
3653  * A value of this enumeration type should be returned by each
3654  * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
3655  */
3657  /**
3658  * \brief Terminates the cursor traversal.
3659  */
3661  /**
3662  * \brief Continues the cursor traversal with the next sibling of
3663  * the cursor just visited, without visiting its children.
3664  */
3666  /**
3667  * \brief Recursively traverse the children of this cursor, using
3668  * the same visitor and client data.
3669  */
3671 };
3672 
3673 /**
3674  * \brief Visitor invoked for each cursor found by a traversal.
3675  *
3676  * This visitor function will be invoked for each cursor found by
3677  * clang_visitCursorChildren(). Its first argument is the cursor being
3678  * visited, its second argument is the parent visitor for that cursor,
3679  * and its third argument is the client data provided to
3680  * clang_visitCursorChildren().
3681  *
3682  * The visitor should return one of the \c CXChildVisitResult values
3683  * to direct clang_visitCursorChildren().
3684  */
3686  CXCursor parent,
3687  CXClientData client_data);
3688 
3689 /**
3690  * \brief Visit the children of a particular cursor.
3691  *
3692  * This function visits all the direct children of the given cursor,
3693  * invoking the given \p visitor function with the cursors of each
3694  * visited child. The traversal may be recursive, if the visitor returns
3695  * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
3696  * the visitor returns \c CXChildVisit_Break.
3697  *
3698  * \param parent the cursor whose child may be visited. All kinds of
3699  * cursors can be visited, including invalid cursors (which, by
3700  * definition, have no children).
3701  *
3702  * \param visitor the visitor function that will be invoked for each
3703  * child of \p parent.
3704  *
3705  * \param client_data pointer data supplied by the client, which will
3706  * be passed to the visitor each time it is invoked.
3707  *
3708  * \returns a non-zero value if the traversal was terminated
3709  * prematurely by the visitor returning \c CXChildVisit_Break.
3710  */
3712  CXCursorVisitor visitor,
3713  CXClientData client_data);
3714 #ifdef __has_feature
3715 # if __has_feature(blocks)
3716 /**
3717  * \brief Visitor invoked for each cursor found by a traversal.
3718  *
3719  * This visitor block will be invoked for each cursor found by
3720  * clang_visitChildrenWithBlock(). Its first argument is the cursor being
3721  * visited, its second argument is the parent visitor for that cursor.
3722  *
3723  * The visitor should return one of the \c CXChildVisitResult values
3724  * to direct clang_visitChildrenWithBlock().
3725  */
3726 typedef enum CXChildVisitResult
3727  (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
3728 
3729 /**
3730  * Visits the children of a cursor using the specified block. Behaves
3731  * identically to clang_visitChildren() in all other respects.
3732  */
3733 CINDEX_LINKAGE unsigned clang_visitChildrenWithBlock(CXCursor parent,
3734  CXCursorVisitorBlock block);
3735 # endif
3736 #endif
3737 
3738 /**
3739  * @}
3740  */
3741 
3742 /**
3743  * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
3744  *
3745  * These routines provide the ability to determine references within and
3746  * across translation units, by providing the names of the entities referenced
3747  * by cursors, follow reference cursors to the declarations they reference,
3748  * and associate declarations with their definitions.
3749  *
3750  * @{
3751  */
3752 
3753 /**
3754  * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced
3755  * by the given cursor.
3756  *
3757  * A Unified Symbol Resolution (USR) is a string that identifies a particular
3758  * entity (function, class, variable, etc.) within a program. USRs can be
3759  * compared across translation units to determine, e.g., when references in
3760  * one translation refer to an entity defined in another translation unit.
3761  */
3763 
3764 /**
3765  * \brief Construct a USR for a specified Objective-C class.
3766  */
3767 CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
3768 
3769 /**
3770  * \brief Construct a USR for a specified Objective-C category.
3771  */
3773  clang_constructUSR_ObjCCategory(const char *class_name,
3774  const char *category_name);
3775 
3776 /**
3777  * \brief Construct a USR for a specified Objective-C protocol.
3778  */
3780  clang_constructUSR_ObjCProtocol(const char *protocol_name);
3781 
3782 /**
3783  * \brief Construct a USR for a specified Objective-C instance variable and
3784  * the USR for its containing class.
3785  */
3787  CXString classUSR);
3788 
3789 /**
3790  * \brief Construct a USR for a specified Objective-C method and
3791  * the USR for its containing class.
3792  */
3794  unsigned isInstanceMethod,
3795  CXString classUSR);
3796 
3797 /**
3798  * \brief Construct a USR for a specified Objective-C property and the USR
3799  * for its containing class.
3800  */
3802  CXString classUSR);
3803 
3804 /**
3805  * \brief Retrieve a name for the entity referenced by this cursor.
3806  */
3808 
3809 /**
3810  * \brief Retrieve a range for a piece that forms the cursors spelling name.
3811  * Most of the times there is only one range for the complete spelling but for
3812  * Objective-C methods and Objective-C message expressions, there are multiple
3813  * pieces for each selector identifier.
3814  *
3815  * \param pieceIndex the index of the spelling name piece. If this is greater
3816  * than the actual number of pieces, it will return a NULL (invalid) range.
3817  *
3818  * \param options Reserved.
3819  */
3821  unsigned pieceIndex,
3822  unsigned options);
3823 
3824 /**
3825  * \brief Retrieve the display name for the entity referenced by this cursor.
3826  *
3827  * The display name contains extra information that helps identify the cursor,
3828  * such as the parameters of a function or template or the arguments of a
3829  * class template specialization.
3830  */
3832 
3833 /** \brief For a cursor that is a reference, retrieve a cursor representing the
3834  * entity that it references.
3835  *
3836  * Reference cursors refer to other entities in the AST. For example, an
3837  * Objective-C superclass reference cursor refers to an Objective-C class.
3838  * This function produces the cursor for the Objective-C class from the
3839  * cursor for the superclass reference. If the input cursor is a declaration or
3840  * definition, it returns that declaration or definition unchanged.
3841  * Otherwise, returns the NULL cursor.
3842  */
3844 
3845 /**
3846  * \brief For a cursor that is either a reference to or a declaration
3847  * of some entity, retrieve a cursor that describes the definition of
3848  * that entity.
3849  *
3850  * Some entities can be declared multiple times within a translation
3851  * unit, but only one of those declarations can also be a
3852  * definition. For example, given:
3853  *
3854  * \code
3855  * int f(int, int);
3856  * int g(int x, int y) { return f(x, y); }
3857  * int f(int a, int b) { return a + b; }
3858  * int f(int, int);
3859  * \endcode
3860  *
3861  * there are three declarations of the function "f", but only the
3862  * second one is a definition. The clang_getCursorDefinition()
3863  * function will take any cursor pointing to a declaration of "f"
3864  * (the first or fourth lines of the example) or a cursor referenced
3865  * that uses "f" (the call to "f' inside "g") and will return a
3866  * declaration cursor pointing to the definition (the second "f"
3867  * declaration).
3868  *
3869  * If given a cursor for which there is no corresponding definition,
3870  * e.g., because there is no definition of that entity within this
3871  * translation unit, returns a NULL cursor.
3872  */
3874 
3875 /**
3876  * \brief Determine whether the declaration pointed to by this cursor
3877  * is also a definition of that entity.
3878  */
3880 
3881 /**
3882  * \brief Retrieve the canonical cursor corresponding to the given cursor.
3883  *
3884  * In the C family of languages, many kinds of entities can be declared several
3885  * times within a single translation unit. For example, a structure type can
3886  * be forward-declared (possibly multiple times) and later defined:
3887  *
3888  * \code
3889  * struct X;
3890  * struct X;
3891  * struct X {
3892  * int member;
3893  * };
3894  * \endcode
3895  *
3896  * The declarations and the definition of \c X are represented by three
3897  * different cursors, all of which are declarations of the same underlying
3898  * entity. One of these cursor is considered the "canonical" cursor, which
3899  * is effectively the representative for the underlying entity. One can
3900  * determine if two cursors are declarations of the same underlying entity by
3901  * comparing their canonical cursors.
3902  *
3903  * \returns The canonical cursor for the entity referred to by the given cursor.
3904  */
3906 
3907 /**
3908  * \brief If the cursor points to a selector identifier in an Objective-C
3909  * method or message expression, this returns the selector index.
3910  *
3911  * After getting a cursor with #clang_getCursor, this can be called to
3912  * determine if the location points to a selector identifier.
3913  *
3914  * \returns The selector index if the cursor is an Objective-C method or message
3915  * expression and the cursor is pointing to a selector identifier, or -1
3916  * otherwise.
3917  */
3919 
3920 /**
3921  * \brief Given a cursor pointing to a C++ method call or an Objective-C
3922  * message, returns non-zero if the method/message is "dynamic", meaning:
3923  *
3924  * For a C++ method: the call is virtual.
3925  * For an Objective-C message: the receiver is an object instance, not 'super'
3926  * or a specific class.
3927  *
3928  * If the method/message is "static" or the cursor does not point to a
3929  * method/message, it will return zero.
3930  */
3932 
3933 /**
3934  * \brief Given a cursor pointing to an Objective-C message, returns the CXType
3935  * of the receiver.
3936  */
3938 
3939 /**
3940  * \brief Property attributes for a \c CXCursor_ObjCPropertyDecl.
3941  */
3942 typedef enum {
3958 
3959 /**
3960  * \brief Given a cursor that represents a property declaration, return the
3961  * associated property attributes. The bits are formed from
3962  * \c CXObjCPropertyAttrKind.
3963  *
3964  * \param reserved Reserved for future use, pass 0.
3965  */
3967  unsigned reserved);
3968 
3969 /**
3970  * \brief 'Qualifiers' written next to the return and parameter types in
3971  * Objective-C method declarations.
3972  */
3973 typedef enum {
3982 
3983 /**
3984  * \brief Given a cursor that represents an Objective-C method or parameter
3985  * declaration, return the associated Objective-C qualifiers for the return
3986  * type or the parameter respectively. The bits are formed from
3987  * CXObjCDeclQualifierKind.
3988  */
3990 
3991 /**
3992  * \brief Given a cursor that represents an Objective-C method or property
3993  * declaration, return non-zero if the declaration was affected by "@optional".
3994  * Returns zero if the cursor is not such a declaration or it is "@required".
3995  */
3997 
3998 /**
3999  * \brief Returns non-zero if the given cursor is a variadic function or method.
4000  */
4002 
4003 /**
4004  * \brief Given a cursor that represents a declaration, return the associated
4005  * comment's source range. The range may include multiple consecutive comments
4006  * with whitespace in between.
4007  */
4009 
4010 /**
4011  * \brief Given a cursor that represents a declaration, return the associated
4012  * comment text, including comment markers.
4013  */
4015 
4016 /**
4017  * \brief Given a cursor that represents a documentable entity (e.g.,
4018  * declaration), return the associated \\brief paragraph; otherwise return the
4019  * first paragraph.
4020  */
4022 
4023 /**
4024  * @}
4025  */
4026 
4027 /** \defgroup CINDEX_MANGLE Name Mangling API Functions
4028  *
4029  * @{
4030  */
4031 
4032 /**
4033  * \brief Retrieve the CXString representing the mangled name of the cursor.
4034  */
4036 
4037 /**
4038  * \brief Retrieve the CXStrings representing the mangled symbols of the C++
4039  * constructor or destructor at the cursor.
4040  */
4042 
4043 /**
4044  * @}
4045  */
4046 
4047 /**
4048  * \defgroup CINDEX_MODULE Module introspection
4049  *
4050  * The functions in this group provide access to information about modules.
4051  *
4052  * @{
4053  */
4054 
4055 typedef void *CXModule;
4056 
4057 /**
4058  * \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module.
4059  */
4061 
4062 /**
4063  * \brief Given a CXFile header file, return the module that contains it, if one
4064  * exists.
4065  */
4066 CINDEX_LINKAGE CXModule clang_getModuleForFile(CXTranslationUnit, CXFile);
4067 
4068 /**
4069  * \param Module a module object.
4070  *
4071  * \returns the module file where the provided module object came from.
4072  */
4073 CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module);
4074 
4075 /**
4076  * \param Module a module object.
4077  *
4078  * \returns the parent of a sub-module or NULL if the given module is top-level,
4079  * e.g. for 'std.vector' it will return the 'std' module.
4080  */
4081 CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module);
4082 
4083 /**
4084  * \param Module a module object.
4085  *
4086  * \returns the name of the module, e.g. for the 'std.vector' sub-module it
4087  * will return "vector".
4088  */
4090 
4091 /**
4092  * \param Module a module object.
4093  *
4094  * \returns the full name of the module, e.g. "std.vector".
4095  */
4097 
4098 /**
4099  * \param Module a module object.
4100  *
4101  * \returns non-zero if the module is a system one.
4102  */
4103 CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module);
4104 
4105 /**
4106  * \param Module a module object.
4107  *
4108  * \returns the number of top level headers associated with this module.
4109  */
4110 CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit,
4111  CXModule Module);
4112 
4113 /**
4114  * \param Module a module object.
4115  *
4116  * \param Index top level header index (zero-based).
4117  *
4118  * \returns the specified top level header associated with the module.
4119  */
4121 CXFile clang_Module_getTopLevelHeader(CXTranslationUnit,
4122  CXModule Module, unsigned Index);
4123 
4124 /**
4125  * @}
4126  */
4127 
4128 /**
4129  * \defgroup CINDEX_CPP C++ AST introspection
4130  *
4131  * The routines in this group provide access information in the ASTs specific
4132  * to C++ language features.
4133  *
4134  * @{
4135  */
4136 
4137 /**
4138  * \brief Determine if a C++ constructor is a converting constructor.
4139  */
4141 
4142 /**
4143  * \brief Determine if a C++ constructor is a copy constructor.
4144  */
4146 
4147 /**
4148  * \brief Determine if a C++ constructor is the default constructor.
4149  */
4151 
4152 /**
4153  * \brief Determine if a C++ constructor is a move constructor.
4154  */
4156 
4157 /**
4158  * \brief Determine if a C++ field is declared 'mutable'.
4159  */
4161 
4162 /**
4163  * \brief Determine if a C++ method is declared '= default'.
4164  */
4166 
4167 /**
4168  * \brief Determine if a C++ member function or member function template is
4169  * pure virtual.
4170  */
4172 
4173 /**
4174  * \brief Determine if a C++ member function or member function template is
4175  * declared 'static'.
4176  */
4178 
4179 /**
4180  * \brief Determine if a C++ member function or member function template is
4181  * explicitly declared 'virtual' or if it overrides a virtual method from
4182  * one of the base classes.
4183  */
4185 
4186 /**
4187  * \brief Determine if a C++ member function or member function template is
4188  * declared 'const'.
4189  */
4191 
4192 /**
4193  * \brief Given a cursor that represents a template, determine
4194  * the cursor kind of the specializations would be generated by instantiating
4195  * the template.
4196  *
4197  * This routine can be used to determine what flavor of function template,
4198  * class template, or class template partial specialization is stored in the
4199  * cursor. For example, it can describe whether a class template cursor is
4200  * declared with "struct", "class" or "union".
4201  *
4202  * \param C The cursor to query. This cursor should represent a template
4203  * declaration.
4204  *
4205  * \returns The cursor kind of the specializations that would be generated
4206  * by instantiating the template \p C. If \p C is not a template, returns
4207  * \c CXCursor_NoDeclFound.
4208  */
4210 
4211 /**
4212  * \brief Given a cursor that may represent a specialization or instantiation
4213  * of a template, retrieve the cursor that represents the template that it
4214  * specializes or from which it was instantiated.
4215  *
4216  * This routine determines the template involved both for explicit
4217  * specializations of templates and for implicit instantiations of the template,
4218  * both of which are referred to as "specializations". For a class template
4219  * specialization (e.g., \c std::vector<bool>), this routine will return
4220  * either the primary template (\c std::vector) or, if the specialization was
4221  * instantiated from a class template partial specialization, the class template
4222  * partial specialization. For a class template partial specialization and a
4223  * function template specialization (including instantiations), this
4224  * this routine will return the specialized template.
4225  *
4226  * For members of a class template (e.g., member functions, member classes, or
4227  * static data members), returns the specialized or instantiated member.
4228  * Although not strictly "templates" in the C++ language, members of class
4229  * templates have the same notions of specializations and instantiations that
4230  * templates do, so this routine treats them similarly.
4231  *
4232  * \param C A cursor that may be a specialization of a template or a member
4233  * of a template.
4234  *
4235  * \returns If the given cursor is a specialization or instantiation of a
4236  * template or a member thereof, the template or member that it specializes or
4237  * from which it was instantiated. Otherwise, returns a NULL cursor.
4238  */
4240 
4241 /**
4242  * \brief Given a cursor that references something else, return the source range
4243  * covering that reference.
4244  *
4245  * \param C A cursor pointing to a member reference, a declaration reference, or
4246  * an operator call.
4247  * \param NameFlags A bitset with three independent flags:
4248  * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
4249  * CXNameRange_WantSinglePiece.
4250  * \param PieceIndex For contiguous names or when passing the flag
4251  * CXNameRange_WantSinglePiece, only one piece with index 0 is
4252  * available. When the CXNameRange_WantSinglePiece flag is not passed for a
4253  * non-contiguous names, this index can be used to retrieve the individual
4254  * pieces of the name. See also CXNameRange_WantSinglePiece.
4255  *
4256  * \returns The piece of the name pointed to by the given cursor. If there is no
4257  * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
4258  */
4260  unsigned NameFlags,
4261  unsigned PieceIndex);
4262 
4264  /**
4265  * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
4266  * range.
4267  */
4269 
4270  /**
4271  * \brief Include the explicit template arguments, e.g. <int> in x.f<int>,
4272  * in the range.
4273  */
4275 
4276  /**
4277  * \brief If the name is non-contiguous, return the full spanning range.
4278  *
4279  * Non-contiguous names occur in Objective-C when a selector with two or more
4280  * parameters is used, or in C++ when using an operator:
4281  * \code
4282  * [object doSomething:here withValue:there]; // Objective-C
4283  * return some_vector[1]; // C++
4284  * \endcode
4285  */
4287 };
4288 
4289 /**
4290  * @}
4291  */
4292 
4293 /**
4294  * \defgroup CINDEX_LEX Token extraction and manipulation
4295  *
4296  * The routines in this group provide access to the tokens within a
4297  * translation unit, along with a semantic mapping of those tokens to
4298  * their corresponding cursors.
4299  *
4300  * @{
4301  */
4302 
4303 /**
4304  * \brief Describes a kind of token.
4305  */
4306 typedef enum CXTokenKind {
4307  /**
4308  * \brief A token that contains some kind of punctuation.
4309  */
4311 
4312  /**
4313  * \brief A language keyword.
4314  */
4316 
4317  /**
4318  * \brief An identifier (that is not a keyword).
4319  */
4321 
4322  /**
4323  * \brief A numeric, string, or character literal.
4324  */
4326 
4327  /**
4328  * \brief A comment.
4329  */
4331 } CXTokenKind;
4332 
4333 /**
4334  * \brief Describes a single preprocessing token.
4335  */
4336 typedef struct {
4337  unsigned int_data[4];
4338  void *ptr_data;
4339 } CXToken;
4340 
4341 /**
4342  * \brief Determine the kind of the given token.
4343  */
4345 
4346 /**
4347  * \brief Determine the spelling of the given token.
4348  *
4349  * The spelling of a token is the textual representation of that token, e.g.,
4350  * the text of an identifier or keyword.
4351  */
4353 
4354 /**
4355  * \brief Retrieve the source location of the given token.
4356  */
4358  CXToken);
4359 
4360 /**
4361  * \brief Retrieve a source range that covers the given token.
4362  */
4364 
4365 /**
4366  * \brief Tokenize the source code described by the given range into raw
4367  * lexical tokens.
4368  *
4369  * \param TU the translation unit whose text is being tokenized.
4370  *
4371  * \param Range the source range in which text should be tokenized. All of the
4372  * tokens produced by tokenization will fall within this source range,
4373  *
4374  * \param Tokens this pointer will be set to point to the array of tokens
4375  * that occur within the given source range. The returned pointer must be
4376  * freed with clang_disposeTokens() before the translation unit is destroyed.
4377  *
4378  * \param NumTokens will be set to the number of tokens in the \c *Tokens
4379  * array.
4380  *
4381  */
4382 CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
4383  CXToken **Tokens, unsigned *NumTokens);
4384 
4385 /**
4386  * \brief Annotate the given set of tokens by providing cursors for each token
4387  * that can be mapped to a specific entity within the abstract syntax tree.
4388  *
4389  * This token-annotation routine is equivalent to invoking
4390  * clang_getCursor() for the source locations of each of the
4391  * tokens. The cursors provided are filtered, so that only those
4392  * cursors that have a direct correspondence to the token are
4393  * accepted. For example, given a function call \c f(x),
4394  * clang_getCursor() would provide the following cursors:
4395  *
4396  * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
4397  * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
4398  * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
4399  *
4400  * Only the first and last of these cursors will occur within the
4401  * annotate, since the tokens "f" and "x' directly refer to a function
4402  * and a variable, respectively, but the parentheses are just a small
4403  * part of the full syntax of the function call expression, which is
4404  * not provided as an annotation.
4405  *
4406  * \param TU the translation unit that owns the given tokens.
4407  *
4408  * \param Tokens the set of tokens to annotate.
4409  *
4410  * \param NumTokens the number of tokens in \p Tokens.
4411  *
4412  * \param Cursors an array of \p NumTokens cursors, whose contents will be
4413  * replaced with the cursors corresponding to each token.
4414  */
4415 CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
4416  CXToken *Tokens, unsigned NumTokens,
4417  CXCursor *Cursors);
4418 
4419 /**
4420  * \brief Free the given set of tokens.
4421  */
4422 CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
4423  CXToken *Tokens, unsigned NumTokens);
4424 
4425 /**
4426  * @}
4427  */
4428 
4429 /**
4430  * \defgroup CINDEX_DEBUG Debugging facilities
4431  *
4432  * These routines are used for testing and debugging, only, and should not
4433  * be relied upon.
4434  *
4435  * @{
4436  */
4437 
4438 /* for debug/testing */
4441  const char **startBuf,
4442  const char **endBuf,
4443  unsigned *startLine,
4444  unsigned *startColumn,
4445  unsigned *endLine,
4446  unsigned *endColumn);
4448 CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
4449  unsigned stack_size);
4450 
4451 /**
4452  * @}
4453  */
4454 
4455 /**
4456  * \defgroup CINDEX_CODE_COMPLET Code completion
4457  *
4458  * Code completion involves taking an (incomplete) source file, along with
4459  * knowledge of where the user is actively editing that file, and suggesting
4460  * syntactically- and semantically-valid constructs that the user might want to
4461  * use at that particular point in the source code. These data structures and
4462  * routines provide support for code completion.
4463  *
4464  * @{
4465  */
4466 
4467 /**
4468  * \brief A semantic string that describes a code-completion result.
4469  *
4470  * A semantic string that describes the formatting of a code-completion
4471  * result as a single "template" of text that should be inserted into the
4472  * source buffer when a particular code-completion result is selected.
4473  * Each semantic string is made up of some number of "chunks", each of which
4474  * contains some text along with a description of what that text means, e.g.,
4475  * the name of the entity being referenced, whether the text chunk is part of
4476  * the template, or whether it is a "placeholder" that the user should replace
4477  * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
4478  * description of the different kinds of chunks.
4479  */
4480 typedef void *CXCompletionString;
4481 
4482 /**
4483  * \brief A single result of code completion.
4484  */
4485 typedef struct {
4486  /**
4487  * \brief The kind of entity that this completion refers to.
4488  *
4489  * The cursor kind will be a macro, keyword, or a declaration (one of the
4490  * *Decl cursor kinds), describing the entity that the completion is
4491  * referring to.
4492  *
4493  * \todo In the future, we would like to provide a full cursor, to allow
4494  * the client to extract additional information from declaration.
4495  */
4496  enum CXCursorKind CursorKind;
4497 
4498  /**
4499  * \brief The code-completion string that describes how to insert this
4500  * code-completion result into the editing buffer.
4501  */
4502  CXCompletionString CompletionString;
4504 
4505 /**
4506  * \brief Describes a single piece of text within a code-completion string.
4507  *
4508  * Each "chunk" within a code-completion string (\c CXCompletionString) is
4509  * either a piece of text with a specific "kind" that describes how that text
4510  * should be interpreted by the client or is another completion string.
4511  */
4513  /**
4514  * \brief A code-completion string that describes "optional" text that
4515  * could be a part of the template (but is not required).
4516  *
4517  * The Optional chunk is the only kind of chunk that has a code-completion
4518  * string for its representation, which is accessible via
4519  * \c clang_getCompletionChunkCompletionString(). The code-completion string
4520  * describes an additional part of the template that is completely optional.
4521  * For example, optional chunks can be used to describe the placeholders for
4522  * arguments that match up with defaulted function parameters, e.g. given:
4523  *
4524  * \code
4525  * void f(int x, float y = 3.14, double z = 2.71828);
4526  * \endcode
4527  *
4528  * The code-completion string for this function would contain:
4529  * - a TypedText chunk for "f".
4530  * - a LeftParen chunk for "(".
4531  * - a Placeholder chunk for "int x"
4532  * - an Optional chunk containing the remaining defaulted arguments, e.g.,
4533  * - a Comma chunk for ","
4534  * - a Placeholder chunk for "float y"
4535  * - an Optional chunk containing the last defaulted argument:
4536  * - a Comma chunk for ","
4537  * - a Placeholder chunk for "double z"
4538  * - a RightParen chunk for ")"
4539  *
4540  * There are many ways to handle Optional chunks. Two simple approaches are:
4541  * - Completely ignore optional chunks, in which case the template for the
4542  * function "f" would only include the first parameter ("int x").
4543  * - Fully expand all optional chunks, in which case the template for the
4544  * function "f" would have all of the parameters.
4545  */
4547  /**
4548  * \brief Text that a user would be expected to type to get this
4549  * code-completion result.
4550  *
4551  * There will be exactly one "typed text" chunk in a semantic string, which
4552  * will typically provide the spelling of a keyword or the name of a
4553  * declaration that could be used at the current code point. Clients are
4554  * expected to filter the code-completion results based on the text in this
4555  * chunk.
4556  */
4558  /**
4559  * \brief Text that should be inserted as part of a code-completion result.
4560  *
4561  * A "text" chunk represents text that is part of the template to be
4562  * inserted into user code should this particular code-completion result
4563  * be selected.
4564  */
4566  /**
4567  * \brief Placeholder text that should be replaced by the user.
4568  *
4569  * A "placeholder" chunk marks a place where the user should insert text
4570  * into the code-completion template. For example, placeholders might mark
4571  * the function parameters for a function declaration, to indicate that the
4572  * user should provide arguments for each of those parameters. The actual
4573  * text in a placeholder is a suggestion for the text to display before
4574  * the user replaces the placeholder with real code.
4575  */
4577  /**
4578  * \brief Informative text that should be displayed but never inserted as
4579  * part of the template.
4580  *
4581  * An "informative" chunk contains annotations that can be displayed to
4582  * help the user decide whether a particular code-completion result is the
4583  * right option, but which is not part of the actual template to be inserted
4584  * by code completion.
4585  */
4587  /**
4588  * \brief Text that describes the current parameter when code-completion is
4589  * referring to function call, message send, or template specialization.
4590  *
4591  * A "current parameter" chunk occurs when code-completion is providing
4592  * information about a parameter corresponding to the argument at the
4593  * code-completion point. For example, given a function
4594  *
4595  * \code
4596  * int add(int x, int y);
4597  * \endcode
4598  *
4599  * and the source code \c add(, where the code-completion point is after the
4600  * "(", the code-completion string will contain a "current parameter" chunk
4601  * for "int x", indicating that the current argument will initialize that
4602  * parameter. After typing further, to \c add(17, (where the code-completion
4603  * point is after the ","), the code-completion string will contain a
4604  * "current paremeter" chunk to "int y".
4605  */
4607  /**
4608  * \brief A left parenthesis ('('), used to initiate a function call or
4609  * signal the beginning of a function parameter list.
4610  */
4612  /**
4613  * \brief A right parenthesis (')'), used to finish a function call or
4614  * signal the end of a function parameter list.
4615  */
4617  /**
4618  * \brief A left bracket ('[').
4619  */
4621  /**
4622  * \brief A right bracket (']').
4623  */
4625  /**
4626  * \brief A left brace ('{').
4627  */
4629  /**
4630  * \brief A right brace ('}').
4631  */
4633  /**
4634  * \brief A left angle bracket ('<').
4635  */
4637  /**
4638  * \brief A right angle bracket ('>').
4639  */
4641  /**
4642  * \brief A comma separator (',').
4643  */
4645  /**
4646  * \brief Text that specifies the result type of a given result.
4647  *
4648  * This special kind of informative chunk is not meant to be inserted into
4649  * the text buffer. Rather, it is meant to illustrate the type that an
4650  * expression using the given completion string would have.
4651  */
4653  /**
4654  * \brief A colon (':').
4655  */
4657  /**
4658  * \brief A semicolon (';').
4659  */
4661  /**
4662  * \brief An '=' sign.
4663  */
4665  /**
4666  * Horizontal space (' ').
4667  */
4669  /**
4670  * Vertical space ('\n'), after which it is generally a good idea to
4671  * perform indentation.
4672  */
4674 };
4675 
4676 /**
4677  * \brief Determine the kind of a particular chunk within a completion string.
4678  *
4679  * \param completion_string the completion string to query.
4680  *
4681  * \param chunk_number the 0-based index of the chunk in the completion string.
4682  *
4683  * \returns the kind of the chunk at the index \c chunk_number.
4684  */
4686 clang_getCompletionChunkKind(CXCompletionString completion_string,
4687  unsigned chunk_number);
4688 
4689 /**
4690  * \brief Retrieve the text associated with a particular chunk within a
4691  * completion string.
4692  *
4693  * \param completion_string the completion string to query.
4694  *
4695  * \param chunk_number the 0-based index of the chunk in the completion string.
4696  *
4697  * \returns the text associated with the chunk at index \c chunk_number.
4698  */
4700 clang_getCompletionChunkText(CXCompletionString completion_string,
4701  unsigned chunk_number);
4702 
4703 /**
4704  * \brief Retrieve the completion string associated with a particular chunk
4705  * within a completion string.
4706  *
4707  * \param completion_string the completion string to query.
4708  *
4709  * \param chunk_number the 0-based index of the chunk in the completion string.
4710  *
4711  * \returns the completion string associated with the chunk at index
4712  * \c chunk_number.
4713  */
4714 CINDEX_LINKAGE CXCompletionString
4715 clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
4716  unsigned chunk_number);
4717 
4718 /**
4719  * \brief Retrieve the number of chunks in the given code-completion string.
4720  */
4721 CINDEX_LINKAGE unsigned
4722 clang_getNumCompletionChunks(CXCompletionString completion_string);
4723 
4724 /**
4725  * \brief Determine the priority of this code completion.
4726  *
4727  * The priority of a code completion indicates how likely it is that this
4728  * particular completion is the completion that the user will select. The
4729  * priority is selected by various internal heuristics.
4730  *
4731  * \param completion_string The completion string to query.
4732  *
4733  * \returns The priority of this completion string. Smaller values indicate
4734  * higher-priority (more likely) completions.
4735  */
4736 CINDEX_LINKAGE unsigned
4737 clang_getCompletionPriority(CXCompletionString completion_string);
4738 
4739 /**
4740  * \brief Determine the availability of the entity that this code-completion
4741  * string refers to.
4742  *
4743  * \param completion_string The completion string to query.
4744  *
4745  * \returns The availability of the completion string.
4746  */
4748 clang_getCompletionAvailability(CXCompletionString completion_string);
4749 
4750 /**
4751  * \brief Retrieve the number of annotations associated with the given
4752  * completion string.
4753  *
4754  * \param completion_string the completion string to query.
4755  *
4756  * \returns the number of annotations associated with the given completion
4757  * string.
4758  */
4759 CINDEX_LINKAGE unsigned
4760 clang_getCompletionNumAnnotations(CXCompletionString completion_string);
4761 
4762 /**
4763  * \brief Retrieve the annotation associated with the given completion string.
4764  *
4765  * \param completion_string the completion string to query.
4766  *
4767  * \param annotation_number the 0-based index of the annotation of the
4768  * completion string.
4769  *
4770  * \returns annotation string associated with the completion at index
4771  * \c annotation_number, or a NULL string if that annotation is not available.
4772  */
4774 clang_getCompletionAnnotation(CXCompletionString completion_string,
4775  unsigned annotation_number);
4776 
4777 /**
4778  * \brief Retrieve the parent context of the given completion string.
4779  *
4780  * The parent context of a completion string is the semantic parent of
4781  * the declaration (if any) that the code completion represents. For example,
4782  * a code completion for an Objective-C method would have the method's class
4783  * or protocol as its context.
4784  *
4785  * \param completion_string The code completion string whose parent is
4786  * being queried.
4787  *
4788  * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
4789  *
4790  * \returns The name of the completion parent, e.g., "NSObject" if
4791  * the completion string represents a method in the NSObject class.
4792  */
4794 clang_getCompletionParent(CXCompletionString completion_string,
4795  enum CXCursorKind *kind);
4796 
4797 /**
4798  * \brief Retrieve the brief documentation comment attached to the declaration
4799  * that corresponds to the given completion string.
4800  */
4802 clang_getCompletionBriefComment(CXCompletionString completion_string);
4803 
4804 /**
4805  * \brief Retrieve a completion string for an arbitrary declaration or macro
4806  * definition cursor.
4807  *
4808  * \param cursor The cursor to query.
4809  *
4810  * \returns A non-context-sensitive completion string for declaration and macro
4811  * definition cursors, or NULL for other kinds of cursors.
4812  */
4813 CINDEX_LINKAGE CXCompletionString
4815 
4816 /**
4817  * \brief Contains the results of code-completion.
4818  *
4819  * This data structure contains the results of code completion, as
4820  * produced by \c clang_codeCompleteAt(). Its contents must be freed by
4821  * \c clang_disposeCodeCompleteResults.
4822  */
4823 typedef struct {
4824  /**
4825  * \brief The code-completion results.
4826  */
4828 
4829  /**
4830  * \brief The number of code-completion results stored in the
4831  * \c Results array.
4832  */
4833  unsigned NumResults;
4835 
4836 /**
4837  * \brief Flags that can be passed to \c clang_codeCompleteAt() to
4838  * modify its behavior.
4839  *
4840  * The enumerators in this enumeration can be bitwise-OR'd together to
4841  * provide multiple options to \c clang_codeCompleteAt().
4842  */
4844  /**
4845  * \brief Whether to include macros within the set of code
4846  * completions returned.
4847  */
4849 
4850  /**
4851  * \brief Whether to include code patterns for language constructs
4852  * within the set of code completions, e.g., for loops.
4853  */
4855 
4856  /**
4857  * \brief Whether to include brief documentation within the set of code
4858  * completions returned.
4859  */
4861 };
4862 
4863 /**
4864  * \brief Bits that represent the context under which completion is occurring.
4865  *
4866  * The enumerators in this enumeration may be bitwise-OR'd together if multiple
4867  * contexts are occurring simultaneously.
4868  */
4870  /**
4871  * \brief The context for completions is unexposed, as only Clang results
4872  * should be included. (This is equivalent to having no context bits set.)
4873  */
4875 
4876  /**
4877  * \brief Completions for any possible type should be included in the results.
4878  */
4880 
4881  /**
4882  * \brief Completions for any possible value (variables, function calls, etc.)
4883  * should be included in the results.
4884  */
4886  /**
4887  * \brief Completions for values that resolve to an Objective-C object should
4888  * be included in the results.
4889  */
4891  /**
4892  * \brief Completions for values that resolve to an Objective-C selector
4893  * should be included in the results.
4894  */
4896  /**
4897  * \brief Completions for values that resolve to a C++ class type should be
4898  * included in the results.
4899  */
4901 
4902  /**
4903  * \brief Completions for fields of the member being accessed using the dot
4904  * operator should be included in the results.
4905  */
4907  /**
4908  * \brief Completions for fields of the member being accessed using the arrow
4909  * operator should be included in the results.
4910  */
4912  /**
4913  * \brief Completions for properties of the Objective-C object being accessed
4914  * using the dot operator should be included in the results.
4915  */
4917 
4918  /**
4919  * \brief Completions for enum tags should be included in the results.
4920  */
4922  /**
4923  * \brief Completions for union tags should be included in the results.
4924  */
4926  /**
4927  * \brief Completions for struct tags should be included in the results.
4928  */
4930 
4931  /**
4932  * \brief Completions for C++ class names should be included in the results.
4933  */
4935  /**
4936  * \brief Completions for C++ namespaces and namespace aliases should be
4937  * included in the results.
4938  */
4940  /**
4941  * \brief Completions for C++ nested name specifiers should be included in
4942  * the results.
4943  */
4945 
4946  /**
4947  * \brief Completions for Objective-C interfaces (classes) should be included
4948  * in the results.
4949  */
4951  /**
4952  * \brief Completions for Objective-C protocols should be included in
4953  * the results.
4954  */
4956  /**
4957  * \brief Completions for Objective-C categories should be included in
4958  * the results.
4959  */
4961  /**
4962  * \brief Completions for Objective-C instance messages should be included
4963  * in the results.
4964  */
4966  /**
4967  * \brief Completions for Objective-C class messages should be included in
4968  * the results.
4969  */
4971  /**
4972  * \brief Completions for Objective-C selector names should be included in
4973  * the results.
4974  */
4976 
4977  /**
4978  * \brief Completions for preprocessor macro names should be included in
4979  * the results.
4980  */
4982 
4983  /**
4984  * \brief Natural language completions should be included in the results.
4985  */
4987 
4988  /**
4989  * \brief The current context is unknown, so set all contexts.
4990  */
4992 };
4993 
4994 /**
4995  * \brief Returns a default set of code-completion options that can be
4996  * passed to\c clang_codeCompleteAt().
4997  */
4999 
5000 /**
5001  * \brief Perform code completion at a given location in a translation unit.
5002  *
5003  * This function performs code completion at a particular file, line, and
5004  * column within source code, providing results that suggest potential
5005  * code snippets based on the context of the completion. The basic model
5006  * for code completion is that Clang will parse a complete source file,
5007  * performing syntax checking up to the location where code-completion has
5008  * been requested. At that point, a special code-completion token is passed
5009  * to the parser, which recognizes this token and determines, based on the
5010  * current location in the C/Objective-C/C++ grammar and the state of
5011  * semantic analysis, what completions to provide. These completions are
5012  * returned via a new \c CXCodeCompleteResults structure.
5013  *
5014  * Code completion itself is meant to be triggered by the client when the
5015  * user types punctuation characters or whitespace, at which point the
5016  * code-completion location will coincide with the cursor. For example, if \c p
5017  * is a pointer, code-completion might be triggered after the "-" and then
5018  * after the ">" in \c p->. When the code-completion location is afer the ">",
5019  * the completion results will provide, e.g., the members of the struct that
5020  * "p" points to. The client is responsible for placing the cursor at the
5021  * beginning of the token currently being typed, then filtering the results
5022  * based on the contents of the token. For example, when code-completing for
5023  * the expression \c p->get, the client should provide the location just after
5024  * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
5025  * client can filter the results based on the current token text ("get"), only
5026  * showing those results that start with "get". The intent of this interface
5027  * is to separate the relatively high-latency acquisition of code-completion
5028  * results from the filtering of results on a per-character basis, which must
5029  * have a lower latency.
5030  *
5031  * \param TU The translation unit in which code-completion should
5032  * occur. The source files for this translation unit need not be
5033  * completely up-to-date (and the contents of those source files may
5034  * be overridden via \p unsaved_files). Cursors referring into the
5035  * translation unit may be invalidated by this invocation.
5036  *
5037  * \param complete_filename The name of the source file where code
5038  * completion should be performed. This filename may be any file
5039  * included in the translation unit.
5040  *
5041  * \param complete_line The line at which code-completion should occur.
5042  *
5043  * \param complete_column The column at which code-completion should occur.
5044  * Note that the column should point just after the syntactic construct that
5045  * initiated code completion, and not in the middle of a lexical token.
5046  *
5047  * \param unsaved_files the Files that have not yet been saved to disk
5048  * but may be required for parsing or code completion, including the
5049  * contents of those files. The contents and name of these files (as
5050  * specified by CXUnsavedFile) are copied when necessary, so the
5051  * client only needs to guarantee their validity until the call to
5052  * this function returns.
5053  *
5054  * \param num_unsaved_files The number of unsaved file entries in \p
5055  * unsaved_files.
5056  *
5057  * \param options Extra options that control the behavior of code
5058  * completion, expressed as a bitwise OR of the enumerators of the
5059  * CXCodeComplete_Flags enumeration. The
5060  * \c clang_defaultCodeCompleteOptions() function returns a default set
5061  * of code-completion options.
5062  *
5063  * \returns If successful, a new \c CXCodeCompleteResults structure
5064  * containing code-completion results, which should eventually be
5065  * freed with \c clang_disposeCodeCompleteResults(). If code
5066  * completion fails, returns NULL.
5067  */
5069 CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
5070  const char *complete_filename,
5071  unsigned complete_line,
5072  unsigned complete_column,
5073  struct CXUnsavedFile *unsaved_files,
5074  unsigned num_unsaved_files,
5075  unsigned options);
5076 
5077 /**
5078  * \brief Sort the code-completion results in case-insensitive alphabetical
5079  * order.
5080  *
5081  * \param Results The set of results to sort.
5082  * \param NumResults The number of results in \p Results.
5083  */
5086  unsigned NumResults);
5087 
5088 /**
5089  * \brief Free the given set of code-completion results.
5090  */
5093 
5094 /**
5095  * \brief Determine the number of diagnostics produced prior to the
5096  * location where code completion was performed.
5097  */
5100 
5101 /**
5102  * \brief Retrieve a diagnostic associated with the given code completion.
5103  *
5104  * \param Results the code completion results to query.
5105  * \param Index the zero-based diagnostic number to retrieve.
5106  *
5107  * \returns the requested diagnostic. This diagnostic must be freed
5108  * via a call to \c clang_disposeDiagnostic().
5109  */
5112  unsigned Index);
5113 
5114 /**
5115  * \brief Determines what completions are appropriate for the context
5116  * the given code completion.
5117  *
5118  * \param Results the code completion results to query
5119  *
5120  * \returns the kinds of completions that are appropriate for use
5121  * along with the given code completion results.
5122  */
5124 unsigned long long clang_codeCompleteGetContexts(
5125  CXCodeCompleteResults *Results);
5126 
5127 /**
5128  * \brief Returns the cursor kind for the container for the current code
5129  * completion context. The container is only guaranteed to be set for
5130  * contexts where a container exists (i.e. member accesses or Objective-C
5131  * message sends); if there is not a container, this function will return
5132  * CXCursor_InvalidCode.
5133  *
5134  * \param Results the code completion results to query
5135  *
5136  * \param IsIncomplete on return, this value will be false if Clang has complete
5137  * information about the container. If Clang does not have complete
5138  * information, this value will be true.
5139  *
5140  * \returns the container kind, or CXCursor_InvalidCode if there is not a
5141  * container
5142  */
5145  CXCodeCompleteResults *Results,
5146  unsigned *IsIncomplete);
5147 
5148 /**
5149  * \brief Returns the USR for the container for the current code completion
5150  * context. If there is not a container for the current context, this
5151  * function will return the empty string.
5152  *
5153  * \param Results the code completion results to query
5154  *
5155  * \returns the USR for the container
5156  */
5159 
5160 /**
5161  * \brief Returns the currently-entered selector for an Objective-C message
5162  * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
5163  * non-empty string for CXCompletionContext_ObjCInstanceMessage and
5164  * CXCompletionContext_ObjCClassMessage.
5165  *
5166  * \param Results the code completion results to query
5167  *
5168  * \returns the selector (or partial selector) that has been entered thus far
5169  * for an Objective-C message send.
5170  */
5173 
5174 /**
5175  * @}
5176  */
5177 
5178 /**
5179  * \defgroup CINDEX_MISC Miscellaneous utility functions
5180  *
5181  * @{
5182  */
5183 
5184 /**
5185  * \brief Return a version string, suitable for showing to a user, but not
5186  * intended to be parsed (the format is not guaranteed to be stable).
5187  */
5189 
5190 /**
5191  * \brief Enable/disable crash recovery.
5192  *
5193  * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero
5194  * value enables crash recovery, while 0 disables it.
5195  */
5197 
5198  /**
5199  * \brief Visitor invoked for each file in a translation unit
5200  * (used with clang_getInclusions()).
5201  *
5202  * This visitor function will be invoked by clang_getInclusions() for each
5203  * file included (either at the top-level or by \#include directives) within
5204  * a translation unit. The first argument is the file being included, and
5205  * the second and third arguments provide the inclusion stack. The
5206  * array is sorted in order of immediate inclusion. For example,
5207  * the first element refers to the location that included 'included_file'.
5208  */
5209 typedef void (*CXInclusionVisitor)(CXFile included_file,
5210  CXSourceLocation* inclusion_stack,
5211  unsigned include_len,
5212  CXClientData client_data);
5213 
5214 /**
5215  * \brief Visit the set of preprocessor inclusions in a translation unit.
5216  * The visitor function is called with the provided data for every included
5217  * file. This does not include headers included by the PCH file (unless one
5218  * is inspecting the inclusions in the PCH file itself).
5219  */
5220 CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
5221  CXInclusionVisitor visitor,
5222  CXClientData client_data);
5223 
5224 typedef enum {
5231 
5233 
5234 } CXEvalResultKind ;
5235 
5236 /**
5237  * \brief Evaluation result of a cursor
5238  */
5239 typedef void * CXEvalResult;
5240 
5241 /**
5242  * \brief If cursor is a statement declaration tries to evaluate the
5243  * statement and if its variable, tries to evaluate its initializer,
5244  * into its corresponding type.
5245  */
5247 
5248 /**
5249  * \brief Returns the kind of the evaluated result.
5250  */
5252 
5253 /**
5254  * \brief Returns the evaluation result as integer if the
5255  * kind is Int.
5256  */
5257 CINDEX_LINKAGE int clang_EvalResult_getAsInt(CXEvalResult E);
5258 
5259 /**
5260  * \brief Returns the evaluation result as double if the
5261  * kind is double.
5262  */
5263 CINDEX_LINKAGE double clang_EvalResult_getAsDouble(CXEvalResult E);
5264 
5265 /**
5266  * \brief Returns the evaluation result as a constant string if the
5267  * kind is other than Int or float. User must not free this pointer,
5268  * instead call clang_EvalResult_dispose on the CXEvalResult returned
5269  * by clang_Cursor_Evaluate.
5270  */
5271 CINDEX_LINKAGE const char* clang_EvalResult_getAsStr(CXEvalResult E);
5272 
5273 /**
5274  * \brief Disposes the created Eval memory.
5275  */
5276 CINDEX_LINKAGE void clang_EvalResult_dispose(CXEvalResult E);
5277 /**
5278  * @}
5279  */
5280 
5281 /** \defgroup CINDEX_REMAPPING Remapping functions
5282  *
5283  * @{
5284  */
5285 
5286 /**
5287  * \brief A remapping of original source files and their translated files.
5288  */
5289 typedef void *CXRemapping;
5290 
5291 /**
5292  * \brief Retrieve a remapping.
5293  *
5294  * \param path the path that contains metadata about remappings.
5295  *
5296  * \returns the requested remapping. This remapping must be freed
5297  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5298  */
5299 CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
5300 
5301 /**
5302  * \brief Retrieve a remapping.
5303  *
5304  * \param filePaths pointer to an array of file paths containing remapping info.
5305  *
5306  * \param numFiles number of file paths.
5307  *
5308  * \returns the requested remapping. This remapping must be freed
5309  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5310  */
5312 CXRemapping clang_getRemappingsFromFileList(const char **filePaths,
5313  unsigned numFiles);
5314 
5315 /**
5316  * \brief Determine the number of remappings.
5317  */
5318 CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
5319 
5320 /**
5321  * \brief Get the original and the associated filename from the remapping.
5322  *
5323  * \param original If non-NULL, will be set to the original filename.
5324  *
5325  * \param transformed If non-NULL, will be set to the filename that the original
5326  * is associated with.
5327  */
5328 CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
5329  CXString *original, CXString *transformed);
5330 
5331 /**
5332  * \brief Dispose the remapping.
5333  */
5334 CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
5335 
5336 /**
5337  * @}
5338  */
5339 
5340 /** \defgroup CINDEX_HIGH Higher level API functions
5341  *
5342  * @{
5343  */
5344 
5348 };
5349 
5350 typedef struct CXCursorAndRangeVisitor {
5351  void *context;
5352  enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
5354 
5355 typedef enum {
5356  /**
5357  * \brief Function returned successfully.
5358  */
5360  /**
5361  * \brief One of the parameters was invalid for the function.
5362  */
5364  /**
5365  * \brief The function was terminated by a callback (e.g. it returned
5366  * CXVisit_Break)
5367  */
5369 
5370 } CXResult;
5371 
5372 /**
5373  * \brief Find references of a declaration in a specific file.
5374  *
5375  * \param cursor pointing to a declaration or a reference of one.
5376  *
5377  * \param file to search for references.
5378  *
5379  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5380  * each reference found.
5381  * The CXSourceRange will point inside the file; if the reference is inside
5382  * a macro (and not a macro argument) the CXSourceRange will be invalid.
5383  *
5384  * \returns one of the CXResult enumerators.
5385  */
5387  CXCursorAndRangeVisitor visitor);
5388 
5389 /**
5390  * \brief Find #import/#include directives in a specific file.
5391  *
5392  * \param TU translation unit containing the file to query.
5393  *
5394  * \param file to search for #import/#include directives.
5395  *
5396  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5397  * each directive found.
5398  *
5399  * \returns one of the CXResult enumerators.
5400  */
5401 CINDEX_LINKAGE CXResult clang_findIncludesInFile(CXTranslationUnit TU,
5402  CXFile file,
5403  CXCursorAndRangeVisitor visitor);
5404 
5405 #ifdef __has_feature
5406 # if __has_feature(blocks)
5407 
5408 typedef enum CXVisitorResult
5409  (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange);
5410 
5412 CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile,
5413  CXCursorAndRangeVisitorBlock);
5414 
5416 CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile,
5417  CXCursorAndRangeVisitorBlock);
5418 
5419 # endif
5420 #endif
5421 
5422 /**
5423  * \brief The client's data object that is associated with a CXFile.
5424  */
5425 typedef void *CXIdxClientFile;
5426 
5427 /**
5428  * \brief The client's data object that is associated with a semantic entity.
5429  */
5430 typedef void *CXIdxClientEntity;
5431 
5432 /**
5433  * \brief The client's data object that is associated with a semantic container
5434  * of entities.
5435  */
5436 typedef void *CXIdxClientContainer;
5437 
5438 /**
5439  * \brief The client's data object that is associated with an AST file (PCH
5440  * or module).
5441  */
5442 typedef void *CXIdxClientASTFile;
5443 
5444 /**
5445  * \brief Source location passed to index callbacks.
5446  */
5447 typedef struct {
5448  void *ptr_data[2];
5449  unsigned int_data;
5450 } CXIdxLoc;
5451 
5452 /**
5453  * \brief Data for ppIncludedFile callback.
5454  */
5455 typedef struct {
5456  /**
5457  * \brief Location of '#' in the \#include/\#import directive.
5458  */
5460  /**
5461  * \brief Filename as written in the \#include/\#import directive.
5462  */
5463  const char *filename;
5464  /**
5465  * \brief The actual file that the \#include/\#import directive resolved to.
5466  */
5467  CXFile file;
5470  /**
5471  * \brief Non-zero if the directive was automatically turned into a module
5472  * import.
5473  */
5476 
5477 /**
5478  * \brief Data for IndexerCallbacks#importedASTFile.
5479  */
5480 typedef struct {
5481  /**
5482  * \brief Top level AST file containing the imported PCH, module or submodule.
5483  */
5484  CXFile file;
5485  /**
5486  * \brief The imported module or NULL if the AST file is a PCH.
5487  */
5488  CXModule module;
5489  /**
5490  * \brief Location where the file is imported. Applicable only for modules.
5491  */
5493  /**
5494  * \brief Non-zero if an inclusion directive was automatically turned into
5495  * a module import. Applicable only for modules.
5496  */
5498 
5500 
5501 typedef enum {
5508 
5512 
5517 
5521 
5533 
5534 } CXIdxEntityKind;
5535 
5536 typedef enum {
5542 
5543 /**
5544  * \brief Extra C++ template information for an entity. This can apply to:
5545  * CXIdxEntity_Function
5546  * CXIdxEntity_CXXClass
5547  * CXIdxEntity_CXXStaticMethod
5548  * CXIdxEntity_CXXInstanceMethod
5549  * CXIdxEntity_CXXConstructor
5550  * CXIdxEntity_CXXConversionFunction
5551  * CXIdxEntity_CXXTypeAlias
5552  */
5553 typedef enum {
5559 
5560 typedef enum {
5565 } CXIdxAttrKind;
5566 
5567 typedef struct {
5569  CXCursor cursor;
5571 } CXIdxAttrInfo;
5572 
5573 typedef struct {
5577  const char *name;
5578  const char *USR;
5579  CXCursor cursor;
5580  const CXIdxAttrInfo *const *attributes;
5581  unsigned numAttributes;
5582 } CXIdxEntityInfo;
5583 
5584 typedef struct {
5585  CXCursor cursor;
5587 
5588 typedef struct {
5591  CXCursor classCursor;
5594 
5595 typedef enum {
5598 
5599 typedef struct {
5601  CXCursor cursor;
5604  /**
5605  * \brief Generally same as #semanticContainer but can be different in
5606  * cases like out-of-line C++ member functions.
5607  */
5613  /**
5614  * \brief Whether the declaration exists in code or was created implicitly
5615  * by the compiler, e.g. implicit Objective-C methods for properties.
5616  */
5618  const CXIdxAttrInfo *const *attributes;
5619  unsigned numAttributes;
5620 
5621  unsigned flags;
5622 
5623 } CXIdxDeclInfo;
5624 
5625 typedef enum {
5630 
5631 typedef struct {
5635 
5636 typedef struct {
5638  CXCursor cursor;
5641 
5642 typedef struct {
5644  CXCursor cursor;
5647 
5648 typedef struct {
5650  unsigned numProtocols;
5652 
5653 typedef struct {
5658 
5659 typedef struct {
5662  CXCursor classCursor;
5666 
5667 typedef struct {
5672 
5673 typedef struct {
5675  const CXIdxBaseClassInfo *const *bases;
5676  unsigned numBases;
5678 
5679 /**
5680  * \brief Data for IndexerCallbacks#indexEntityReference.
5681  */
5682 typedef enum {
5683  /**
5684  * \brief The entity is referenced directly in user's code.
5685  */
5687  /**
5688  * \brief An implicit reference, e.g. a reference of an Objective-C method</