clang  6.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 interface 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 43
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 An opaque type representing target information for a given translation
85  * unit.
86  */
87 typedef struct CXTargetInfoImpl *CXTargetInfo;
88 
89 /**
90  * \brief A single translation unit, which resides in an index.
91  */
92 typedef struct CXTranslationUnitImpl *CXTranslationUnit;
93 
94 /**
95  * \brief Opaque pointer representing client data that will be passed through
96  * to various callbacks and visitors.
97  */
98 typedef void *CXClientData;
99 
100 /**
101  * \brief Provides the contents of a file that has not yet been saved to disk.
102  *
103  * Each CXUnsavedFile instance provides the name of a file on the
104  * system along with the current contents of that file that have not
105  * yet been saved to disk.
106  */
108  /**
109  * \brief The file whose contents have not yet been saved.
110  *
111  * This file must already exist in the file system.
112  */
113  const char *Filename;
114 
115  /**
116  * \brief A buffer containing the unsaved contents of this file.
117  */
118  const char *Contents;
119 
120  /**
121  * \brief The length of the unsaved contents of this buffer.
122  */
123  unsigned long Length;
124 };
125 
126 /**
127  * \brief Describes the availability of a particular entity, which indicates
128  * whether the use of this entity will result in a warning or error due to
129  * it being deprecated or unavailable.
130  */
132  /**
133  * \brief The entity is available.
134  */
136  /**
137  * \brief The entity is available, but has been deprecated (and its use is
138  * not recommended).
139  */
141  /**
142  * \brief The entity is not available; any use of it will be an error.
143  */
145  /**
146  * \brief The entity is available, but not accessible; any use of it will be
147  * an error.
148  */
150 };
151 
152 /**
153  * \brief Describes a version number of the form major.minor.subminor.
154  */
155 typedef struct CXVersion {
156  /**
157  * \brief The major version number, e.g., the '10' in '10.7.3'. A negative
158  * value indicates that there is no version number at all.
159  */
160  int Major;
161  /**
162  * \brief The minor version number, e.g., the '7' in '10.7.3'. This value
163  * will be negative if no minor version number was provided, e.g., for
164  * version '10'.
165  */
166  int Minor;
167  /**
168  * \brief The subminor version number, e.g., the '3' in '10.7.3'. This value
169  * will be negative if no minor or subminor version number was provided,
170  * e.g., in version '10' or '10.7'.
171  */
172  int Subminor;
173 } CXVersion;
174 
175 /**
176  * \brief Describes the exception specification of a cursor.
177  *
178  * A negative value indicates that the cursor is not a function declaration.
179  */
181 
182  /**
183  * \brief The cursor has no exception specification.
184  */
186 
187  /**
188  * \brief The cursor has exception specification throw()
189  */
191 
192  /**
193  * \brief The cursor has exception specification throw(T1, T2)
194  */
196 
197  /**
198  * \brief The cursor has exception specification throw(...).
199  */
201 
202  /**
203  * \brief The cursor has exception specification basic noexcept.
204  */
206 
207  /**
208  * \brief The cursor has exception specification computed noexcept.
209  */
211 
212  /**
213  * \brief The exception specification has not yet been evaluated.
214  */
216 
217  /**
218  * \brief The exception specification has not yet been instantiated.
219  */
221 
222  /**
223  * \brief The exception specification has not been parsed yet.
224  */
226 };
227 
228 /**
229  * \brief Provides a shared context for creating translation units.
230  *
231  * It provides two options:
232  *
233  * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local"
234  * declarations (when loading any new translation units). A "local" declaration
235  * is one that belongs in the translation unit itself and not in a precompiled
236  * header that was used by the translation unit. If zero, all declarations
237  * will be enumerated.
238  *
239  * Here is an example:
240  *
241  * \code
242  * // excludeDeclsFromPCH = 1, displayDiagnostics=1
243  * Idx = clang_createIndex(1, 1);
244  *
245  * // IndexTest.pch was produced with the following command:
246  * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch"
247  * TU = clang_createTranslationUnit(Idx, "IndexTest.pch");
248  *
249  * // This will load all the symbols from 'IndexTest.pch'
250  * clang_visitChildren(clang_getTranslationUnitCursor(TU),
251  * TranslationUnitVisitor, 0);
252  * clang_disposeTranslationUnit(TU);
253  *
254  * // This will load all the symbols from 'IndexTest.c', excluding symbols
255  * // from 'IndexTest.pch'.
256  * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" };
257  * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args,
258  * 0, 0);
259  * clang_visitChildren(clang_getTranslationUnitCursor(TU),
260  * TranslationUnitVisitor, 0);
261  * clang_disposeTranslationUnit(TU);
262  * \endcode
263  *
264  * This process of creating the 'pch', loading it separately, and using it (via
265  * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks
266  * (which gives the indexer the same performance benefit as the compiler).
267  */
268 CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
269  int displayDiagnostics);
270 
271 /**
272  * \brief Destroy the given index.
273  *
274  * The index must not be destroyed until all of the translation units created
275  * within that index have been destroyed.
276  */
277 CINDEX_LINKAGE void clang_disposeIndex(CXIndex index);
278 
279 typedef enum {
280  /**
281  * \brief Used to indicate that no special CXIndex options are needed.
282  */
284 
285  /**
286  * \brief Used to indicate that threads that libclang creates for indexing
287  * purposes should use background priority.
288  *
289  * Affects #clang_indexSourceFile, #clang_indexTranslationUnit,
290  * #clang_parseTranslationUnit, #clang_saveTranslationUnit.
291  */
293 
294  /**
295  * \brief Used to indicate that threads that libclang creates for editing
296  * purposes should use background priority.
297  *
298  * Affects #clang_reparseTranslationUnit, #clang_codeCompleteAt,
299  * #clang_annotateTokens
300  */
302 
303  /**
304  * \brief Used to indicate that all threads that libclang creates should use
305  * background priority.
306  */
310 
312 
313 /**
314  * \brief Sets general options associated with a CXIndex.
315  *
316  * For example:
317  * \code
318  * CXIndex idx = ...;
319  * clang_CXIndex_setGlobalOptions(idx,
320  * clang_CXIndex_getGlobalOptions(idx) |
321  * CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
322  * \endcode
323  *
324  * \param options A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags.
325  */
326 CINDEX_LINKAGE void clang_CXIndex_setGlobalOptions(CXIndex, unsigned options);
327 
328 /**
329  * \brief Gets the general options associated with a CXIndex.
330  *
331  * \returns A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags that
332  * are associated with the given CXIndex object.
333  */
335 
336 /**
337  * \defgroup CINDEX_FILES File manipulation routines
338  *
339  * @{
340  */
341 
342 /**
343  * \brief A particular source file that is part of a translation unit.
344  */
345 typedef void *CXFile;
346 
347 /**
348  * \brief Retrieve the complete file and path name of the given file.
349  */
351 
352 /**
353  * \brief Retrieve the last modification time of the given file.
354  */
355 CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile);
356 
357 /**
358  * \brief Uniquely identifies a CXFile, that refers to the same underlying file,
359  * across an indexing session.
360  */
361 typedef struct {
362  unsigned long long data[3];
364 
365 /**
366  * \brief Retrieve the unique ID for the given \c file.
367  *
368  * \param file the file to get the ID for.
369  * \param outID stores the returned CXFileUniqueID.
370  * \returns If there was a failure getting the unique ID, returns non-zero,
371  * otherwise returns 0.
372 */
373 CINDEX_LINKAGE int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID);
374 
375 /**
376  * \brief Determine whether the given header is guarded against
377  * multiple inclusions, either with the conventional
378  * \#ifndef/\#define/\#endif macro guards or with \#pragma once.
379  */
380 CINDEX_LINKAGE unsigned
381 clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file);
382 
383 /**
384  * \brief Retrieve a file handle within the given translation unit.
385  *
386  * \param tu the translation unit
387  *
388  * \param file_name the name of the file.
389  *
390  * \returns the file handle for the named file in the translation unit \p tu,
391  * or a NULL file handle if the file was not a part of this translation unit.
392  */
393 CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu,
394  const char *file_name);
395 
396 /**
397  * \brief Returns non-zero if the \c file1 and \c file2 point to the same file,
398  * or they are both NULL.
399  */
400 CINDEX_LINKAGE int clang_File_isEqual(CXFile file1, CXFile file2);
401 
402 /**
403  * @}
404  */
405 
406 /**
407  * \defgroup CINDEX_LOCATIONS Physical source locations
408  *
409  * Clang represents physical source locations in its abstract syntax tree in
410  * great detail, with file, line, and column information for the majority of
411  * the tokens parsed in the source code. These data types and functions are
412  * used to represent source location information, either for a particular
413  * point in the program or for a range of points in the program, and extract
414  * specific location information from those data types.
415  *
416  * @{
417  */
418 
419 /**
420  * \brief Identifies a specific source location within a translation
421  * unit.
422  *
423  * Use clang_getExpansionLocation() or clang_getSpellingLocation()
424  * to map a source location to a particular file, line, and column.
425  */
426 typedef struct {
427  const void *ptr_data[2];
428  unsigned int_data;
430 
431 /**
432  * \brief Identifies a half-open character range in the source code.
433  *
434  * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the
435  * starting and end locations from a source range, respectively.
436  */
437 typedef struct {
438  const void *ptr_data[2];
439  unsigned begin_int_data;
440  unsigned end_int_data;
441 } CXSourceRange;
442 
443 /**
444  * \brief Retrieve a NULL (invalid) source location.
445  */
447 
448 /**
449  * \brief Determine whether two source locations, which must refer into
450  * the same translation unit, refer to exactly the same point in the source
451  * code.
452  *
453  * \returns non-zero if the source locations refer to the same location, zero
454  * if they refer to different locations.
455  */
457  CXSourceLocation loc2);
458 
459 /**
460  * \brief Retrieves the source location associated with a given file/line/column
461  * in a particular translation unit.
462  */
464  CXFile file,
465  unsigned line,
466  unsigned column);
467 /**
468  * \brief Retrieves the source location associated with a given character offset
469  * in a particular translation unit.
470  */
472  CXFile file,
473  unsigned offset);
474 
475 /**
476  * \brief Returns non-zero if the given source location is in a system header.
477  */
479 
480 /**
481  * \brief Returns non-zero if the given source location is in the main file of
482  * the corresponding translation unit.
483  */
485 
486 /**
487  * \brief Retrieve a NULL (invalid) source range.
488  */
490 
491 /**
492  * \brief Retrieve a source range given the beginning and ending source
493  * locations.
494  */
496  CXSourceLocation end);
497 
498 /**
499  * \brief Determine whether two ranges are equivalent.
500  *
501  * \returns non-zero if the ranges are the same, zero if they differ.
502  */
504  CXSourceRange range2);
505 
506 /**
507  * \brief Returns non-zero if \p range is null.
508  */
510 
511 /**
512  * \brief Retrieve the file, line, column, and offset represented by
513  * the given source location.
514  *
515  * If the location refers into a macro expansion, retrieves the
516  * location of the macro expansion.
517  *
518  * \param location the location within a source file that will be decomposed
519  * into its parts.
520  *
521  * \param file [out] if non-NULL, will be set to the file to which the given
522  * source location points.
523  *
524  * \param line [out] if non-NULL, will be set to the line to which the given
525  * source location points.
526  *
527  * \param column [out] if non-NULL, will be set to the column to which the given
528  * source location points.
529  *
530  * \param offset [out] if non-NULL, will be set to the offset into the
531  * buffer to which the given source location points.
532  */
534  CXFile *file,
535  unsigned *line,
536  unsigned *column,
537  unsigned *offset);
538 
539 /**
540  * \brief Retrieve the file, line and column represented by the given source
541  * location, as specified in a # line directive.
542  *
543  * Example: given the following source code in a file somefile.c
544  *
545  * \code
546  * #123 "dummy.c" 1
547  *
548  * static int func(void)
549  * {
550  * return 0;
551  * }
552  * \endcode
553  *
554  * the location information returned by this function would be
555  *
556  * File: dummy.c Line: 124 Column: 12
557  *
558  * whereas clang_getExpansionLocation would have returned
559  *
560  * File: somefile.c Line: 3 Column: 12
561  *
562  * \param location the location within a source file that will be decomposed
563  * into its parts.
564  *
565  * \param filename [out] if non-NULL, will be set to the filename of the
566  * source location. Note that filenames returned will be for "virtual" files,
567  * which don't necessarily exist on the machine running clang - e.g. when
568  * parsing preprocessed output obtained from a different environment. If
569  * a non-NULL value is passed in, remember to dispose of the returned value
570  * using \c clang_disposeString() once you've finished with it. For an invalid
571  * source location, an empty string is returned.
572  *
573  * \param line [out] if non-NULL, will be set to the line number of the
574  * source location. For an invalid source location, zero is returned.
575  *
576  * \param column [out] if non-NULL, will be set to the column number of the
577  * source location. For an invalid source location, zero is returned.
578  */
580  CXString *filename,
581  unsigned *line,
582  unsigned *column);
583 
584 /**
585  * \brief Legacy API to retrieve the file, line, column, and offset represented
586  * by the given source location.
587  *
588  * This interface has been replaced by the newer interface
589  * #clang_getExpansionLocation(). See that interface's documentation for
590  * details.
591  */
593  CXFile *file,
594  unsigned *line,
595  unsigned *column,
596  unsigned *offset);
597 
598 /**
599  * \brief Retrieve the file, line, column, and offset represented by
600  * the given source location.
601  *
602  * If the location refers into a macro instantiation, return where the
603  * location was originally spelled in the source file.
604  *
605  * \param location the location within a source file that will be decomposed
606  * into its parts.
607  *
608  * \param file [out] if non-NULL, will be set to the file to which the given
609  * source location points.
610  *
611  * \param line [out] if non-NULL, will be set to the line to which the given
612  * source location points.
613  *
614  * \param column [out] if non-NULL, will be set to the column to which the given
615  * source location points.
616  *
617  * \param offset [out] if non-NULL, will be set to the offset into the
618  * buffer to which the given source location points.
619  */
621  CXFile *file,
622  unsigned *line,
623  unsigned *column,
624  unsigned *offset);
625 
626 /**
627  * \brief Retrieve the file, line, column, and offset represented by
628  * the given source location.
629  *
630  * If the location refers into a macro expansion, return where the macro was
631  * expanded or where the macro argument was written, if the location points at
632  * a macro argument.
633  *
634  * \param location the location within a source file that will be decomposed
635  * into its parts.
636  *
637  * \param file [out] if non-NULL, will be set to the file to which the given
638  * source location points.
639  *
640  * \param line [out] if non-NULL, will be set to the line to which the given
641  * source location points.
642  *
643  * \param column [out] if non-NULL, will be set to the column to which the given
644  * source location points.
645  *
646  * \param offset [out] if non-NULL, will be set to the offset into the
647  * buffer to which the given source location points.
648  */
650  CXFile *file,
651  unsigned *line,
652  unsigned *column,
653  unsigned *offset);
654 
655 /**
656  * \brief Retrieve a source location representing the first character within a
657  * source range.
658  */
660 
661 /**
662  * \brief Retrieve a source location representing the last character within a
663  * source range.
664  */
666 
667 /**
668  * \brief Identifies an array of ranges.
669  */
670 typedef struct {
671  /** \brief The number of ranges in the \c ranges array. */
672  unsigned count;
673  /**
674  * \brief An array of \c CXSourceRanges.
675  */
678 
679 /**
680  * \brief Retrieve all ranges that were skipped by the preprocessor.
681  *
682  * The preprocessor will skip lines when they are surrounded by an
683  * if/ifdef/ifndef directive whose condition does not evaluate to true.
684  */
686  CXFile file);
687 
688 /**
689  * \brief Retrieve all ranges from all files that were skipped by the
690  * preprocessor.
691  *
692  * The preprocessor will skip lines when they are surrounded by an
693  * if/ifdef/ifndef directive whose condition does not evaluate to true.
694  */
696 
697 /**
698  * \brief Destroy the given \c CXSourceRangeList.
699  */
701 
702 /**
703  * @}
704  */
705 
706 /**
707  * \defgroup CINDEX_DIAG Diagnostic reporting
708  *
709  * @{
710  */
711 
712 /**
713  * \brief Describes the severity of a particular diagnostic.
714  */
716  /**
717  * \brief A diagnostic that has been suppressed, e.g., by a command-line
718  * option.
719  */
721 
722  /**
723  * \brief This diagnostic is a note that should be attached to the
724  * previous (non-note) diagnostic.
725  */
727 
728  /**
729  * \brief This diagnostic indicates suspicious code that may not be
730  * wrong.
731  */
733 
734  /**
735  * \brief This diagnostic indicates that the code is ill-formed.
736  */
738 
739  /**
740  * \brief This diagnostic indicates that the code is ill-formed such
741  * that future parser recovery is unlikely to produce useful
742  * results.
743  */
745 };
746 
747 /**
748  * \brief A single diagnostic, containing the diagnostic's severity,
749  * location, text, source ranges, and fix-it hints.
750  */
751 typedef void *CXDiagnostic;
752 
753 /**
754  * \brief A group of CXDiagnostics.
755  */
756 typedef void *CXDiagnosticSet;
757 
758 /**
759  * \brief Determine the number of diagnostics in a CXDiagnosticSet.
760  */
761 CINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags);
762 
763 /**
764  * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet.
765  *
766  * \param Diags the CXDiagnosticSet to query.
767  * \param Index the zero-based diagnostic number to retrieve.
768  *
769  * \returns the requested diagnostic. This diagnostic must be freed
770  * via a call to \c clang_disposeDiagnostic().
771  */
772 CINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags,
773  unsigned Index);
774 
775 /**
776  * \brief Describes the kind of error that occurred (if any) in a call to
777  * \c clang_loadDiagnostics.
778  */
780  /**
781  * \brief Indicates that no error occurred.
782  */
784 
785  /**
786  * \brief Indicates that an unknown error occurred while attempting to
787  * deserialize diagnostics.
788  */
790 
791  /**
792  * \brief Indicates that the file containing the serialized diagnostics
793  * could not be opened.
794  */
796 
797  /**
798  * \brief Indicates that the serialized diagnostics file is invalid or
799  * corrupt.
800  */
802 };
803 
804 /**
805  * \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode
806  * file.
807  *
808  * \param file The name of the file to deserialize.
809  * \param error A pointer to a enum value recording if there was a problem
810  * deserializing the diagnostics.
811  * \param errorString A pointer to a CXString for recording the error string
812  * if the file was not successfully loaded.
813  *
814  * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise. These
815  * diagnostics should be released using clang_disposeDiagnosticSet().
816  */
817 CINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file,
818  enum CXLoadDiag_Error *error,
819  CXString *errorString);
820 
821 /**
822  * \brief Release a CXDiagnosticSet and all of its contained diagnostics.
823  */
824 CINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags);
825 
826 /**
827  * \brief Retrieve the child diagnostics of a CXDiagnostic.
828  *
829  * This CXDiagnosticSet does not need to be released by
830  * clang_disposeDiagnosticSet.
831  */
832 CINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D);
833 
834 /**
835  * \brief Determine the number of diagnostics produced for the given
836  * translation unit.
837  */
838 CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit);
839 
840 /**
841  * \brief Retrieve a diagnostic associated with the given translation unit.
842  *
843  * \param Unit the translation unit to query.
844  * \param Index the zero-based diagnostic number to retrieve.
845  *
846  * \returns the requested diagnostic. This diagnostic must be freed
847  * via a call to \c clang_disposeDiagnostic().
848  */
849 CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit,
850  unsigned Index);
851 
852 /**
853  * \brief Retrieve the complete set of diagnostics associated with a
854  * translation unit.
855  *
856  * \param Unit the translation unit to query.
857  */
858 CINDEX_LINKAGE CXDiagnosticSet
859  clang_getDiagnosticSetFromTU(CXTranslationUnit Unit);
860 
861 /**
862  * \brief Destroy a diagnostic.
863  */
864 CINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic);
865 
866 /**
867  * \brief Options to control the display of diagnostics.
868  *
869  * The values in this enum are meant to be combined to customize the
870  * behavior of \c clang_formatDiagnostic().
871  */
873  /**
874  * \brief Display the source-location information where the
875  * diagnostic was located.
876  *
877  * When set, diagnostics will be prefixed by the file, line, and
878  * (optionally) column to which the diagnostic refers. For example,
879  *
880  * \code
881  * test.c:28: warning: extra tokens at end of #endif directive
882  * \endcode
883  *
884  * This option corresponds to the clang flag \c -fshow-source-location.
885  */
887 
888  /**
889  * \brief If displaying the source-location information of the
890  * diagnostic, also include the column number.
891  *
892  * This option corresponds to the clang flag \c -fshow-column.
893  */
895 
896  /**
897  * \brief If displaying the source-location information of the
898  * diagnostic, also include information about source ranges in a
899  * machine-parsable format.
900  *
901  * This option corresponds to the clang flag
902  * \c -fdiagnostics-print-source-range-info.
903  */
905 
906  /**
907  * \brief Display the option name associated with this diagnostic, if any.
908  *
909  * The option name displayed (e.g., -Wconversion) will be placed in brackets
910  * after the diagnostic text. This option corresponds to the clang flag
911  * \c -fdiagnostics-show-option.
912  */
914 
915  /**
916  * \brief Display the category number associated with this diagnostic, if any.
917  *
918  * The category number is displayed within brackets after the diagnostic text.
919  * This option corresponds to the clang flag
920  * \c -fdiagnostics-show-category=id.
921  */
923 
924  /**
925  * \brief Display the category name associated with this diagnostic, if any.
926  *
927  * The category name is displayed within brackets after the diagnostic text.
928  * This option corresponds to the clang flag
929  * \c -fdiagnostics-show-category=name.
930  */
932 };
933 
934 /**
935  * \brief Format the given diagnostic in a manner that is suitable for display.
936  *
937  * This routine will format the given diagnostic to a string, rendering
938  * the diagnostic according to the various options given. The
939  * \c clang_defaultDiagnosticDisplayOptions() function returns the set of
940  * options that most closely mimics the behavior of the clang compiler.
941  *
942  * \param Diagnostic The diagnostic to print.
943  *
944  * \param Options A set of options that control the diagnostic display,
945  * created by combining \c CXDiagnosticDisplayOptions values.
946  *
947  * \returns A new string containing for formatted diagnostic.
948  */
949 CINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic,
950  unsigned Options);
951 
952 /**
953  * \brief Retrieve the set of display options most similar to the
954  * default behavior of the clang compiler.
955  *
956  * \returns A set of display options suitable for use with \c
957  * clang_formatDiagnostic().
958  */
960 
961 /**
962  * \brief Determine the severity of the given diagnostic.
963  */
965 clang_getDiagnosticSeverity(CXDiagnostic);
966 
967 /**
968  * \brief Retrieve the source location of the given diagnostic.
969  *
970  * This location is where Clang would print the caret ('^') when
971  * displaying the diagnostic on the command line.
972  */
974 
975 /**
976  * \brief Retrieve the text of the given diagnostic.
977  */
979 
980 /**
981  * \brief Retrieve the name of the command-line option that enabled this
982  * diagnostic.
983  *
984  * \param Diag The diagnostic to be queried.
985  *
986  * \param Disable If non-NULL, will be set to the option that disables this
987  * diagnostic (if any).
988  *
989  * \returns A string that contains the command-line option used to enable this
990  * warning, such as "-Wconversion" or "-pedantic".
991  */
993  CXString *Disable);
994 
995 /**
996  * \brief Retrieve the category number for this diagnostic.
997  *
998  * Diagnostics can be categorized into groups along with other, related
999  * diagnostics (e.g., diagnostics under the same warning flag). This routine
1000  * retrieves the category number for the given diagnostic.
1001  *
1002  * \returns The number of the category that contains this diagnostic, or zero
1003  * if this diagnostic is uncategorized.
1004  */
1005 CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic);
1006 
1007 /**
1008  * \brief Retrieve the name of a particular diagnostic category. This
1009  * is now deprecated. Use clang_getDiagnosticCategoryText()
1010  * instead.
1011  *
1012  * \param Category A diagnostic category number, as returned by
1013  * \c clang_getDiagnosticCategory().
1014  *
1015  * \returns The name of the given diagnostic category.
1016  */
1019 
1020 /**
1021  * \brief Retrieve the diagnostic category text for a given diagnostic.
1022  *
1023  * \returns The text of the given diagnostic category.
1024  */
1026 
1027 /**
1028  * \brief Determine the number of source ranges associated with the given
1029  * diagnostic.
1030  */
1031 CINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic);
1032 
1033 /**
1034  * \brief Retrieve a source range associated with the diagnostic.
1035  *
1036  * A diagnostic's source ranges highlight important elements in the source
1037  * code. On the command line, Clang displays source ranges by
1038  * underlining them with '~' characters.
1039  *
1040  * \param Diagnostic the diagnostic whose range is being extracted.
1041  *
1042  * \param Range the zero-based index specifying which range to
1043  *
1044  * \returns the requested source range.
1045  */
1046 CINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic,
1047  unsigned Range);
1048 
1049 /**
1050  * \brief Determine the number of fix-it hints associated with the
1051  * given diagnostic.
1052  */
1053 CINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic);
1054 
1055 /**
1056  * \brief Retrieve the replacement information for a given fix-it.
1057  *
1058  * Fix-its are described in terms of a source range whose contents
1059  * should be replaced by a string. This approach generalizes over
1060  * three kinds of operations: removal of source code (the range covers
1061  * the code to be removed and the replacement string is empty),
1062  * replacement of source code (the range covers the code to be
1063  * replaced and the replacement string provides the new code), and
1064  * insertion (both the start and end of the range point at the
1065  * insertion location, and the replacement string provides the text to
1066  * insert).
1067  *
1068  * \param Diagnostic The diagnostic whose fix-its are being queried.
1069  *
1070  * \param FixIt The zero-based index of the fix-it.
1071  *
1072  * \param ReplacementRange The source range whose contents will be
1073  * replaced with the returned replacement string. Note that source
1074  * ranges are half-open ranges [a, b), so the source code should be
1075  * replaced from a and up to (but not including) b.
1076  *
1077  * \returns A string containing text that should be replace the source
1078  * code indicated by the \c ReplacementRange.
1079  */
1080 CINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic,
1081  unsigned FixIt,
1082  CXSourceRange *ReplacementRange);
1083 
1084 /**
1085  * @}
1086  */
1087 
1088 /**
1089  * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation
1090  *
1091  * The routines in this group provide the ability to create and destroy
1092  * translation units from files, either by parsing the contents of the files or
1093  * by reading in a serialized representation of a translation unit.
1094  *
1095  * @{
1096  */
1097 
1098 /**
1099  * \brief Get the original translation unit source file name.
1100  */
1102 clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
1103 
1104 /**
1105  * \brief Return the CXTranslationUnit for a given source file and the provided
1106  * command line arguments one would pass to the compiler.
1107  *
1108  * Note: The 'source_filename' argument is optional. If the caller provides a
1109  * NULL pointer, the name of the source file is expected to reside in the
1110  * specified command line arguments.
1111  *
1112  * Note: When encountered in 'clang_command_line_args', the following options
1113  * are ignored:
1114  *
1115  * '-c'
1116  * '-emit-ast'
1117  * '-fsyntax-only'
1118  * '-o <output file>' (both '-o' and '<output file>' are ignored)
1119  *
1120  * \param CIdx The index object with which the translation unit will be
1121  * associated.
1122  *
1123  * \param source_filename The name of the source file to load, or NULL if the
1124  * source file is included in \p clang_command_line_args.
1125  *
1126  * \param num_clang_command_line_args The number of command-line arguments in
1127  * \p clang_command_line_args.
1128  *
1129  * \param clang_command_line_args The command-line arguments that would be
1130  * passed to the \c clang executable if it were being invoked out-of-process.
1131  * These command-line options will be parsed and will affect how the translation
1132  * unit is parsed. Note that the following options are ignored: '-c',
1133  * '-emit-ast', '-fsyntax-only' (which is the default), and '-o <output file>'.
1134  *
1135  * \param num_unsaved_files the number of unsaved file entries in \p
1136  * unsaved_files.
1137  *
1138  * \param unsaved_files the files that have not yet been saved to disk
1139  * but may be required for code completion, including the contents of
1140  * those files. The contents and name of these files (as specified by
1141  * CXUnsavedFile) are copied when necessary, so the client only needs to
1142  * guarantee their validity until the call to this function returns.
1143  */
1145  CXIndex CIdx,
1146  const char *source_filename,
1147  int num_clang_command_line_args,
1148  const char * const *clang_command_line_args,
1149  unsigned num_unsaved_files,
1150  struct CXUnsavedFile *unsaved_files);
1151 
1152 /**
1153  * \brief Same as \c clang_createTranslationUnit2, but returns
1154  * the \c CXTranslationUnit instead of an error code. In case of an error this
1155  * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1156  * error codes.
1157  */
1159  CXIndex CIdx,
1160  const char *ast_filename);
1161 
1162 /**
1163  * \brief Create a translation unit from an AST file (\c -emit-ast).
1164  *
1165  * \param[out] out_TU A non-NULL pointer to store the created
1166  * \c CXTranslationUnit.
1167  *
1168  * \returns Zero on success, otherwise returns an error code.
1169  */
1171  CXIndex CIdx,
1172  const char *ast_filename,
1173  CXTranslationUnit *out_TU);
1174 
1175 /**
1176  * \brief Flags that control the creation of translation units.
1177  *
1178  * The enumerators in this enumeration type are meant to be bitwise
1179  * ORed together to specify which options should be used when
1180  * constructing the translation unit.
1181  */
1183  /**
1184  * \brief Used to indicate that no special translation-unit options are
1185  * needed.
1186  */
1188 
1189  /**
1190  * \brief Used to indicate that the parser should construct a "detailed"
1191  * preprocessing record, including all macro definitions and instantiations.
1192  *
1193  * Constructing a detailed preprocessing record requires more memory
1194  * and time to parse, since the information contained in the record
1195  * is usually not retained. However, it can be useful for
1196  * applications that require more detailed information about the
1197  * behavior of the preprocessor.
1198  */
1200 
1201  /**
1202  * \brief Used to indicate that the translation unit is incomplete.
1203  *
1204  * When a translation unit is considered "incomplete", semantic
1205  * analysis that is typically performed at the end of the
1206  * translation unit will be suppressed. For example, this suppresses
1207  * the completion of tentative declarations in C and of
1208  * instantiation of implicitly-instantiation function templates in
1209  * C++. This option is typically used when parsing a header with the
1210  * intent of producing a precompiled header.
1211  */
1213 
1214  /**
1215  * \brief Used to indicate that the translation unit should be built with an
1216  * implicit precompiled header for the preamble.
1217  *
1218  * An implicit precompiled header is used as an optimization when a
1219  * particular translation unit is likely to be reparsed many times
1220  * when the sources aren't changing that often. In this case, an
1221  * implicit precompiled header will be built containing all of the
1222  * initial includes at the top of the main file (what we refer to as
1223  * the "preamble" of the file). In subsequent parses, if the
1224  * preamble or the files in it have not changed, \c
1225  * clang_reparseTranslationUnit() will re-use the implicit
1226  * precompiled header to improve parsing performance.
1227  */
1229 
1230  /**
1231  * \brief Used to indicate that the translation unit should cache some
1232  * code-completion results with each reparse of the source file.
1233  *
1234  * Caching of code-completion results is a performance optimization that
1235  * introduces some overhead to reparsing but improves the performance of
1236  * code-completion operations.
1237  */
1239 
1240  /**
1241  * \brief Used to indicate that the translation unit will be serialized with
1242  * \c clang_saveTranslationUnit.
1243  *
1244  * This option is typically used when parsing a header with the intent of
1245  * producing a precompiled header.
1246  */
1248 
1249  /**
1250  * \brief DEPRECATED: Enabled chained precompiled preambles in C++.
1251  *
1252  * Note: this is a *temporary* option that is available only while
1253  * we are testing C++ precompiled preamble support. It is deprecated.
1254  */
1256 
1257  /**
1258  * \brief Used to indicate that function/method bodies should be skipped while
1259  * parsing.
1260  *
1261  * This option can be used to search for declarations/definitions while
1262  * ignoring the usages.
1263  */
1265 
1266  /**
1267  * \brief Used to indicate that brief documentation comments should be
1268  * included into the set of code completions returned from this translation
1269  * unit.
1270  */
1272 
1273  /**
1274  * \brief Used to indicate that the precompiled preamble should be created on
1275  * the first parse. Otherwise it will be created on the first reparse. This
1276  * trades runtime on the first parse (serializing the preamble takes time) for
1277  * reduced runtime on the second parse (can now reuse the preamble).
1278  */
1280 
1281  /**
1282  * \brief Do not stop processing when fatal errors are encountered.
1283  *
1284  * When fatal errors are encountered while parsing a translation unit,
1285  * semantic analysis is typically stopped early when compiling code. A common
1286  * source for fatal errors are unresolvable include files. For the
1287  * purposes of an IDE, this is undesirable behavior and as much information
1288  * as possible should be reported. Use this flag to enable this behavior.
1289  */
1291 
1292  /**
1293  * \brief Sets the preprocessor in a mode for parsing a single file only.
1294  */
1296 };
1297 
1298 /**
1299  * \brief Returns the set of flags that is suitable for parsing a translation
1300  * unit that is being edited.
1301  *
1302  * The set of flags returned provide options for \c clang_parseTranslationUnit()
1303  * to indicate that the translation unit is likely to be reparsed many times,
1304  * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly
1305  * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag
1306  * set contains an unspecified set of optimizations (e.g., the precompiled
1307  * preamble) geared toward improving the performance of these routines. The
1308  * set of optimizations enabled may change from one version to the next.
1309  */
1311 
1312 /**
1313  * \brief Same as \c clang_parseTranslationUnit2, but returns
1314  * the \c CXTranslationUnit instead of an error code. In case of an error this
1315  * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1316  * error codes.
1317  */
1318 CINDEX_LINKAGE CXTranslationUnit
1319 clang_parseTranslationUnit(CXIndex CIdx,
1320  const char *source_filename,
1321  const char *const *command_line_args,
1322  int num_command_line_args,
1323  struct CXUnsavedFile *unsaved_files,
1324  unsigned num_unsaved_files,
1325  unsigned options);
1326 
1327 /**
1328  * \brief Parse the given source file and the translation unit corresponding
1329  * to that file.
1330  *
1331  * This routine is the main entry point for the Clang C API, providing the
1332  * ability to parse a source file into a translation unit that can then be
1333  * queried by other functions in the API. This routine accepts a set of
1334  * command-line arguments so that the compilation can be configured in the same
1335  * way that the compiler is configured on the command line.
1336  *
1337  * \param CIdx The index object with which the translation unit will be
1338  * associated.
1339  *
1340  * \param source_filename The name of the source file to load, or NULL if the
1341  * source file is included in \c command_line_args.
1342  *
1343  * \param command_line_args The command-line arguments that would be
1344  * passed to the \c clang executable if it were being invoked out-of-process.
1345  * These command-line options will be parsed and will affect how the translation
1346  * unit is parsed. Note that the following options are ignored: '-c',
1347  * '-emit-ast', '-fsyntax-only' (which is the default), and '-o <output file>'.
1348  *
1349  * \param num_command_line_args The number of command-line arguments in
1350  * \c command_line_args.
1351  *
1352  * \param unsaved_files the files that have not yet been saved to disk
1353  * but may be required for parsing, including the contents of
1354  * those files. The contents and name of these files (as specified by
1355  * CXUnsavedFile) are copied when necessary, so the client only needs to
1356  * guarantee their validity until the call to this function returns.
1357  *
1358  * \param num_unsaved_files the number of unsaved file entries in \p
1359  * unsaved_files.
1360  *
1361  * \param options A bitmask of options that affects how the translation unit
1362  * is managed but not its compilation. This should be a bitwise OR of the
1363  * CXTranslationUnit_XXX flags.
1364  *
1365  * \param[out] out_TU A non-NULL pointer to store the created
1366  * \c CXTranslationUnit, describing the parsed code and containing any
1367  * diagnostics produced by the compiler.
1368  *
1369  * \returns Zero on success, otherwise returns an error code.
1370  */
1372 clang_parseTranslationUnit2(CXIndex CIdx,
1373  const char *source_filename,
1374  const char *const *command_line_args,
1375  int num_command_line_args,
1376  struct CXUnsavedFile *unsaved_files,
1377  unsigned num_unsaved_files,
1378  unsigned options,
1379  CXTranslationUnit *out_TU);
1380 
1381 /**
1382  * \brief Same as clang_parseTranslationUnit2 but requires a full command line
1383  * for \c command_line_args including argv[0]. This is useful if the standard
1384  * library paths are relative to the binary.
1385  */
1387  CXIndex CIdx, const char *source_filename,
1388  const char *const *command_line_args, int num_command_line_args,
1389  struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
1390  unsigned options, CXTranslationUnit *out_TU);
1391 
1392 /**
1393  * \brief Flags that control how translation units are saved.
1394  *
1395  * The enumerators in this enumeration type are meant to be bitwise
1396  * ORed together to specify which options should be used when
1397  * saving the translation unit.
1398  */
1400  /**
1401  * \brief Used to indicate that no special saving options are needed.
1402  */
1404 };
1405 
1406 /**
1407  * \brief Returns the set of flags that is suitable for saving a translation
1408  * unit.
1409  *
1410  * The set of flags returned provide options for
1411  * \c clang_saveTranslationUnit() by default. The returned flag
1412  * set contains an unspecified set of options that save translation units with
1413  * the most commonly-requested data.
1414  */
1415 CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU);
1416 
1417 /**
1418  * \brief Describes the kind of error that occurred (if any) in a call to
1419  * \c clang_saveTranslationUnit().
1420  */
1422  /**
1423  * \brief Indicates that no error occurred while saving a translation unit.
1424  */
1426 
1427  /**
1428  * \brief Indicates that an unknown error occurred while attempting to save
1429  * the file.
1430  *
1431  * This error typically indicates that file I/O failed when attempting to
1432  * write the file.
1433  */
1435 
1436  /**
1437  * \brief Indicates that errors during translation prevented this attempt
1438  * to save the translation unit.
1439  *
1440  * Errors that prevent the translation unit from being saved can be
1441  * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic().
1442  */
1444 
1445  /**
1446  * \brief Indicates that the translation unit to be saved was somehow
1447  * invalid (e.g., NULL).
1448  */
1450 };
1451 
1452 /**
1453  * \brief Saves a translation unit into a serialized representation of
1454  * that translation unit on disk.
1455  *
1456  * Any translation unit that was parsed without error can be saved
1457  * into a file. The translation unit can then be deserialized into a
1458  * new \c CXTranslationUnit with \c clang_createTranslationUnit() or,
1459  * if it is an incomplete translation unit that corresponds to a
1460  * header, used as a precompiled header when parsing other translation
1461  * units.
1462  *
1463  * \param TU The translation unit to save.
1464  *
1465  * \param FileName The file to which the translation unit will be saved.
1466  *
1467  * \param options A bitmask of options that affects how the translation unit
1468  * is saved. This should be a bitwise OR of the
1469  * CXSaveTranslationUnit_XXX flags.
1470  *
1471  * \returns A value that will match one of the enumerators of the CXSaveError
1472  * enumeration. Zero (CXSaveError_None) indicates that the translation unit was
1473  * saved successfully, while a non-zero value indicates that a problem occurred.
1474  */
1475 CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU,
1476  const char *FileName,
1477  unsigned options);
1478 
1479 /**
1480  * \brief Suspend a translation unit in order to free memory associated with it.
1481  *
1482  * A suspended translation unit uses significantly less memory but on the other
1483  * side does not support any other calls than \c clang_reparseTranslationUnit
1484  * to resume it or \c clang_disposeTranslationUnit to dispose it completely.
1485  */
1486 CINDEX_LINKAGE unsigned clang_suspendTranslationUnit(CXTranslationUnit);
1487 
1488 /**
1489  * \brief Destroy the specified CXTranslationUnit object.
1490  */
1491 CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit);
1492 
1493 /**
1494  * \brief Flags that control the reparsing of translation units.
1495  *
1496  * The enumerators in this enumeration type are meant to be bitwise
1497  * ORed together to specify which options should be used when
1498  * reparsing the translation unit.
1499  */
1501  /**
1502  * \brief Used to indicate that no special reparsing options are needed.
1503  */
1505 };
1506 
1507 /**
1508  * \brief Returns the set of flags that is suitable for reparsing a translation
1509  * unit.
1510  *
1511  * The set of flags returned provide options for
1512  * \c clang_reparseTranslationUnit() by default. The returned flag
1513  * set contains an unspecified set of optimizations geared toward common uses
1514  * of reparsing. The set of optimizations enabled may change from one version
1515  * to the next.
1516  */
1517 CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU);
1518 
1519 /**
1520  * \brief Reparse the source files that produced this translation unit.
1521  *
1522  * This routine can be used to re-parse the source files that originally
1523  * created the given translation unit, for example because those source files
1524  * have changed (either on disk or as passed via \p unsaved_files). The
1525  * source code will be reparsed with the same command-line options as it
1526  * was originally parsed.
1527  *
1528  * Reparsing a translation unit invalidates all cursors and source locations
1529  * that refer into that translation unit. This makes reparsing a translation
1530  * unit semantically equivalent to destroying the translation unit and then
1531  * creating a new translation unit with the same command-line arguments.
1532  * However, it may be more efficient to reparse a translation
1533  * unit using this routine.
1534  *
1535  * \param TU The translation unit whose contents will be re-parsed. The
1536  * translation unit must originally have been built with
1537  * \c clang_createTranslationUnitFromSourceFile().
1538  *
1539  * \param num_unsaved_files The number of unsaved file entries in \p
1540  * unsaved_files.
1541  *
1542  * \param unsaved_files The files that have not yet been saved to disk
1543  * but may be required for parsing, including the contents of
1544  * those files. The contents and name of these files (as specified by
1545  * CXUnsavedFile) are copied when necessary, so the client only needs to
1546  * guarantee their validity until the call to this function returns.
1547  *
1548  * \param options A bitset of options composed of the flags in CXReparse_Flags.
1549  * The function \c clang_defaultReparseOptions() produces a default set of
1550  * options recommended for most uses, based on the translation unit.
1551  *
1552  * \returns 0 if the sources could be reparsed. A non-zero error code will be
1553  * returned if reparsing was impossible, such that the translation unit is
1554  * invalid. In such cases, the only valid call for \c TU is
1555  * \c clang_disposeTranslationUnit(TU). The error codes returned by this
1556  * routine are described by the \c CXErrorCode enum.
1557  */
1558 CINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU,
1559  unsigned num_unsaved_files,
1560  struct CXUnsavedFile *unsaved_files,
1561  unsigned options);
1562 
1563 /**
1564  * \brief Categorizes how memory is being used by a translation unit.
1565  */
1584 
1587 };
1588 
1589 /**
1590  * \brief Returns the human-readable null-terminated C string that represents
1591  * the name of the memory category. This string should never be freed.
1592  */
1595 
1596 typedef struct CXTUResourceUsageEntry {
1597  /* \brief The memory usage category. */
1599  /* \brief Amount of resources used.
1600  The units will depend on the resource kind. */
1601  unsigned long amount;
1603 
1604 /**
1605  * \brief The memory usage of a CXTranslationUnit, broken into categories.
1606  */
1607 typedef struct CXTUResourceUsage {
1608  /* \brief Private data member, used for queries. */
1609  void *data;
1610 
1611  /* \brief The number of entries in the 'entries' array. */
1612  unsigned numEntries;
1613 
1614  /* \brief An array of key-value pairs, representing the breakdown of memory
1615  usage. */
1617 
1619 
1620 /**
1621  * \brief Return the memory usage of a translation unit. This object
1622  * should be released with clang_disposeCXTUResourceUsage().
1623  */
1625 
1627 
1628 /**
1629  * \brief Get target information for this translation unit.
1630  *
1631  * The CXTargetInfo object cannot outlive the CXTranslationUnit object.
1632  */
1633 CINDEX_LINKAGE CXTargetInfo
1634 clang_getTranslationUnitTargetInfo(CXTranslationUnit CTUnit);
1635 
1636 /**
1637  * \brief Destroy the CXTargetInfo object.
1638  */
1639 CINDEX_LINKAGE void
1640 clang_TargetInfo_dispose(CXTargetInfo Info);
1641 
1642 /**
1643  * \brief Get the normalized target triple as a string.
1644  *
1645  * Returns the empty string in case of any error.
1646  */
1648 clang_TargetInfo_getTriple(CXTargetInfo Info);
1649 
1650 /**
1651  * \brief Get the pointer width of the target in bits.
1652  *
1653  * Returns -1 in case of error.
1654  */
1655 CINDEX_LINKAGE int
1656 clang_TargetInfo_getPointerWidth(CXTargetInfo Info);
1657 
1658 /**
1659  * @}
1660  */
1661 
1662 /**
1663  * \brief Describes the kind of entity that a cursor refers to.
1664  */
1666  /* Declarations */
1667  /**
1668  * \brief A declaration whose specific kind is not exposed via this
1669  * interface.
1670  *
1671  * Unexposed declarations have the same operations as any other kind
1672  * of declaration; one can extract their location information,
1673  * spelling, find their definitions, etc. However, the specific kind
1674  * of the declaration is not reported.
1675  */
1677  /** \brief A C or C++ struct. */
1679  /** \brief A C or C++ union. */
1681  /** \brief A C++ class. */
1683  /** \brief An enumeration. */
1685  /**
1686  * \brief A field (in C) or non-static data member (in C++) in a
1687  * struct, union, or C++ class.
1688  */
1690  /** \brief An enumerator constant. */
1692  /** \brief A function. */
1694  /** \brief A variable. */
1696  /** \brief A function or method parameter. */
1698  /** \brief An Objective-C \@interface. */
1700  /** \brief An Objective-C \@interface for a category. */
1702  /** \brief An Objective-C \@protocol declaration. */
1704  /** \brief An Objective-C \@property declaration. */
1706  /** \brief An Objective-C instance variable. */
1708  /** \brief An Objective-C instance method. */
1710  /** \brief An Objective-C class method. */
1712  /** \brief An Objective-C \@implementation. */
1714  /** \brief An Objective-C \@implementation for a category. */
1716  /** \brief A typedef. */
1718  /** \brief A C++ class method. */
1720  /** \brief A C++ namespace. */
1722  /** \brief A linkage specification, e.g. 'extern "C"'. */
1724  /** \brief A C++ constructor. */
1726  /** \brief A C++ destructor. */
1728  /** \brief A C++ conversion function. */
1730  /** \brief A C++ template type parameter. */
1732  /** \brief A C++ non-type template parameter. */
1734  /** \brief A C++ template template parameter. */
1736  /** \brief A C++ function template. */
1738  /** \brief A C++ class template. */
1740  /** \brief A C++ class template partial specialization. */
1742  /** \brief A C++ namespace alias declaration. */
1744  /** \brief A C++ using directive. */
1746  /** \brief A C++ using declaration. */
1748  /** \brief A C++ alias declaration */
1750  /** \brief An Objective-C \@synthesize definition. */
1752  /** \brief An Objective-C \@dynamic definition. */
1754  /** \brief An access specifier. */
1756 
1759 
1760  /* References */
1761  CXCursor_FirstRef = 40, /* Decl references */
1765  /**
1766  * \brief A reference to a type declaration.
1767  *
1768  * A type reference occurs anywhere where a type is named but not
1769  * declared. For example, given:
1770  *
1771  * \code
1772  * typedef unsigned size_type;
1773  * size_type size;
1774  * \endcode
1775  *
1776  * The typedef is a declaration of size_type (CXCursor_TypedefDecl),
1777  * while the type of the variable "size" is referenced. The cursor
1778  * referenced by the type of size is the typedef for size_type.
1779  */
1782  /**
1783  * \brief A reference to a class template, function template, template
1784  * template parameter, or class template partial specialization.
1785  */
1787  /**
1788  * \brief A reference to a namespace or namespace alias.
1789  */
1791  /**
1792  * \brief A reference to a member of a struct, union, or class that occurs in
1793  * some non-expression context, e.g., a designated initializer.
1794  */
1796  /**
1797  * \brief A reference to a labeled statement.
1798  *
1799  * This cursor kind is used to describe the jump to "start_over" in the
1800  * goto statement in the following example:
1801  *
1802  * \code
1803  * start_over:
1804  * ++counter;
1805  *
1806  * goto start_over;
1807  * \endcode
1808  *
1809  * A label reference cursor refers to a label statement.
1810  */
1812 
1813  /**
1814  * \brief A reference to a set of overloaded functions or function templates
1815  * that has not yet been resolved to a specific function or function template.
1816  *
1817  * An overloaded declaration reference cursor occurs in C++ templates where
1818  * a dependent name refers to a function. For example:
1819  *
1820  * \code
1821  * template<typename T> void swap(T&, T&);
1822  *
1823  * struct X { ... };
1824  * void swap(X&, X&);
1825  *
1826  * template<typename T>
1827  * void reverse(T* first, T* last) {
1828  * while (first < last - 1) {
1829  * swap(*first, *--last);
1830  * ++first;
1831  * }
1832  * }
1833  *
1834  * struct Y { };
1835  * void swap(Y&, Y&);
1836  * \endcode
1837  *
1838  * Here, the identifier "swap" is associated with an overloaded declaration
1839  * reference. In the template definition, "swap" refers to either of the two
1840  * "swap" functions declared above, so both results will be available. At
1841  * instantiation time, "swap" may also refer to other functions found via
1842  * argument-dependent lookup (e.g., the "swap" function at the end of the
1843  * example).
1844  *
1845  * The functions \c clang_getNumOverloadedDecls() and
1846  * \c clang_getOverloadedDecl() can be used to retrieve the definitions
1847  * referenced by this cursor.
1848  */
1850 
1851  /**
1852  * \brief A reference to a variable that occurs in some non-expression
1853  * context, e.g., a C++ lambda capture list.
1854  */
1856 
1858 
1859  /* Error conditions */
1866 
1867  /* Expressions */
1869 
1870  /**
1871  * \brief An expression whose specific kind is not exposed via this
1872  * interface.
1873  *
1874  * Unexposed expressions have the same operations as any other kind
1875  * of expression; one can extract their location information,
1876  * spelling, children, etc. However, the specific kind of the
1877  * expression is not reported.
1878  */
1880 
1881  /**
1882  * \brief An expression that refers to some value declaration, such
1883  * as a function, variable, or enumerator.
1884  */
1886 
1887  /**
1888  * \brief An expression that refers to a member of a struct, union,
1889  * class, Objective-C class, etc.
1890  */
1892 
1893  /** \brief An expression that calls a function. */
1895 
1896  /** \brief An expression that sends a message to an Objective-C
1897  object or class. */
1899 
1900  /** \brief An expression that represents a block literal. */
1902 
1903  /** \brief An integer literal.
1904  */
1906 
1907  /** \brief A floating point number literal.
1908  */
1910 
1911  /** \brief An imaginary number literal.
1912  */
1914 
1915  /** \brief A string literal.
1916  */
1918 
1919  /** \brief A character literal.
1920  */
1922 
1923  /** \brief A parenthesized expression, e.g. "(1)".
1924  *
1925  * This AST node is only formed if full location information is requested.
1926  */
1928 
1929  /** \brief This represents the unary-expression's (except sizeof and
1930  * alignof).
1931  */
1933 
1934  /** \brief [C99 6.5.2.1] Array Subscripting.
1935  */
1937 
1938  /** \brief A builtin binary operation expression such as "x + y" or
1939  * "x <= y".
1940  */
1942 
1943  /** \brief Compound assignment such as "+=".
1944  */
1946 
1947  /** \brief The ?: ternary operator.
1948  */
1950 
1951  /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++
1952  * (C++ [expr.cast]), which uses the syntax (Type)expr.
1953  *
1954  * For example: (int)f.
1955  */
1957 
1958  /** \brief [C99 6.5.2.5]
1959  */
1961 
1962  /** \brief Describes an C or C++ initializer list.
1963  */
1965 
1966  /** \brief The GNU address of label extension, representing &&label.
1967  */
1969 
1970  /** \brief This is the GNU Statement Expression extension: ({int X=4; X;})
1971  */
1973 
1974  /** \brief Represents a C11 generic selection.
1975  */
1977 
1978  /** \brief Implements the GNU __null extension, which is a name for a null
1979  * pointer constant that has integral type (e.g., int or long) and is the same
1980  * size and alignment as a pointer.
1981  *
1982  * The __null extension is typically only used by system headers, which define
1983  * NULL as __null in C++ rather than using 0 (which is an integer that may not
1984  * match the size of a pointer).
1985  */
1987 
1988  /** \brief C++'s static_cast<> expression.
1989  */
1991 
1992  /** \brief C++'s dynamic_cast<> expression.
1993  */
1995 
1996  /** \brief C++'s reinterpret_cast<> expression.
1997  */
1999 
2000  /** \brief C++'s const_cast<> expression.
2001  */
2003 
2004  /** \brief Represents an explicit C++ type conversion that uses "functional"
2005  * notion (C++ [expr.type.conv]).
2006  *
2007  * Example:
2008  * \code
2009  * x = int(0.5);
2010  * \endcode
2011  */
2013 
2014  /** \brief A C++ typeid expression (C++ [expr.typeid]).
2015  */
2017 
2018  /** \brief [C++ 2.13.5] C++ Boolean Literal.
2019  */
2021 
2022  /** \brief [C++0x 2.14.7] C++ Pointer Literal.
2023  */
2025 
2026  /** \brief Represents the "this" expression in C++
2027  */
2029 
2030  /** \brief [C++ 15] C++ Throw Expression.
2031  *
2032  * This handles 'throw' and 'throw' assignment-expression. When
2033  * assignment-expression isn't present, Op will be null.
2034  */
2036 
2037  /** \brief A new expression for memory allocation and constructor calls, e.g:
2038  * "new CXXNewExpr(foo)".
2039  */
2041 
2042  /** \brief A delete expression for memory deallocation and destructor calls,
2043  * e.g. "delete[] pArray".
2044  */
2046 
2047  /** \brief A unary expression. (noexcept, sizeof, or other traits)
2048  */
2050 
2051  /** \brief An Objective-C string literal i.e. @"foo".
2052  */
2054 
2055  /** \brief An Objective-C \@encode expression.
2056  */
2058 
2059  /** \brief An Objective-C \@selector expression.
2060  */
2062 
2063  /** \brief An Objective-C \@protocol expression.
2064  */
2066 
2067  /** \brief An Objective-C "bridged" cast expression, which casts between
2068  * Objective-C pointers and C pointers, transferring ownership in the process.
2069  *
2070  * \code
2071  * NSString *str = (__bridge_transfer NSString *)CFCreateString();
2072  * \endcode
2073  */
2075 
2076  /** \brief Represents a C++0x pack expansion that produces a sequence of
2077  * expressions.
2078  *
2079  * A pack expansion expression contains a pattern (which itself is an
2080  * expression) followed by an ellipsis. For example:
2081  *
2082  * \code
2083  * template<typename F, typename ...Types>
2084  * void forward(F f, Types &&...args) {
2085  * f(static_cast<Types&&>(args)...);
2086  * }
2087  * \endcode
2088  */
2090 
2091  /** \brief Represents an expression that computes the length of a parameter
2092  * pack.
2093  *
2094  * \code
2095  * template<typename ...Types>
2096  * struct count {
2097  * static const unsigned value = sizeof...(Types);
2098  * };
2099  * \endcode
2100  */
2102 
2103  /* \brief Represents a C++ lambda expression that produces a local function
2104  * object.
2105  *
2106  * \code
2107  * void abssort(float *x, unsigned N) {
2108  * std::sort(x, x + N,
2109  * [](float a, float b) {
2110  * return std::abs(a) < std::abs(b);
2111  * });
2112  * }
2113  * \endcode
2114  */
2116 
2117  /** \brief Objective-c Boolean Literal.
2118  */
2120 
2121  /** \brief Represents the "self" expression in an Objective-C method.
2122  */
2124 
2125  /** \brief OpenMP 4.0 [2.4, Array Section].
2126  */
2128 
2129  /** \brief Represents an @available(...) check.
2130  */
2132 
2134 
2135  /* Statements */
2137  /**
2138  * \brief A statement whose specific kind is not exposed via this
2139  * interface.
2140  *
2141  * Unexposed statements have the same operations as any other kind of
2142  * statement; one can extract their location information, spelling,
2143  * children, etc. However, the specific kind of the statement is not
2144  * reported.
2145  */
2147 
2148  /** \brief A labelled statement in a function.
2149  *
2150  * This cursor kind is used to describe the "start_over:" label statement in
2151  * the following example:
2152  *
2153  * \code
2154  * start_over:
2155  * ++counter;
2156  * \endcode
2157  *
2158  */
2160 
2161  /** \brief A group of statements like { stmt stmt }.
2162  *
2163  * This cursor kind is used to describe compound statements, e.g. function
2164  * bodies.
2165  */
2167 
2168  /** \brief A case statement.
2169  */
2171 
2172  /** \brief A default statement.
2173  */
2175 
2176  /** \brief An if statement
2177  */
2179 
2180  /** \brief A switch statement.
2181  */
2183 
2184  /** \brief A while statement.
2185  */
2187 
2188  /** \brief A do statement.
2189  */
2191 
2192  /** \brief A for statement.
2193  */
2195 
2196  /** \brief A goto statement.
2197  */
2199 
2200  /** \brief An indirect goto statement.
2201  */
2203 
2204  /** \brief A continue statement.
2205  */
2207 
2208  /** \brief A break statement.
2209  */
2211 
2212  /** \brief A return statement.
2213  */
2215 
2216  /** \brief A GCC inline assembly statement extension.
2217  */
2220 
2221  /** \brief Objective-C's overall \@try-\@catch-\@finally statement.
2222  */
2224 
2225  /** \brief Objective-C's \@catch statement.
2226  */
2228 
2229  /** \brief Objective-C's \@finally statement.
2230  */
2232 
2233  /** \brief Objective-C's \@throw statement.
2234  */
2236 
2237  /** \brief Objective-C's \@synchronized statement.
2238  */
2240 
2241  /** \brief Objective-C's autorelease pool statement.
2242  */
2244 
2245  /** \brief Objective-C's collection statement.
2246  */
2248 
2249  /** \brief C++'s catch statement.
2250  */
2252 
2253  /** \brief C++'s try statement.
2254  */
2256 
2257  /** \brief C++'s for (* : *) statement.
2258  */
2260 
2261  /** \brief Windows Structured Exception Handling's try statement.
2262  */
2264 
2265  /** \brief Windows Structured Exception Handling's except statement.
2266  */
2268 
2269  /** \brief Windows Structured Exception Handling's finally statement.
2270  */
2272 
2273  /** \brief A MS inline assembly statement extension.
2274  */
2276 
2277  /** \brief The null statement ";": C99 6.8.3p3.
2278  *
2279  * This cursor kind is used to describe the null statement.
2280  */
2282 
2283  /** \brief Adaptor class for mixing declarations with statements and
2284  * expressions.
2285  */
2287 
2288  /** \brief OpenMP parallel directive.
2289  */
2291 
2292  /** \brief OpenMP SIMD directive.
2293  */
2295 
2296  /** \brief OpenMP for directive.
2297  */
2299 
2300  /** \brief OpenMP sections directive.
2301  */
2303 
2304  /** \brief OpenMP section directive.
2305  */
2307 
2308  /** \brief OpenMP single directive.
2309  */
2311 
2312  /** \brief OpenMP parallel for directive.
2313  */
2315 
2316  /** \brief OpenMP parallel sections directive.
2317  */
2319 
2320  /** \brief OpenMP task directive.
2321  */
2323 
2324  /** \brief OpenMP master directive.
2325  */
2327 
2328  /** \brief OpenMP critical directive.
2329  */
2331 
2332  /** \brief OpenMP taskyield directive.
2333  */
2335 
2336  /** \brief OpenMP barrier directive.
2337  */
2339 
2340  /** \brief OpenMP taskwait directive.
2341  */
2343 
2344  /** \brief OpenMP flush directive.
2345  */
2347 
2348  /** \brief Windows Structured Exception Handling's leave statement.
2349  */
2351 
2352  /** \brief OpenMP ordered directive.
2353  */
2355 
2356  /** \brief OpenMP atomic directive.
2357  */
2359 
2360  /** \brief OpenMP for SIMD directive.
2361  */
2363 
2364  /** \brief OpenMP parallel for SIMD directive.
2365  */
2367 
2368  /** \brief OpenMP target directive.
2369  */
2371 
2372  /** \brief OpenMP teams directive.
2373  */
2375 
2376  /** \brief OpenMP taskgroup directive.
2377  */
2379 
2380  /** \brief OpenMP cancellation point directive.
2381  */
2383 
2384  /** \brief OpenMP cancel directive.
2385  */
2387 
2388  /** \brief OpenMP target data directive.
2389  */
2391 
2392  /** \brief OpenMP taskloop directive.
2393  */
2395 
2396  /** \brief OpenMP taskloop simd directive.
2397  */
2399 
2400  /** \brief OpenMP distribute directive.
2401  */
2403 
2404  /** \brief OpenMP target enter data directive.
2405  */
2407 
2408  /** \brief OpenMP target exit data directive.
2409  */
2411 
2412  /** \brief OpenMP target parallel directive.
2413  */
2415 
2416  /** \brief OpenMP target parallel for directive.
2417  */
2419 
2420  /** \brief OpenMP target update directive.
2421  */
2423 
2424  /** \brief OpenMP distribute parallel for directive.
2425  */
2427 
2428  /** \brief OpenMP distribute parallel for simd directive.
2429  */
2431 
2432  /** \brief OpenMP distribute simd directive.
2433  */
2435 
2436  /** \brief OpenMP target parallel for simd directive.
2437  */
2439 
2440  /** \brief OpenMP target simd directive.
2441  */
2443 
2444  /** \brief OpenMP teams distribute directive.
2445  */
2447 
2448  /** \brief OpenMP teams distribute simd directive.
2449  */
2451 
2452  /** \brief OpenMP teams distribute parallel for simd directive.
2453  */
2455 
2456  /** \brief OpenMP teams distribute parallel for directive.
2457  */
2459 
2460  /** \brief OpenMP target teams directive.
2461  */
2463 
2464  /** \brief OpenMP target teams distribute directive.
2465  */
2467 
2468  /** \brief OpenMP target teams distribute parallel for directive.
2469  */
2471 
2472  /** \brief OpenMP target teams distribute parallel for simd directive.
2473  */
2475 
2476  /** \brief OpenMP target teams distribute simd directive.
2477  */
2479 
2481 
2482  /**
2483  * \brief Cursor that represents the translation unit itself.
2484  *
2485  * The translation unit cursor exists primarily to act as the root
2486  * cursor for traversing the contents of a translation unit.
2487  */
2489 
2490  /* Attributes */
2492  /**
2493  * \brief An attribute whose specific kind is not exposed via this
2494  * interface.
2495  */
2497 
2518 
2519  /* Preprocessing */
2527 
2528  /* Extra Declarations */
2529  /**
2530  * \brief A module import declaration.
2531  */
2534  /**
2535  * \brief A static_assert or _Static_assert node
2536  */
2538  /**
2539  * \brief a friend declaration.
2540  */
2544 
2545  /**
2546  * \brief A code completion overload candidate.
2547  */
2549 };
2550 
2551 /**
2552  * \brief A cursor representing some element in the abstract syntax tree for
2553  * a translation unit.
2554  *
2555  * The cursor abstraction unifies the different kinds of entities in a
2556  * program--declaration, statements, expressions, references to declarations,
2557  * etc.--under a single "cursor" abstraction with a common set of operations.
2558  * Common operation for a cursor include: getting the physical location in
2559  * a source file where the cursor points, getting the name associated with a
2560  * cursor, and retrieving cursors for any child nodes of a particular cursor.
2561  *
2562  * Cursors can be produced in two specific ways.
2563  * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
2564  * from which one can use clang_visitChildren() to explore the rest of the
2565  * translation unit. clang_getCursor() maps from a physical source location
2566  * to the entity that resides at that location, allowing one to map from the
2567  * source code into the AST.
2568  */
2569 typedef struct {
2571  int xdata;
2572  const void *data[3];
2573 } CXCursor;
2574 
2575 /**
2576  * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
2577  *
2578  * @{
2579  */
2580 
2581 /**
2582  * \brief Retrieve the NULL cursor, which represents no entity.
2583  */
2585 
2586 /**
2587  * \brief Retrieve the cursor that represents the given translation unit.
2588  *
2589  * The translation unit cursor can be used to start traversing the
2590  * various declarations within the given translation unit.
2591  */
2593 
2594 /**
2595  * \brief Determine whether two cursors are equivalent.
2596  */
2598 
2599 /**
2600  * \brief Returns non-zero if \p cursor is null.
2601  */
2603 
2604 /**
2605  * \brief Compute a hash value for the given cursor.
2606  */
2608 
2609 /**
2610  * \brief Retrieve the kind of the given cursor.
2611  */
2613 
2614 /**
2615  * \brief Determine whether the given cursor kind represents a declaration.
2616  */
2618 
2619 /**
2620  * \brief Determine whether the given cursor kind represents a simple
2621  * reference.
2622  *
2623  * Note that other kinds of cursors (such as expressions) can also refer to
2624  * other cursors. Use clang_getCursorReferenced() to determine whether a
2625  * particular cursor refers to another entity.
2626  */
2628 
2629 /**
2630  * \brief Determine whether the given cursor kind represents an expression.
2631  */
2633 
2634 /**
2635  * \brief Determine whether the given cursor kind represents a statement.
2636  */
2638 
2639 /**
2640  * \brief Determine whether the given cursor kind represents an attribute.
2641  */
2643 
2644 /**
2645  * \brief Determine whether the given cursor has any attributes.
2646  */
2648 
2649 /**
2650  * \brief Determine whether the given cursor kind represents an invalid
2651  * cursor.
2652  */
2654 
2655 /**
2656  * \brief Determine whether the given cursor kind represents a translation
2657  * unit.
2658  */
2660 
2661 /***
2662  * \brief Determine whether the given cursor represents a preprocessing
2663  * element, such as a preprocessor directive or macro instantiation.
2664  */
2666 
2667 /***
2668  * \brief Determine whether the given cursor represents a currently
2669  * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
2670  */
2672 
2673 /**
2674  * \brief Describe the linkage of the entity referred to by a cursor.
2675  */
2677  /** \brief This value indicates that no linkage information is available
2678  * for a provided CXCursor. */
2680  /**
2681  * \brief This is the linkage for variables, parameters, and so on that
2682  * have automatic storage. This covers normal (non-extern) local variables.
2683  */
2685  /** \brief This is the linkage for static variables and static functions. */
2687  /** \brief This is the linkage for entities with external linkage that live
2688  * in C++ anonymous namespaces.*/
2690  /** \brief This is the linkage for entities with true, external linkage. */
2692 };
2693 
2694 /**
2695  * \brief Determine the linkage of the entity referred to by a given cursor.
2696  */
2698 
2700  /** \brief This value indicates that no visibility information is available
2701  * for a provided CXCursor. */
2703 
2704  /** \brief Symbol not seen by the linker. */
2706  /** \brief Symbol seen by the linker but resolves to a symbol inside this object. */
2708  /** \brief Symbol seen by the linker and acts like a normal symbol. */
2710 };
2711 
2712 /**
2713  * \brief Describe the visibility of the entity referred to by a cursor.
2714  *
2715  * This returns the default visibility if not explicitly specified by
2716  * a visibility attribute. The default visibility may be changed by
2717  * commandline arguments.
2718  *
2719  * \param cursor The cursor to query.
2720  *
2721  * \returns The visibility of the cursor.
2722  */
2724 
2725 /**
2726  * \brief Determine the availability of the entity that this cursor refers to,
2727  * taking the current target platform into account.
2728  *
2729  * \param cursor The cursor to query.
2730  *
2731  * \returns The availability of the cursor.
2732  */
2735 
2736 /**
2737  * Describes the availability of a given entity on a particular platform, e.g.,
2738  * a particular class might only be available on Mac OS 10.7 or newer.
2739  */
2740 typedef struct CXPlatformAvailability {
2741  /**
2742  * \brief A string that describes the platform for which this structure
2743  * provides availability information.
2744  *
2745  * Possible values are "ios" or "macos".
2746  */
2748  /**
2749  * \brief The version number in which this entity was introduced.
2750  */
2752  /**
2753  * \brief The version number in which this entity was deprecated (but is
2754  * still available).
2755  */
2757  /**
2758  * \brief The version number in which this entity was obsoleted, and therefore
2759  * is no longer available.
2760  */
2762  /**
2763  * \brief Whether the entity is unconditionally unavailable on this platform.
2764  */
2766  /**
2767  * \brief An optional message to provide to a user of this API, e.g., to
2768  * suggest replacement APIs.
2769  */
2772 
2773 /**
2774  * \brief Determine the availability of the entity that this cursor refers to
2775  * on any platforms for which availability information is known.
2776  *
2777  * \param cursor The cursor to query.
2778  *
2779  * \param always_deprecated If non-NULL, will be set to indicate whether the
2780  * entity is deprecated on all platforms.
2781  *
2782  * \param deprecated_message If non-NULL, will be set to the message text
2783  * provided along with the unconditional deprecation of this entity. The client
2784  * is responsible for deallocating this string.
2785  *
2786  * \param always_unavailable If non-NULL, will be set to indicate whether the
2787  * entity is unavailable on all platforms.
2788  *
2789  * \param unavailable_message If non-NULL, will be set to the message text
2790  * provided along with the unconditional unavailability of this entity. The
2791  * client is responsible for deallocating this string.
2792  *
2793  * \param availability If non-NULL, an array of CXPlatformAvailability instances
2794  * that will be populated with platform availability information, up to either
2795  * the number of platforms for which availability information is available (as
2796  * returned by this function) or \c availability_size, whichever is smaller.
2797  *
2798  * \param availability_size The number of elements available in the
2799  * \c availability array.
2800  *
2801  * \returns The number of platforms (N) for which availability information is
2802  * available (which is unrelated to \c availability_size).
2803  *
2804  * Note that the client is responsible for calling
2805  * \c clang_disposeCXPlatformAvailability to free each of the
2806  * platform-availability structures returned. There are
2807  * \c min(N, availability_size) such structures.
2808  */
2809 CINDEX_LINKAGE int
2811  int *always_deprecated,
2812  CXString *deprecated_message,
2813  int *always_unavailable,
2814  CXString *unavailable_message,
2815  CXPlatformAvailability *availability,
2816  int availability_size);
2817 
2818 /**
2819  * \brief Free the memory associated with a \c CXPlatformAvailability structure.
2820  */
2821 CINDEX_LINKAGE void
2823 
2824 /**
2825  * \brief Describe the "language" of the entity referred to by a cursor.
2826  */
2832 };
2833 
2834 /**
2835  * \brief Determine the "language" of the entity referred to by a given cursor.
2836  */
2838 
2839 /**
2840  * \brief Returns the translation unit that a cursor originated from.
2841  */
2843 
2844 /**
2845  * \brief A fast container representing a set of CXCursors.
2846  */
2847 typedef struct CXCursorSetImpl *CXCursorSet;
2848 
2849 /**
2850  * \brief Creates an empty CXCursorSet.
2851  */
2852 CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void);
2853 
2854 /**
2855  * \brief Disposes a CXCursorSet and releases its associated memory.
2856  */
2857 CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
2858 
2859 /**
2860  * \brief Queries a CXCursorSet to see if it contains a specific CXCursor.
2861  *
2862  * \returns non-zero if the set contains the specified cursor.
2863 */
2864 CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
2865  CXCursor cursor);
2866 
2867 /**
2868  * \brief Inserts a CXCursor into a CXCursorSet.
2869  *
2870  * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
2871 */
2872 CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
2873  CXCursor cursor);
2874 
2875 /**
2876  * \brief Determine the semantic parent of the given cursor.
2877  *
2878  * The semantic parent of a cursor is the cursor that semantically contains
2879  * the given \p cursor. For many declarations, the lexical and semantic parents
2880  * are equivalent (the lexical parent is returned by
2881  * \c clang_getCursorLexicalParent()). They diverge when declarations or
2882  * definitions are provided out-of-line. For example:
2883  *
2884  * \code
2885  * class C {
2886  * void f();
2887  * };
2888  *
2889  * void C::f() { }
2890  * \endcode
2891  *
2892  * In the out-of-line definition of \c C::f, the semantic parent is
2893  * the class \c C, of which this function is a member. The lexical parent is
2894  * the place where the declaration actually occurs in the source code; in this
2895  * case, the definition occurs in the translation unit. In general, the
2896  * lexical parent for a given entity can change without affecting the semantics
2897  * of the program, and the lexical parent of different declarations of the
2898  * same entity may be different. Changing the semantic parent of a declaration,
2899  * on the other hand, can have a major impact on semantics, and redeclarations
2900  * of a particular entity should all have the same semantic context.
2901  *
2902  * In the example above, both declarations of \c C::f have \c C as their
2903  * semantic context, while the lexical context of the first \c C::f is \c C
2904  * and the lexical context of the second \c C::f is the translation unit.
2905  *
2906  * For global declarations, the semantic parent is the translation unit.
2907  */
2909 
2910 /**
2911  * \brief Determine the lexical parent of the given cursor.
2912  *
2913  * The lexical parent of a cursor is the cursor in which the given \p cursor
2914  * was actually written. For many declarations, the lexical and semantic parents
2915  * are equivalent (the semantic parent is returned by
2916  * \c clang_getCursorSemanticParent()). They diverge when declarations or
2917  * definitions are provided out-of-line. For example:
2918  *
2919  * \code
2920  * class C {
2921  * void f();
2922  * };
2923  *
2924  * void C::f() { }
2925  * \endcode
2926  *
2927  * In the out-of-line definition of \c C::f, the semantic parent is
2928  * the class \c C, of which this function is a member. The lexical parent is
2929  * the place where the declaration actually occurs in the source code; in this
2930  * case, the definition occurs in the translation unit. In general, the
2931  * lexical parent for a given entity can change without affecting the semantics
2932  * of the program, and the lexical parent of different declarations of the
2933  * same entity may be different. Changing the semantic parent of a declaration,
2934  * on the other hand, can have a major impact on semantics, and redeclarations
2935  * of a particular entity should all have the same semantic context.
2936  *
2937  * In the example above, both declarations of \c C::f have \c C as their
2938  * semantic context, while the lexical context of the first \c C::f is \c C
2939  * and the lexical context of the second \c C::f is the translation unit.
2940  *
2941  * For declarations written in the global scope, the lexical parent is
2942  * the translation unit.
2943  */
2945 
2946 /**
2947  * \brief Determine the set of methods that are overridden by the given
2948  * method.
2949  *
2950  * In both Objective-C and C++, a method (aka virtual member function,
2951  * in C++) can override a virtual method in a base class. For
2952  * Objective-C, a method is said to override any method in the class's
2953  * base class, its protocols, or its categories' protocols, that has the same
2954  * selector and is of the same kind (class or instance).
2955  * If no such method exists, the search continues to the class's superclass,
2956  * its protocols, and its categories, and so on. A method from an Objective-C
2957  * implementation is considered to override the same methods as its
2958  * corresponding method in the interface.
2959  *
2960  * For C++, a virtual member function overrides any virtual member
2961  * function with the same signature that occurs in its base
2962  * classes. With multiple inheritance, a virtual member function can
2963  * override several virtual member functions coming from different
2964  * base classes.
2965  *
2966  * In all cases, this function determines the immediate overridden
2967  * method, rather than all of the overridden methods. For example, if
2968  * a method is originally declared in a class A, then overridden in B
2969  * (which in inherits from A) and also in C (which inherited from B),
2970  * then the only overridden method returned from this function when
2971  * invoked on C's method will be B's method. The client may then
2972  * invoke this function again, given the previously-found overridden
2973  * methods, to map out the complete method-override set.
2974  *
2975  * \param cursor A cursor representing an Objective-C or C++
2976  * method. This routine will compute the set of methods that this
2977  * method overrides.
2978  *
2979  * \param overridden A pointer whose pointee will be replaced with a
2980  * pointer to an array of cursors, representing the set of overridden
2981  * methods. If there are no overridden methods, the pointee will be
2982  * set to NULL. The pointee must be freed via a call to
2983  * \c clang_disposeOverriddenCursors().
2984  *
2985  * \param num_overridden A pointer to the number of overridden
2986  * functions, will be set to the number of overridden functions in the
2987  * array pointed to by \p overridden.
2988  */
2990  CXCursor **overridden,
2991  unsigned *num_overridden);
2992 
2993 /**
2994  * \brief Free the set of overridden cursors returned by \c
2995  * clang_getOverriddenCursors().
2996  */
2998 
2999 /**
3000  * \brief Retrieve the file that is included by the given inclusion directive
3001  * cursor.
3002  */
3004 
3005 /**
3006  * @}
3007  */
3008 
3009 /**
3010  * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
3011  *
3012  * Cursors represent a location within the Abstract Syntax Tree (AST). These
3013  * routines help map between cursors and the physical locations where the
3014  * described entities occur in the source code. The mapping is provided in
3015  * both directions, so one can map from source code to the AST and back.
3016  *
3017  * @{
3018  */
3019 
3020 /**
3021  * \brief Map a source location to the cursor that describes the entity at that
3022  * location in the source code.
3023  *
3024  * clang_getCursor() maps an arbitrary source location within a translation
3025  * unit down to the most specific cursor that describes the entity at that
3026  * location. For example, given an expression \c x + y, invoking
3027  * clang_getCursor() with a source location pointing to "x" will return the
3028  * cursor for "x"; similarly for "y". If the cursor points anywhere between
3029  * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
3030  * will return a cursor referring to the "+" expression.
3031  *
3032  * \returns a cursor representing the entity at the given source location, or
3033  * a NULL cursor if no such entity can be found.
3034  */
3036 
3037 /**
3038  * \brief Retrieve the physical location of the source constructor referenced
3039  * by the given cursor.
3040  *
3041  * The location of a declaration is typically the location of the name of that
3042  * declaration, where the name of that declaration would occur if it is
3043  * unnamed, or some keyword that introduces that particular declaration.
3044  * The location of a reference is where that reference occurs within the
3045  * source code.
3046  */
3048 
3049 /**
3050  * \brief Retrieve the physical extent of the source construct referenced by
3051  * the given cursor.
3052  *
3053  * The extent of a cursor starts with the file/line/column pointing at the
3054  * first character within the source construct that the cursor refers to and
3055  * ends with the last character within that source construct. For a
3056  * declaration, the extent covers the declaration itself. For a reference,
3057  * the extent covers the location of the reference (e.g., where the referenced
3058  * entity was actually used).
3059  */
3061 
3062 /**
3063  * @}
3064  */
3065 
3066 /**
3067  * \defgroup CINDEX_TYPES Type information for CXCursors
3068  *
3069  * @{
3070  */
3071 
3072 /**
3073  * \brief Describes the kind of type
3074  */
3076  /**
3077  * \brief Represents an invalid type (e.g., where no type is available).
3078  */
3080 
3081  /**
3082  * \brief A type whose specific kind is not exposed via this
3083  * interface.
3084  */
3086 
3087  /* Builtin types */
3120 
3140 
3141  /**
3142  * \brief Represents a type that was referred to using an elaborated type keyword.
3143  *
3144  * E.g., struct S, or via a qualified name, e.g., N::M::type, or both.
3145  */
3147 
3148  /* OpenCL PipeType. */
3150 
3151  /* OpenCL builtin types. */
3192 };
3193 
3194 /**
3195  * \brief Describes the calling convention of a function type
3196  */
3214 
3217 };
3218 
3219 /**
3220  * \brief The type of an element in the abstract syntax tree.
3221  *
3222  */
3223 typedef struct {
3225  void *data[2];
3226 } CXType;
3227 
3228 /**
3229  * \brief Retrieve the type of a CXCursor (if any).
3230  */
3232 
3233 /**
3234  * \brief Pretty-print the underlying type using the rules of the
3235  * language of the translation unit from which it came.
3236  *
3237  * If the type is invalid, an empty string is returned.
3238  */
3240 
3241 /**
3242  * \brief Retrieve the underlying type of a typedef declaration.
3243  *
3244  * If the cursor does not reference a typedef declaration, an invalid type is
3245  * returned.
3246  */
3248 
3249 /**
3250  * \brief Retrieve the integer type of an enum declaration.
3251  *
3252  * If the cursor does not reference an enum declaration, an invalid type is
3253  * returned.
3254  */
3256 
3257 /**
3258  * \brief Retrieve the integer value of an enum constant declaration as a signed
3259  * long long.
3260  *
3261  * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned.
3262  * Since this is also potentially a valid constant value, the kind of the cursor
3263  * must be verified before calling this function.
3264  */
3266 
3267 /**
3268  * \brief Retrieve the integer value of an enum constant declaration as an unsigned
3269  * long long.
3270  *
3271  * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned.
3272  * Since this is also potentially a valid constant value, the kind of the cursor
3273  * must be verified before calling this function.
3274  */
3276 
3277 /**
3278  * \brief Retrieve the bit width of a bit field declaration as an integer.
3279  *
3280  * If a cursor that is not a bit field declaration is passed in, -1 is returned.
3281  */
3283 
3284 /**
3285  * \brief Retrieve the number of non-variadic arguments associated with a given
3286  * cursor.
3287  *
3288  * The number of arguments can be determined for calls as well as for
3289  * declarations of functions or methods. For other cursors -1 is returned.
3290  */
3292 
3293 /**
3294  * \brief Retrieve the argument cursor of a function or method.
3295  *
3296  * The argument cursor can be determined for calls as well as for declarations
3297  * of functions or methods. For other cursors and for invalid indices, an
3298  * invalid cursor is returned.
3299  */
3301 
3302 /**
3303  * \brief Describes the kind of a template argument.
3304  *
3305  * See the definition of llvm::clang::TemplateArgument::ArgKind for full
3306  * element descriptions.
3307  */
3318  /* Indicates an error case, preventing the kind from being deduced. */
3320 };
3321 
3322 /**
3323  *\brief Returns the number of template args of a function decl representing a
3324  * template specialization.
3325  *
3326  * If the argument cursor cannot be converted into a template function
3327  * declaration, -1 is returned.
3328  *
3329  * For example, for the following declaration and specialization:
3330  * template <typename T, int kInt, bool kBool>
3331  * void foo() { ... }
3332  *
3333  * template <>
3334  * void foo<float, -7, true>();
3335  *
3336  * The value 3 would be returned from this call.
3337  */
3339 
3340 /**
3341  * \brief Retrieve the kind of the I'th template argument of the CXCursor C.
3342  *
3343  * If the argument CXCursor does not represent a FunctionDecl, an invalid
3344  * template argument kind is returned.
3345  *
3346  * For example, for the following declaration and specialization:
3347  * template <typename T, int kInt, bool kBool>
3348  * void foo() { ... }
3349  *
3350  * template <>
3351  * void foo<float, -7, true>();
3352  *
3353  * For I = 0, 1, and 2, Type, Integral, and Integral will be returned,
3354  * respectively.
3355  */
3357  CXCursor C, unsigned I);
3358 
3359 /**
3360  * \brief Retrieve a CXType representing the type of a TemplateArgument of a
3361  * function decl representing a template specialization.
3362  *
3363  * If the argument CXCursor does not represent a FunctionDecl whose I'th
3364  * template argument has a kind of CXTemplateArgKind_Integral, an invalid type
3365  * is returned.
3366  *
3367  * For example, for the following declaration and specialization:
3368  * template <typename T, int kInt, bool kBool>
3369  * void foo() { ... }
3370  *
3371  * template <>
3372  * void foo<float, -7, true>();
3373  *
3374  * If called with I = 0, "float", will be returned.
3375  * Invalid types will be returned for I == 1 or 2.
3376  */
3378  unsigned I);
3379 
3380 /**
3381  * \brief Retrieve the value of an Integral TemplateArgument (of a function
3382  * decl representing a template specialization) as a signed long long.
3383  *
3384  * It is undefined to call this function on a CXCursor that does not represent a
3385  * FunctionDecl or whose I'th template argument is not an integral value.
3386  *
3387  * For example, for the following declaration and specialization:
3388  * template <typename T, int kInt, bool kBool>
3389  * void foo() { ... }
3390  *
3391  * template <>
3392  * void foo<float, -7, true>();
3393  *
3394  * If called with I = 1 or 2, -7 or true will be returned, respectively.
3395  * For I == 0, this function's behavior is undefined.
3396  */
3398  unsigned I);
3399 
3400 /**
3401  * \brief Retrieve the value of an Integral TemplateArgument (of a function
3402  * decl representing a template specialization) as an unsigned long long.
3403  *
3404  * It is undefined to call this function on a CXCursor that does not represent a
3405  * FunctionDecl or whose I'th template argument is not an integral value.
3406  *
3407  * For example, for the following declaration and specialization:
3408  * template <typename T, int kInt, bool kBool>
3409  * void foo() { ... }
3410  *
3411  * template <>
3412  * void foo<float, 2147483649, true>();
3413  *
3414  * If called with I = 1 or 2, 2147483649 or true will be returned, respectively.
3415  * For I == 0, this function's behavior is undefined.
3416  */
3418  CXCursor C, unsigned I);
3419 
3420 /**
3421  * \brief Determine whether two CXTypes represent the same type.
3422  *
3423  * \returns non-zero if the CXTypes represent the same type and
3424  * zero otherwise.
3425  */
3427 
3428 /**
3429  * \brief Return the canonical type for a CXType.
3430  *
3431  * Clang's type system explicitly models typedefs and all the ways
3432  * a specific type can be represented. The canonical type is the underlying
3433  * type with all the "sugar" removed. For example, if 'T' is a typedef
3434  * for 'int', the canonical type for 'T' would be 'int'.
3435  */
3437 
3438 /**
3439  * \brief Determine whether a CXType has the "const" qualifier set,
3440  * without looking through typedefs that may have added "const" at a
3441  * different level.
3442  */
3444 
3445 /**
3446  * \brief Determine whether a CXCursor that is a macro, is
3447  * function like.
3448  */
3450 
3451 /**
3452  * \brief Determine whether a CXCursor that is a macro, is a
3453  * builtin one.
3454  */
3456 
3457 /**
3458  * \brief Determine whether a CXCursor that is a function declaration, is an
3459  * inline declaration.
3460  */
3462 
3463 /**
3464  * \brief Determine whether a CXType has the "volatile" qualifier set,
3465  * without looking through typedefs that may have added "volatile" at
3466  * a different level.
3467  */
3469 
3470 /**
3471  * \brief Determine whether a CXType has the "restrict" qualifier set,
3472  * without looking through typedefs that may have added "restrict" at a
3473  * different level.
3474  */
3476 
3477 /**
3478  * \brief Returns the address space of the given type.
3479  */
3481 
3482 /**
3483  * \brief Returns the typedef name of the given type.
3484  */
3486 
3487 /**
3488  * \brief For pointer types, returns the type of the pointee.
3489  */
3491 
3492 /**
3493  * \brief Return the cursor for the declaration of the given type.
3494  */
3496 
3497 /**
3498  * Returns the Objective-C type encoding for the specified declaration.
3499  */
3501 
3502 /**
3503  * Returns the Objective-C type encoding for the specified CXType.
3504  */
3506 
3507 /**
3508  * \brief Retrieve the spelling of a given CXTypeKind.
3509  */
3511 
3512 /**
3513  * \brief Retrieve the calling convention associated with a function type.
3514  *
3515  * If a non-function type is passed in, CXCallingConv_Invalid is returned.
3516  */
3518 
3519 /**
3520  * \brief Retrieve the return type associated with a function type.
3521  *
3522  * If a non-function type is passed in, an invalid type is returned.
3523  */
3525 
3526 /**
3527  * \brief Retrieve the exception specification type associated with a function type.
3528  *
3529  * If a non-function type is passed in, an error code of -1 is returned.
3530  */
3532 
3533 /**
3534  * \brief Retrieve the number of non-variadic parameters associated with a
3535  * function type.
3536  *
3537  * If a non-function type is passed in, -1 is returned.
3538  */
3540 
3541 /**
3542  * \brief Retrieve the type of a parameter of a function type.
3543  *
3544  * If a non-function type is passed in or the function does not have enough
3545  * parameters, an invalid type is returned.
3546  */
3548 
3549 /**
3550  * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise.
3551  */
3553 
3554 /**
3555  * \brief Retrieve the return type associated with a given cursor.
3556  *
3557  * This only returns a valid type if the cursor refers to a function or method.
3558  */
3560 
3561 /**
3562  * \brief Retrieve the exception specification type associated with a given cursor.
3563  *
3564  * This only returns a valid result if the cursor refers to a function or method.
3565  */
3567 
3568 /**
3569  * \brief Return 1 if the CXType is a POD (plain old data) type, and 0
3570  * otherwise.
3571  */
3573 
3574 /**
3575  * \brief Return the element type of an array, complex, or vector type.
3576  *
3577  * If a type is passed in that is not an array, complex, or vector type,
3578  * an invalid type is returned.
3579  */
3581 
3582 /**
3583  * \brief Return the number of elements of an array or vector type.
3584  *
3585  * If a type is passed in that is not an array or vector type,
3586  * -1 is returned.
3587  */
3589 
3590 /**
3591  * \brief Return the element type of an array type.
3592  *
3593  * If a non-array type is passed in, an invalid type is returned.
3594  */
3596 
3597 /**
3598  * \brief Return the array size of a constant array.
3599  *
3600  * If a non-array type is passed in, -1 is returned.
3601  */
3603 
3604 /**
3605  * \brief Retrieve the type named by the qualified-id.
3606  *
3607  * If a non-elaborated type is passed in, an invalid type is returned.
3608  */
3610 
3611 /**
3612  * \brief Determine if a typedef is 'transparent' tag.
3613  *
3614  * A typedef is considered 'transparent' if it shares a name and spelling
3615  * location with its underlying tag type, as is the case with the NS_ENUM macro.
3616  *
3617  * \returns non-zero if transparent and zero otherwise.
3618  */
3620 
3621 /**
3622  * \brief List the possible error codes for \c clang_Type_getSizeOf,
3623  * \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and
3624  * \c clang_Cursor_getOffsetOf.
3625  *
3626  * A value of this enumeration type can be returned if the target type is not
3627  * a valid argument to sizeof, alignof or offsetof.
3628  */
3630  /**
3631  * \brief Type is of kind CXType_Invalid.
3632  */
3634  /**
3635  * \brief The type is an incomplete Type.
3636  */
3638  /**
3639  * \brief The type is a dependent Type.
3640  */
3642  /**
3643  * \brief The type is not a constant size type.
3644  */
3646  /**
3647  * \brief The Field name is not valid for this record.
3648  */
3650 };
3651 
3652 /**
3653  * \brief Return the alignment of a type in bytes as per C++[expr.alignof]
3654  * standard.
3655  *
3656  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3657  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3658  * is returned.
3659  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3660  * returned.
3661  * If the type declaration is not a constant size type,
3662  * CXTypeLayoutError_NotConstantSize is returned.
3663  */
3665 
3666 /**
3667  * \brief Return the class type of an member pointer type.
3668  *
3669  * If a non-member-pointer type is passed in, an invalid type is returned.
3670  */
3672 
3673 /**
3674  * \brief Return the size of a type in bytes as per C++[expr.sizeof] standard.
3675  *
3676  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3677  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3678  * is returned.
3679  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3680  * returned.
3681  */
3683 
3684 /**
3685  * \brief Return the offset of a field named S in a record of type T in bits
3686  * as it would be returned by __offsetof__ as per C++11[18.2p4]
3687  *
3688  * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
3689  * is returned.
3690  * If the field's type declaration is an incomplete type,
3691  * CXTypeLayoutError_Incomplete is returned.
3692  * If the field's type declaration is a dependent type,
3693  * CXTypeLayoutError_Dependent is returned.
3694  * If the field's name S is not found,
3695  * CXTypeLayoutError_InvalidFieldName is returned.
3696  */
3697 CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S);
3698 
3699 /**
3700  * \brief Return the offset of the field represented by the Cursor.
3701  *
3702  * If the cursor is not a field declaration, -1 is returned.
3703  * If the cursor semantic parent is not a record field declaration,
3704  * CXTypeLayoutError_Invalid is returned.
3705  * If the field's type declaration is an incomplete type,
3706  * CXTypeLayoutError_Incomplete is returned.
3707  * If the field's type declaration is a dependent type,
3708  * CXTypeLayoutError_Dependent is returned.
3709  * If the field's name S is not found,
3710  * CXTypeLayoutError_InvalidFieldName is returned.
3711  */
3713 
3714 /**
3715  * \brief Determine whether the given cursor represents an anonymous record
3716  * declaration.
3717  */
3719 
3721  /** \brief No ref-qualifier was provided. */
3723  /** \brief An lvalue ref-qualifier was provided (\c &). */
3725  /** \brief An rvalue ref-qualifier was provided (\c &&). */
3727 };
3728 
3729 /**
3730  * \brief Returns the number of template arguments for given template
3731  * specialization, or -1 if type \c T is not a template specialization.
3732  */
3734 
3735 /**
3736  * \brief Returns the type template argument of a template class specialization
3737  * at given index.
3738  *
3739  * This function only returns template type arguments and does not handle
3740  * template template arguments or variadic packs.
3741  */
3743 
3744 /**
3745  * \brief Retrieve the ref-qualifier kind of a function or method.
3746  *
3747  * The ref-qualifier is returned for C++ functions or methods. For other types
3748  * or non-C++ declarations, CXRefQualifier_None is returned.
3749  */
3751 
3752 /**
3753  * \brief Returns non-zero if the cursor specifies a Record member that is a
3754  * bitfield.
3755  */
3757 
3758 /**
3759  * \brief Returns 1 if the base class specified by the cursor with kind
3760  * CX_CXXBaseSpecifier is virtual.
3761  */
3763 
3764 /**
3765  * \brief Represents the C++ access control level to a base class for a
3766  * cursor with kind CX_CXXBaseSpecifier.
3767  */
3773 };
3774 
3775 /**
3776  * \brief Returns the access control level for the referenced object.
3777  *
3778  * If the cursor refers to a C++ declaration, its access control level within its
3779  * parent scope is returned. Otherwise, if the cursor refers to a base specifier or
3780  * access specifier, the specifier itself is returned.
3781  */
3783 
3784 /**
3785  * \brief Represents the storage classes as declared in the source. CX_SC_Invalid
3786  * was added for the case that the passed cursor in not a declaration.
3787  */
3797 };
3798 
3799 /**
3800  * \brief Returns the storage class for a function or variable declaration.
3801  *
3802  * If the passed in Cursor is not a function or variable declaration,
3803  * CX_SC_Invalid is returned else the storage class.
3804  */
3806 
3807 /**
3808  * \brief Determine the number of overloaded declarations referenced by a
3809  * \c CXCursor_OverloadedDeclRef cursor.
3810  *
3811  * \param cursor The cursor whose overloaded declarations are being queried.
3812  *
3813  * \returns The number of overloaded declarations referenced by \c cursor. If it
3814  * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
3815  */
3817 
3818 /**
3819  * \brief Retrieve a cursor for one of the overloaded declarations referenced
3820  * by a \c CXCursor_OverloadedDeclRef cursor.
3821  *
3822  * \param cursor The cursor whose overloaded declarations are being queried.
3823  *
3824  * \param index The zero-based index into the set of overloaded declarations in
3825  * the cursor.
3826  *
3827  * \returns A cursor representing the declaration referenced by the given
3828  * \c cursor at the specified \c index. If the cursor does not have an
3829  * associated set of overloaded declarations, or if the index is out of bounds,
3830  * returns \c clang_getNullCursor();
3831  */
3833  unsigned index);
3834 
3835 /**
3836  * @}
3837  */
3838 
3839 /**
3840  * \defgroup CINDEX_ATTRIBUTES Information for attributes
3841  *
3842  * @{
3843  */
3844 
3845 /**
3846  * \brief For cursors representing an iboutletcollection attribute,
3847  * this function returns the collection element type.
3848  *
3849  */
3851 
3852 /**
3853  * @}
3854  */
3855 
3856 /**
3857  * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
3858  *
3859  * These routines provide the ability to traverse the abstract syntax tree
3860  * using cursors.
3861  *
3862  * @{
3863  */
3864 
3865 /**
3866  * \brief Describes how the traversal of the children of a particular
3867  * cursor should proceed after visiting a particular child cursor.
3868  *
3869  * A value of this enumeration type should be returned by each
3870  * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
3871  */
3873  /**
3874  * \brief Terminates the cursor traversal.
3875  */
3877  /**
3878  * \brief Continues the cursor traversal with the next sibling of
3879  * the cursor just visited, without visiting its children.
3880  */
3882  /**
3883  * \brief Recursively traverse the children of this cursor, using
3884  * the same visitor and client data.
3885  */
3887 };
3888 
3889 /**
3890  * \brief Visitor invoked for each cursor found by a traversal.
3891  *
3892  * This visitor function will be invoked for each cursor found by
3893  * clang_visitCursorChildren(). Its first argument is the cursor being
3894  * visited, its second argument is the parent visitor for that cursor,
3895  * and its third argument is the client data provided to
3896  * clang_visitCursorChildren().
3897  *
3898  * The visitor should return one of the \c CXChildVisitResult values
3899  * to direct clang_visitCursorChildren().
3900  */
3902  CXCursor parent,
3903  CXClientData client_data);
3904 
3905 /**
3906  * \brief Visit the children of a particular cursor.
3907  *
3908  * This function visits all the direct children of the given cursor,
3909  * invoking the given \p visitor function with the cursors of each
3910  * visited child. The traversal may be recursive, if the visitor returns
3911  * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
3912  * the visitor returns \c CXChildVisit_Break.
3913  *
3914  * \param parent the cursor whose child may be visited. All kinds of
3915  * cursors can be visited, including invalid cursors (which, by
3916  * definition, have no children).
3917  *
3918  * \param visitor the visitor function that will be invoked for each
3919  * child of \p parent.
3920  *
3921  * \param client_data pointer data supplied by the client, which will
3922  * be passed to the visitor each time it is invoked.
3923  *
3924  * \returns a non-zero value if the traversal was terminated
3925  * prematurely by the visitor returning \c CXChildVisit_Break.
3926  */
3928  CXCursorVisitor visitor,
3929  CXClientData client_data);
3930 #ifdef __has_feature
3931 # if __has_feature(blocks)
3932 /**
3933  * \brief Visitor invoked for each cursor found by a traversal.
3934  *
3935  * This visitor block will be invoked for each cursor found by
3936  * clang_visitChildrenWithBlock(). Its first argument is the cursor being
3937  * visited, its second argument is the parent visitor for that cursor.
3938  *
3939  * The visitor should return one of the \c CXChildVisitResult values
3940  * to direct clang_visitChildrenWithBlock().
3941  */
3942 typedef enum CXChildVisitResult
3943  (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
3944 
3945 /**
3946  * Visits the children of a cursor using the specified block. Behaves
3947  * identically to clang_visitChildren() in all other respects.
3948  */
3949 CINDEX_LINKAGE unsigned clang_visitChildrenWithBlock(CXCursor parent,
3950  CXCursorVisitorBlock block);
3951 # endif
3952 #endif
3953 
3954 /**
3955  * @}
3956  */
3957 
3958 /**
3959  * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
3960  *
3961  * These routines provide the ability to determine references within and
3962  * across translation units, by providing the names of the entities referenced
3963  * by cursors, follow reference cursors to the declarations they reference,
3964  * and associate declarations with their definitions.
3965  *
3966  * @{
3967  */
3968 
3969 /**
3970  * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced
3971  * by the given cursor.
3972  *
3973  * A Unified Symbol Resolution (USR) is a string that identifies a particular
3974  * entity (function, class, variable, etc.) within a program. USRs can be
3975  * compared across translation units to determine, e.g., when references in
3976  * one translation refer to an entity defined in another translation unit.
3977  */
3979 
3980 /**
3981  * \brief Construct a USR for a specified Objective-C class.
3982  */
3983 CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
3984 
3985 /**
3986  * \brief Construct a USR for a specified Objective-C category.
3987  */
3989  clang_constructUSR_ObjCCategory(const char *class_name,
3990  const char *category_name);
3991 
3992 /**
3993  * \brief Construct a USR for a specified Objective-C protocol.
3994  */
3996  clang_constructUSR_ObjCProtocol(const char *protocol_name);
3997 
3998 /**
3999  * \brief Construct a USR for a specified Objective-C instance variable and
4000  * the USR for its containing class.
4001  */
4003  CXString classUSR);
4004 
4005 /**
4006  * \brief Construct a USR for a specified Objective-C method and
4007  * the USR for its containing class.
4008  */
4010  unsigned isInstanceMethod,
4011  CXString classUSR);
4012 
4013 /**
4014  * \brief Construct a USR for a specified Objective-C property and the USR
4015  * for its containing class.
4016  */
4018  CXString classUSR);
4019 
4020 /**
4021  * \brief Retrieve a name for the entity referenced by this cursor.
4022  */
4024 
4025 /**
4026  * \brief Retrieve a range for a piece that forms the cursors spelling name.
4027  * Most of the times there is only one range for the complete spelling but for
4028  * Objective-C methods and Objective-C message expressions, there are multiple
4029  * pieces for each selector identifier.
4030  *
4031  * \param pieceIndex the index of the spelling name piece. If this is greater
4032  * than the actual number of pieces, it will return a NULL (invalid) range.
4033  *
4034  * \param options Reserved.
4035  */
4037  unsigned pieceIndex,
4038  unsigned options);
4039 
4040 /**
4041  * \brief Retrieve the display name for the entity referenced by this cursor.
4042  *
4043  * The display name contains extra information that helps identify the cursor,
4044  * such as the parameters of a function or template or the arguments of a
4045  * class template specialization.
4046  */
4048 
4049 /** \brief For a cursor that is a reference, retrieve a cursor representing the
4050  * entity that it references.
4051  *
4052  * Reference cursors refer to other entities in the AST. For example, an
4053  * Objective-C superclass reference cursor refers to an Objective-C class.
4054  * This function produces the cursor for the Objective-C class from the
4055  * cursor for the superclass reference. If the input cursor is a declaration or
4056  * definition, it returns that declaration or definition unchanged.
4057  * Otherwise, returns the NULL cursor.
4058  */
4060 
4061 /**
4062  * \brief For a cursor that is either a reference to or a declaration
4063  * of some entity, retrieve a cursor that describes the definition of
4064  * that entity.
4065  *
4066  * Some entities can be declared multiple times within a translation
4067  * unit, but only one of those declarations can also be a
4068  * definition. For example, given:
4069  *
4070  * \code
4071  * int f(int, int);
4072  * int g(int x, int y) { return f(x, y); }
4073  * int f(int a, int b) { return a + b; }
4074  * int f(int, int);
4075  * \endcode
4076  *
4077  * there are three declarations of the function "f", but only the
4078  * second one is a definition. The clang_getCursorDefinition()
4079  * function will take any cursor pointing to a declaration of "f"
4080  * (the first or fourth lines of the example) or a cursor referenced
4081  * that uses "f" (the call to "f' inside "g") and will return a
4082  * declaration cursor pointing to the definition (the second "f"
4083  * declaration).
4084  *
4085  * If given a cursor for which there is no corresponding definition,
4086  * e.g., because there is no definition of that entity within this
4087  * translation unit, returns a NULL cursor.
4088  */
4090 
4091 /**
4092  * \brief Determine whether the declaration pointed to by this cursor
4093  * is also a definition of that entity.
4094  */
4096 
4097 /**
4098  * \brief Retrieve the canonical cursor corresponding to the given cursor.
4099  *
4100  * In the C family of languages, many kinds of entities can be declared several
4101  * times within a single translation unit. For example, a structure type can
4102  * be forward-declared (possibly multiple times) and later defined:
4103  *
4104  * \code
4105  * struct X;
4106  * struct X;
4107  * struct X {
4108  * int member;
4109  * };
4110  * \endcode
4111  *
4112  * The declarations and the definition of \c X are represented by three
4113  * different cursors, all of which are declarations of the same underlying
4114  * entity. One of these cursor is considered the "canonical" cursor, which
4115  * is effectively the representative for the underlying entity. One can
4116  * determine if two cursors are declarations of the same underlying entity by
4117  * comparing their canonical cursors.
4118  *
4119  * \returns The canonical cursor for the entity referred to by the given cursor.
4120  */
4122 
4123 /**
4124  * \brief If the cursor points to a selector identifier in an Objective-C
4125  * method or message expression, this returns the selector index.
4126  *
4127  * After getting a cursor with #clang_getCursor, this can be called to
4128  * determine if the location points to a selector identifier.
4129  *
4130  * \returns The selector index if the cursor is an Objective-C method or message
4131  * expression and the cursor is pointing to a selector identifier, or -1
4132  * otherwise.
4133  */
4135 
4136 /**
4137  * \brief Given a cursor pointing to a C++ method call or an Objective-C
4138  * message, returns non-zero if the method/message is "dynamic", meaning:
4139  *
4140  * For a C++ method: the call is virtual.
4141  * For an Objective-C message: the receiver is an object instance, not 'super'
4142  * or a specific class.
4143  *
4144  * If the method/message is "static" or the cursor does not point to a
4145  * method/message, it will return zero.
4146  */
4148 
4149 /**
4150  * \brief Given a cursor pointing to an Objective-C message or property
4151  * reference, or C++ method call, returns the CXType of the receiver.
4152  */
4154 
4155 /**
4156  * \brief Property attributes for a \c CXCursor_ObjCPropertyDecl.
4157  */
4158 typedef enum {
4174 
4175 /**
4176  * \brief Given a cursor that represents a property declaration, return the
4177  * associated property attributes. The bits are formed from
4178  * \c CXObjCPropertyAttrKind.
4179  *
4180  * \param reserved Reserved for future use, pass 0.
4181  */
4183  unsigned reserved);
4184 
4185 /**
4186  * \brief 'Qualifiers' written next to the return and parameter types in
4187  * Objective-C method declarations.
4188  */
4189 typedef enum {
4198 
4199 /**
4200  * \brief Given a cursor that represents an Objective-C method or parameter
4201  * declaration, return the associated Objective-C qualifiers for the return
4202  * type or the parameter respectively. The bits are formed from
4203  * CXObjCDeclQualifierKind.
4204  */
4206 
4207 /**
4208  * \brief Given a cursor that represents an Objective-C method or property
4209  * declaration, return non-zero if the declaration was affected by "\@optional".
4210  * Returns zero if the cursor is not such a declaration or it is "\@required".
4211  */
4213 
4214 /**
4215  * \brief Returns non-zero if the given cursor is a variadic function or method.
4216  */
4218 
4219 /**
4220  * \brief Returns non-zero if the given cursor points to a symbol marked with
4221  * external_source_symbol attribute.
4222  *
4223  * \param language If non-NULL, and the attribute is present, will be set to
4224  * the 'language' string from the attribute.
4225  *
4226  * \param definedIn If non-NULL, and the attribute is present, will be set to
4227  * the 'definedIn' string from the attribute.
4228  *
4229  * \param isGenerated If non-NULL, and the attribute is present, will be set to
4230  * non-zero if the 'generated_declaration' is set in the attribute.
4231  */
4233  CXString *language, CXString *definedIn,
4234  unsigned *isGenerated);
4235 
4236 /**
4237  * \brief Given a cursor that represents a declaration, return the associated
4238  * comment's source range. The range may include multiple consecutive comments
4239  * with whitespace in between.
4240  */
4242 
4243 /**
4244  * \brief Given a cursor that represents a declaration, return the associated
4245  * comment text, including comment markers.
4246  */
4248 
4249 /**
4250  * \brief Given a cursor that represents a documentable entity (e.g.,
4251  * declaration), return the associated \\brief paragraph; otherwise return the
4252  * first paragraph.
4253  */
4255 
4256 /**
4257  * @}
4258  */
4259 
4260 /** \defgroup CINDEX_MANGLE Name Mangling API Functions
4261  *
4262  * @{
4263  */
4264 
4265 /**
4266  * \brief Retrieve the CXString representing the mangled name of the cursor.
4267  */
4269 
4270 /**
4271  * \brief Retrieve the CXStrings representing the mangled symbols of the C++
4272  * constructor or destructor at the cursor.
4273  */
4275 
4276 /**
4277  * @}
4278  */
4279 
4280 /**
4281  * \defgroup CINDEX_MODULE Module introspection
4282  *
4283  * The functions in this group provide access to information about modules.
4284  *
4285  * @{
4286  */
4287 
4288 typedef void *CXModule;
4289 
4290 /**
4291  * \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module.
4292  */
4294 
4295 /**
4296  * \brief Given a CXFile header file, return the module that contains it, if one
4297  * exists.
4298  */
4299 CINDEX_LINKAGE CXModule clang_getModuleForFile(CXTranslationUnit, CXFile);
4300 
4301 /**
4302  * \param Module a module object.
4303  *
4304  * \returns the module file where the provided module object came from.
4305  */
4306 CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module);
4307 
4308 /**
4309  * \param Module a module object.
4310  *
4311  * \returns the parent of a sub-module or NULL if the given module is top-level,
4312  * e.g. for 'std.vector' it will return the 'std' module.
4313  */
4314 CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module);
4315 
4316 /**
4317  * \param Module a module object.
4318  *
4319  * \returns the name of the module, e.g. for the 'std.vector' sub-module it
4320  * will return "vector".
4321  */
4323 
4324 /**
4325  * \param Module a module object.
4326  *
4327  * \returns the full name of the module, e.g. "std.vector".
4328  */
4330 
4331 /**
4332  * \param Module a module object.
4333  *
4334  * \returns non-zero if the module is a system one.
4335  */
4336 CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module);
4337 
4338 /**
4339  * \param Module a module object.
4340  *
4341  * \returns the number of top level headers associated with this module.
4342  */
4343 CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit,
4344  CXModule Module);
4345 
4346 /**
4347  * \param Module a module object.
4348  *
4349  * \param Index top level header index (zero-based).
4350  *
4351  * \returns the specified top level header associated with the module.
4352  */
4354 CXFile clang_Module_getTopLevelHeader(CXTranslationUnit,
4355  CXModule Module, unsigned Index);
4356 
4357 /**
4358  * @}
4359  */
4360 
4361 /**
4362  * \defgroup CINDEX_CPP C++ AST introspection
4363  *
4364  * The routines in this group provide access information in the ASTs specific
4365  * to C++ language features.
4366  *
4367  * @{
4368  */
4369 
4370 /**
4371  * \brief Determine if a C++ constructor is a converting constructor.
4372  */
4374 
4375 /**
4376  * \brief Determine if a C++ constructor is a copy constructor.
4377  */
4379 
4380 /**
4381  * \brief Determine if a C++ constructor is the default constructor.
4382  */
4384 
4385 /**
4386  * \brief Determine if a C++ constructor is a move constructor.
4387  */
4389 
4390 /**
4391  * \brief Determine if a C++ field is declared 'mutable'.
4392  */
4394 
4395 /**
4396  * \brief Determine if a C++ method is declared '= default'.
4397  */
4399 
4400 /**
4401  * \brief Determine if a C++ member function or member function template is
4402  * pure virtual.
4403  */
4405 
4406 /**
4407  * \brief Determine if a C++ member function or member function template is
4408  * declared 'static'.
4409  */
4411 
4412 /**
4413  * \brief Determine if a C++ member function or member function template is
4414  * explicitly declared 'virtual' or if it overrides a virtual method from
4415  * one of the base classes.
4416  */
4418 
4419 /**
4420  * \brief Determine if an enum declaration refers to a scoped enum.
4421  */
4423 
4424 /**
4425  * \brief Determine if a C++ member function or member function template is
4426  * declared 'const'.
4427  */
4429 
4430 /**
4431  * \brief Given a cursor that represents a template, determine
4432  * the cursor kind of the specializations would be generated by instantiating
4433  * the template.
4434  *
4435  * This routine can be used to determine what flavor of function template,
4436  * class template, or class template partial specialization is stored in the
4437  * cursor. For example, it can describe whether a class template cursor is
4438  * declared with "struct", "class" or "union".
4439  *
4440  * \param C The cursor to query. This cursor should represent a template
4441  * declaration.
4442  *
4443  * \returns The cursor kind of the specializations that would be generated
4444  * by instantiating the template \p C. If \p C is not a template, returns
4445  * \c CXCursor_NoDeclFound.
4446  */
4448 
4449 /**
4450  * \brief Given a cursor that may represent a specialization or instantiation
4451  * of a template, retrieve the cursor that represents the template that it
4452  * specializes or from which it was instantiated.
4453  *
4454  * This routine determines the template involved both for explicit
4455  * specializations of templates and for implicit instantiations of the template,
4456  * both of which are referred to as "specializations". For a class template
4457  * specialization (e.g., \c std::vector<bool>), this routine will return
4458  * either the primary template (\c std::vector) or, if the specialization was
4459  * instantiated from a class template partial specialization, the class template
4460  * partial specialization. For a class template partial specialization and a
4461  * function template specialization (including instantiations), this
4462  * this routine will return the specialized template.
4463  *
4464  * For members of a class template (e.g., member functions, member classes, or
4465  * static data members), returns the specialized or instantiated member.
4466  * Although not strictly "templates" in the C++ language, members of class
4467  * templates have the same notions of specializations and instantiations that
4468  * templates do, so this routine treats them similarly.
4469  *
4470  * \param C A cursor that may be a specialization of a template or a member
4471  * of a template.
4472  *
4473  * \returns If the given cursor is a specialization or instantiation of a
4474  * template or a member thereof, the template or member that it specializes or
4475  * from which it was instantiated. Otherwise, returns a NULL cursor.
4476  */
4478 
4479 /**
4480  * \brief Given a cursor that references something else, return the source range
4481  * covering that reference.
4482  *
4483  * \param C A cursor pointing to a member reference, a declaration reference, or
4484  * an operator call.
4485  * \param NameFlags A bitset with three independent flags:
4486  * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
4487  * CXNameRange_WantSinglePiece.
4488  * \param PieceIndex For contiguous names or when passing the flag
4489  * CXNameRange_WantSinglePiece, only one piece with index 0 is
4490  * available. When the CXNameRange_WantSinglePiece flag is not passed for a
4491  * non-contiguous names, this index can be used to retrieve the individual
4492  * pieces of the name. See also CXNameRange_WantSinglePiece.
4493  *
4494  * \returns The piece of the name pointed to by the given cursor. If there is no
4495  * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
4496  */
4498  unsigned NameFlags,
4499  unsigned PieceIndex);
4500 
4502  /**
4503  * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
4504  * range.
4505  */
4507 
4508  /**
4509  * \brief Include the explicit template arguments, e.g. <int> in x.f<int>,
4510  * in the range.
4511  */
4513 
4514  /**
4515  * \brief If the name is non-contiguous, return the full spanning range.
4516  *
4517  * Non-contiguous names occur in Objective-C when a selector with two or more
4518  * parameters is used, or in C++ when using an operator:
4519  * \code
4520  * [object doSomething:here withValue:there]; // Objective-C
4521  * return some_vector[1]; // C++
4522  * \endcode
4523  */
4525 };
4526 
4527 /**
4528  * @}
4529  */
4530 
4531 /**
4532  * \defgroup CINDEX_LEX Token extraction and manipulation
4533  *
4534  * The routines in this group provide access to the tokens within a
4535  * translation unit, along with a semantic mapping of those tokens to
4536  * their corresponding cursors.
4537  *
4538  * @{
4539  */
4540 
4541 /**
4542  * \brief Describes a kind of token.
4543  */
4544 typedef enum CXTokenKind {
4545  /**
4546  * \brief A token that contains some kind of punctuation.
4547  */
4549 
4550  /**
4551  * \brief A language keyword.
4552  */
4554 
4555  /**
4556  * \brief An identifier (that is not a keyword).
4557  */
4559 
4560  /**
4561  * \brief A numeric, string, or character literal.
4562  */
4564 
4565  /**
4566  * \brief A comment.
4567  */
4569 } CXTokenKind;
4570 
4571 /**
4572  * \brief Describes a single preprocessing token.
4573  */
4574 typedef struct {
4575  unsigned int_data[4];
4576  void *ptr_data;
4577 } CXToken;
4578 
4579 /**
4580  * \brief Determine the kind of the given token.
4581  */
4583 
4584 /**
4585  * \brief Determine the spelling of the given token.
4586  *
4587  * The spelling of a token is the textual representation of that token, e.g.,
4588  * the text of an identifier or keyword.
4589  */
4591 
4592 /**
4593  * \brief Retrieve the source location of the given token.
4594  */
4596  CXToken);
4597 
4598 /**
4599  * \brief Retrieve a source range that covers the given token.
4600  */
4602 
4603 /**
4604  * \brief Tokenize the source code described by the given range into raw
4605  * lexical tokens.
4606  *
4607  * \param TU the translation unit whose text is being tokenized.
4608  *
4609  * \param Range the source range in which text should be tokenized. All of the
4610  * tokens produced by tokenization will fall within this source range,
4611  *
4612  * \param Tokens this pointer will be set to point to the array of tokens
4613  * that occur within the given source range. The returned pointer must be
4614  * freed with clang_disposeTokens() before the translation unit is destroyed.
4615  *
4616  * \param NumTokens will be set to the number of tokens in the \c *Tokens
4617  * array.
4618  *
4619  */
4620 CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
4621  CXToken **Tokens, unsigned *NumTokens);
4622 
4623 /**
4624  * \brief Annotate the given set of tokens by providing cursors for each token
4625  * that can be mapped to a specific entity within the abstract syntax tree.
4626  *
4627  * This token-annotation routine is equivalent to invoking
4628  * clang_getCursor() for the source locations of each of the
4629  * tokens. The cursors provided are filtered, so that only those
4630  * cursors that have a direct correspondence to the token are
4631  * accepted. For example, given a function call \c f(x),
4632  * clang_getCursor() would provide the following cursors:
4633  *
4634  * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
4635  * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
4636  * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
4637  *
4638  * Only the first and last of these cursors will occur within the
4639  * annotate, since the tokens "f" and "x' directly refer to a function
4640  * and a variable, respectively, but the parentheses are just a small
4641  * part of the full syntax of the function call expression, which is
4642  * not provided as an annotation.
4643  *
4644  * \param TU the translation unit that owns the given tokens.
4645  *
4646  * \param Tokens the set of tokens to annotate.
4647  *
4648  * \param NumTokens the number of tokens in \p Tokens.
4649  *
4650  * \param Cursors an array of \p NumTokens cursors, whose contents will be
4651  * replaced with the cursors corresponding to each token.
4652  */
4653 CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
4654  CXToken *Tokens, unsigned NumTokens,
4655  CXCursor *Cursors);
4656 
4657 /**
4658  * \brief Free the given set of tokens.
4659  */
4660 CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
4661  CXToken *Tokens, unsigned NumTokens);
4662 
4663 /**
4664  * @}
4665  */
4666 
4667 /**
4668  * \defgroup CINDEX_DEBUG Debugging facilities
4669  *
4670  * These routines are used for testing and debugging, only, and should not
4671  * be relied upon.
4672  *
4673  * @{
4674  */
4675 
4676 /* for debug/testing */
4679  const char **startBuf,
4680  const char **endBuf,
4681  unsigned *startLine,
4682  unsigned *startColumn,
4683  unsigned *endLine,
4684  unsigned *endColumn);
4686 CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
4687  unsigned stack_size);
4688 
4689 /**
4690  * @}
4691  */
4692 
4693 /**
4694  * \defgroup CINDEX_CODE_COMPLET Code completion
4695  *
4696  * Code completion involves taking an (incomplete) source file, along with
4697  * knowledge of where the user is actively editing that file, and suggesting
4698  * syntactically- and semantically-valid constructs that the user might want to
4699  * use at that particular point in the source code. These data structures and
4700  * routines provide support for code completion.
4701  *
4702  * @{
4703  */
4704 
4705 /**
4706  * \brief A semantic string that describes a code-completion result.
4707  *
4708  * A semantic string that describes the formatting of a code-completion
4709  * result as a single "template" of text that should be inserted into the
4710  * source buffer when a particular code-completion result is selected.
4711  * Each semantic string is made up of some number of "chunks", each of which
4712  * contains some text along with a description of what that text means, e.g.,
4713  * the name of the entity being referenced, whether the text chunk is part of
4714  * the template, or whether it is a "placeholder" that the user should replace
4715  * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
4716  * description of the different kinds of chunks.
4717  */
4718 typedef void *CXCompletionString;
4719 
4720 /**
4721  * \brief A single result of code completion.
4722  */
4723 typedef struct {
4724  /**
4725  * \brief The kind of entity that this completion refers to.
4726  *
4727  * The cursor kind will be a macro, keyword, or a declaration (one of the
4728  * *Decl cursor kinds), describing the entity that the completion is
4729  * referring to.
4730  *
4731  * \todo In the future, we would like to provide a full cursor, to allow
4732  * the client to extract additional information from declaration.
4733  */
4734  enum CXCursorKind CursorKind;
4735 
4736  /**
4737  * \brief The code-completion string that describes how to insert this
4738  * code-completion result into the editing buffer.
4739  */
4740  CXCompletionString CompletionString;
4742 
4743 /**
4744  * \brief Describes a single piece of text within a code-completion string.
4745  *
4746  * Each "chunk" within a code-completion string (\c CXCompletionString) is
4747  * either a piece of text with a specific "kind" that describes how that text
4748  * should be interpreted by the client or is another completion string.
4749  */
4751  /**
4752  * \brief A code-completion string that describes "optional" text that
4753  * could be a part of the template (but is not required).
4754  *
4755  * The Optional chunk is the only kind of chunk that has a code-completion
4756  * string for its representation, which is accessible via
4757  * \c clang_getCompletionChunkCompletionString(). The code-completion string
4758  * describes an additional part of the template that is completely optional.
4759  * For example, optional chunks can be used to describe the placeholders for
4760  * arguments that match up with defaulted function parameters, e.g. given:
4761  *
4762  * \code
4763  * void f(int x, float y = 3.14, double z = 2.71828);
4764  * \endcode
4765  *
4766  * The code-completion string for this function would contain:
4767  * - a TypedText chunk for "f".
4768  * - a LeftParen chunk for "(".
4769  * - a Placeholder chunk for "int x"
4770  * - an Optional chunk containing the remaining defaulted arguments, e.g.,
4771  * - a Comma chunk for ","
4772  * - a Placeholder chunk for "float y"
4773  * - an Optional chunk containing the last defaulted argument:
4774  * - a Comma chunk for ","
4775  * - a Placeholder chunk for "double z"
4776  * - a RightParen chunk for ")"
4777  *
4778  * There are many ways to handle Optional chunks. Two simple approaches are:
4779  * - Completely ignore optional chunks, in which case the template for the
4780  * function "f" would only include the first parameter ("int x").
4781  * - Fully expand all optional chunks, in which case the template for the
4782  * function "f" would have all of the parameters.
4783  */
4785  /**
4786  * \brief Text that a user would be expected to type to get this
4787  * code-completion result.
4788  *
4789  * There will be exactly one "typed text" chunk in a semantic string, which
4790  * will typically provide the spelling of a keyword or the name of a
4791  * declaration that could be used at the current code point. Clients are
4792  * expected to filter the code-completion results based on the text in this
4793  * chunk.
4794  */
4796  /**
4797  * \brief Text that should be inserted as part of a code-completion result.
4798  *
4799  * A "text" chunk represents text that is part of the template to be
4800  * inserted into user code should this particular code-completion result
4801  * be selected.
4802  */
4804  /**
4805  * \brief Placeholder text that should be replaced by the user.
4806  *
4807  * A "placeholder" chunk marks a place where the user should insert text
4808  * into the code-completion template. For example, placeholders might mark
4809  * the function parameters for a function declaration, to indicate that the
4810  * user should provide arguments for each of those parameters. The actual
4811  * text in a placeholder is a suggestion for the text to display before
4812  * the user replaces the placeholder with real code.
4813  */
4815  /**
4816  * \brief Informative text that should be displayed but never inserted as
4817  * part of the template.
4818  *
4819  * An "informative" chunk contains annotations that can be displayed to
4820  * help the user decide whether a particular code-completion result is the
4821  * right option, but which is not part of the actual template to be inserted
4822  * by code completion.
4823  */
4825  /**
4826  * \brief Text that describes the current parameter when code-completion is
4827  * referring to function call, message send, or template specialization.
4828  *
4829  * A "current parameter" chunk occurs when code-completion is providing
4830  * information about a parameter corresponding to the argument at the
4831  * code-completion point. For example, given a function
4832  *
4833  * \code
4834  * int add(int x, int y);
4835  * \endcode
4836  *
4837  * and the source code \c add(, where the code-completion point is after the
4838  * "(", the code-completion string will contain a "current parameter" chunk
4839  * for "int x", indicating that the current argument will initialize that
4840  * parameter. After typing further, to \c add(17, (where the code-completion
4841  * point is after the ","), the code-completion string will contain a
4842  * "current paremeter" chunk to "int y".
4843  */
4845  /**
4846  * \brief A left parenthesis ('('), used to initiate a function call or
4847  * signal the beginning of a function parameter list.
4848  */
4850  /**
4851  * \brief A right parenthesis (')'), used to finish a function call or
4852  * signal the end of a function parameter list.
4853  */
4855  /**
4856  * \brief A left bracket ('[').
4857  */
4859  /**
4860  * \brief A right bracket (']').
4861  */
4863  /**
4864  * \brief A left brace ('{').
4865  */
4867  /**
4868  * \brief A right brace ('}').
4869  */
4871  /**
4872  * \brief A left angle bracket ('<').
4873  */
4875  /**
4876  * \brief A right angle bracket ('>').
4877  */
4879  /**
4880  * \brief A comma separator (',').
4881  */
4883  /**
4884  * \brief Text that specifies the result type of a given result.
4885  *
4886  * This special kind of informative chunk is not meant to be inserted into
4887  * the text buffer. Rather, it is meant to illustrate the type that an
4888  * expression using the given completion string would have.
4889  */
4891  /**
4892  * \brief A colon (':').
4893  */
4895  /**
4896  * \brief A semicolon (';').
4897  */
4899  /**
4900  * \brief An '=' sign.
4901  */
4903  /**
4904  * Horizontal space (' ').
4905  */
4907  /**
4908  * Vertical space ('\\n'), after which it is generally a good idea to
4909  * perform indentation.
4910  */
4912 };
4913 
4914 /**
4915  * \brief Determine the kind of a particular chunk within a completion string.
4916  *
4917  * \param completion_string the completion string to query.
4918  *
4919  * \param chunk_number the 0-based index of the chunk in the completion string.
4920  *
4921  * \returns the kind of the chunk at the index \c chunk_number.
4922  */
4924 clang_getCompletionChunkKind(CXCompletionString completion_string,
4925  unsigned chunk_number);
4926 
4927 /**
4928  * \brief Retrieve the text associated with a particular chunk within a
4929  * completion string.
4930  *
4931  * \param completion_string the completion string to query.
4932  *
4933  * \param chunk_number the 0-based index of the chunk in the completion string.
4934  *
4935  * \returns the text associated with the chunk at index \c chunk_number.
4936  */
4938 clang_getCompletionChunkText(CXCompletionString completion_string,
4939  unsigned chunk_number);
4940 
4941 /**
4942  * \brief Retrieve the completion string associated with a particular chunk
4943  * within a completion string.
4944  *
4945  * \param completion_string the completion string to query.
4946  *
4947  * \param chunk_number the 0-based index of the chunk in the completion string.
4948  *
4949  * \returns the completion string associated with the chunk at index
4950  * \c chunk_number.
4951  */
4952 CINDEX_LINKAGE CXCompletionString
4953 clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
4954  unsigned chunk_number);
4955 
4956 /**
4957  * \brief Retrieve the number of chunks in the given code-completion string.
4958  */
4959 CINDEX_LINKAGE unsigned
4960 clang_getNumCompletionChunks(CXCompletionString completion_string);
4961 
4962 /**
4963  * \brief Determine the priority of this code completion.
4964  *
4965  * The priority of a code completion indicates how likely it is that this
4966  * particular completion is the completion that the user will select. The
4967  * priority is selected by various internal heuristics.
4968  *
4969  * \param completion_string The completion string to query.
4970  *
4971  * \returns The priority of this completion string. Smaller values indicate
4972  * higher-priority (more likely) completions.
4973  */
4974 CINDEX_LINKAGE unsigned
4975 clang_getCompletionPriority(CXCompletionString completion_string);
4976 
4977 /**
4978  * \brief Determine the availability of the entity that this code-completion
4979  * string refers to.
4980  *
4981  * \param completion_string The completion string to query.
4982  *
4983  * \returns The availability of the completion string.
4984  */
4986 clang_getCompletionAvailability(CXCompletionString completion_string);
4987 
4988 /**
4989  * \brief Retrieve the number of annotations associated with the given
4990  * completion string.
4991  *
4992  * \param completion_string the completion string to query.
4993  *
4994  * \returns the number of annotations associated with the given completion
4995  * string.
4996  */
4997 CINDEX_LINKAGE unsigned
4998 clang_getCompletionNumAnnotations(CXCompletionString completion_string);
4999 
5000 /**
5001  * \brief Retrieve the annotation associated with the given completion string.
5002  *
5003  * \param completion_string the completion string to query.
5004  *
5005  * \param annotation_number the 0-based index of the annotation of the
5006  * completion string.
5007  *
5008  * \returns annotation string associated with the completion at index
5009  * \c annotation_number, or a NULL string if that annotation is not available.
5010  */
5012 clang_getCompletionAnnotation(CXCompletionString completion_string,
5013  unsigned annotation_number);
5014 
5015 /**
5016  * \brief Retrieve the parent context of the given completion string.
5017  *
5018  * The parent context of a completion string is the semantic parent of
5019  * the declaration (if any) that the code completion represents. For example,
5020  * a code completion for an Objective-C method would have the method's class
5021  * or protocol as its context.
5022  *
5023  * \param completion_string The code completion string whose parent is
5024  * being queried.
5025  *
5026  * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
5027  *
5028  * \returns The name of the completion parent, e.g., "NSObject" if
5029  * the completion string represents a method in the NSObject class.
5030  */
5032 clang_getCompletionParent(CXCompletionString completion_string,
5033  enum CXCursorKind *kind);
5034 
5035 /**
5036  * \brief Retrieve the brief documentation comment attached to the declaration
5037  * that corresponds to the given completion string.
5038  */
5040 clang_getCompletionBriefComment(CXCompletionString completion_string);
5041 
5042 /**
5043  * \brief Retrieve a completion string for an arbitrary declaration or macro
5044  * definition cursor.
5045  *
5046  * \param cursor The cursor to query.
5047  *
5048  * \returns A non-context-sensitive completion string for declaration and macro
5049  * definition cursors, or NULL for other kinds of cursors.
5050  */
5051 CINDEX_LINKAGE CXCompletionString
5053 
5054 /**
5055  * \brief Contains the results of code-completion.
5056  *
5057  * This data structure contains the results of code completion, as
5058  * produced by \c clang_codeCompleteAt(). Its contents must be freed by
5059  * \c clang_disposeCodeCompleteResults.
5060  */
5061 typedef struct {
5062  /**
5063  * \brief The code-completion results.
5064  */
5066 
5067  /**
5068  * \brief The number of code-completion results stored in the
5069  * \c Results array.
5070  */
5071  unsigned NumResults;
5073 
5074 /**
5075  * \brief Flags that can be passed to \c clang_codeCompleteAt() to
5076  * modify its behavior.
5077  *
5078  * The enumerators in this enumeration can be bitwise-OR'd together to
5079  * provide multiple options to \c clang_codeCompleteAt().
5080  */
5082  /**
5083  * \brief Whether to include macros within the set of code
5084  * completions returned.
5085  */
5087 
5088  /**
5089  * \brief Whether to include code patterns for language constructs
5090  * within the set of code completions, e.g., for loops.
5091  */
5093 
5094  /**
5095  * \brief Whether to include brief documentation within the set of code
5096  * completions returned.
5097  */
5099 };
5100 
5101 /**
5102  * \brief Bits that represent the context under which completion is occurring.
5103  *
5104  * The enumerators in this enumeration may be bitwise-OR'd together if multiple
5105  * contexts are occurring simultaneously.
5106  */
5108  /**
5109  * \brief The context for completions is unexposed, as only Clang results
5110  * should be included. (This is equivalent to having no context bits set.)
5111  */
5113 
5114  /**
5115  * \brief Completions for any possible type should be included in the results.
5116  */
5118 
5119  /**
5120  * \brief Completions for any possible value (variables, function calls, etc.)
5121  * should be included in the results.
5122  */
5124  /**
5125  * \brief Completions for values that resolve to an Objective-C object should
5126  * be included in the results.
5127  */
5129  /**
5130  * \brief Completions for values that resolve to an Objective-C selector
5131  * should be included in the results.
5132  */
5134  /**
5135  * \brief Completions for values that resolve to a C++ class type should be
5136  * included in the results.
5137  */
5139 
5140  /**
5141  * \brief Completions for fields of the member being accessed using the dot
5142  * operator should be included in the results.
5143  */
5145  /**
5146  * \brief Completions for fields of the member being accessed using the arrow
5147  * operator should be included in the results.
5148  */
5150  /**
5151  * \brief Completions for properties of the Objective-C object being accessed
5152  * using the dot operator should be included in the results.
5153  */
5155 
5156  /**
5157  * \brief Completions for enum tags should be included in the results.
5158  */
5160  /**
5161  * \brief Completions for union tags should be included in the results.
5162  */
5164  /**
5165  * \brief Completions for struct tags should be included in the results.
5166  */
5168 
5169  /**
5170  * \brief Completions for C++ class names should be included in the results.
5171  */
5173  /**
5174  * \brief Completions for C++ namespaces and namespace aliases should be
5175  * included in the results.
5176  */
5178  /**
5179  * \brief Completions for C++ nested name specifiers should be included in
5180  * the results.
5181  */
5183 
5184  /**
5185  * \brief Completions for Objective-C interfaces (classes) should be included
5186  * in the results.
5187  */
5189  /**
5190  * \brief Completions for Objective-C protocols should be included in
5191  * the results.
5192  */
5194  /**
5195  * \brief Completions for Objective-C categories should be included in
5196  * the results.
5197  */
5199  /**
5200  * \brief Completions for Objective-C instance messages should be included
5201  * in the results.
5202  */
5204  /**
5205  * \brief Completions for Objective-C class messages should be included in
5206  * the results.
5207  */
5209  /**
5210  * \brief Completions for Objective-C selector names should be included in
5211  * the results.
5212  */
5214 
5215  /**
5216  * \brief Completions for preprocessor macro names should be included in
5217  * the results.
5218  */
5220 
5221  /**
5222  * \brief Natural language completions should be included in the results.
5223  */
5225 
5226  /**
5227  * \brief The current context is unknown, so set all contexts.
5228  */
5230 };
5231 
5232 /**
5233  * \brief Returns a default set of code-completion options that can be
5234  * passed to\c clang_codeCompleteAt().
5235  */
5237 
5238 /**
5239  * \brief Perform code completion at a given location in a translation unit.
5240  *
5241  * This function performs code completion at a particular file, line, and
5242  * column within source code, providing results that suggest potential
5243  * code snippets based on the context of the completion. The basic model
5244  * for code completion is that Clang will parse a complete source file,
5245  * performing syntax checking up to the location where code-completion has
5246  * been requested. At that point, a special code-completion token is passed
5247  * to the parser, which recognizes this token and determines, based on the
5248  * current location in the C/Objective-C/C++ grammar and the state of
5249  * semantic analysis, what completions to provide. These completions are
5250  * returned via a new \c CXCodeCompleteResults structure.
5251  *
5252  * Code completion itself is meant to be triggered by the client when the
5253  * user types punctuation characters or whitespace, at which point the
5254  * code-completion location will coincide with the cursor. For example, if \c p
5255  * is a pointer, code-completion might be triggered after the "-" and then
5256  * after the ">" in \c p->. When the code-completion location is afer the ">",
5257  * the completion results will provide, e.g., the members of the struct that
5258  * "p" points to. The client is responsible for placing the cursor at the
5259  * beginning of the token currently being typed, then filtering the results
5260  * based on the contents of the token. For example, when code-completing for
5261  * the expression \c p->get, the client should provide the location just after
5262  * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
5263  * client can filter the results based on the current token text ("get"), only
5264  * showing those results that start with "get". The intent of this interface
5265  * is to separate the relatively high-latency acquisition of code-completion
5266  * results from the filtering of results on a per-character basis, which must
5267  * have a lower latency.
5268  *
5269  * \param TU The translation unit in which code-completion should
5270  * occur. The source files for this translation unit need not be
5271  * completely up-to-date (and the contents of those source files may
5272  * be overridden via \p unsaved_files). Cursors referring into the
5273  * translation unit may be invalidated by this invocation.
5274  *
5275  * \param complete_filename The name of the source file where code
5276  * completion should be performed. This filename may be any file
5277  * included in the translation unit.
5278  *
5279  * \param complete_line The line at which code-completion should occur.
5280  *
5281  * \param complete_column The column at which code-completion should occur.
5282  * Note that the column should point just after the syntactic construct that
5283  * initiated code completion, and not in the middle of a lexical token.
5284  *
5285  * \param unsaved_files the Files that have not yet been saved to disk
5286  * but may be required for parsing or code completion, including the
5287  * contents of those files. The contents and name of these files (as
5288  * specified by CXUnsavedFile) are copied when necessary, so the
5289  * client only needs to guarantee their validity until the call to
5290  * this function returns.
5291  *
5292  * \param num_unsaved_files The number of unsaved file entries in \p
5293  * unsaved_files.
5294  *
5295  * \param options Extra options that control the behavior of code
5296  * completion, expressed as a bitwise OR of the enumerators of the
5297  * CXCodeComplete_Flags enumeration. The
5298  * \c clang_defaultCodeCompleteOptions() function returns a default set
5299  * of code-completion options.
5300  *
5301  * \returns If successful, a new \c CXCodeCompleteResults structure
5302  * containing code-completion results, which should eventually be
5303  * freed with \c clang_disposeCodeCompleteResults(). If code
5304  * completion fails, returns NULL.
5305  */
5307 CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
5308  const char *complete_filename,
5309  unsigned complete_line,
5310  unsigned complete_column,
5311  struct CXUnsavedFile *unsaved_files,
5312  unsigned num_unsaved_files,
5313  unsigned options);
5314 
5315 /**
5316  * \brief Sort the code-completion results in case-insensitive alphabetical
5317  * order.
5318  *
5319  * \param Results The set of results to sort.
5320  * \param NumResults The number of results in \p Results.
5321  */
5324  unsigned NumResults);
5325 
5326 /**
5327  * \brief Free the given set of code-completion results.
5328  */
5331 
5332 /**
5333  * \brief Determine the number of diagnostics produced prior to the
5334  * location where code completion was performed.
5335  */
5338 
5339 /**
5340  * \brief Retrieve a diagnostic associated with the given code completion.
5341  *
5342  * \param Results the code completion results to query.
5343  * \param Index the zero-based diagnostic number to retrieve.
5344  *
5345  * \returns the requested diagnostic. This diagnostic must be freed
5346  * via a call to \c clang_disposeDiagnostic().
5347  */
5350  unsigned Index);
5351 
5352 /**
5353  * \brief Determines what completions are appropriate for the context
5354  * the given code completion.
5355  *
5356  * \param Results the code completion results to query
5357  *
5358  * \returns the kinds of completions that are appropriate for use
5359  * along with the given code completion results.
5360  */
5362 unsigned long long clang_codeCompleteGetContexts(
5363  CXCodeCompleteResults *Results);
5364 
5365 /**
5366  * \brief Returns the cursor kind for the container for the current code
5367  * completion context. The container is only guaranteed to be set for
5368  * contexts where a container exists (i.e. member accesses or Objective-C
5369  * message sends); if there is not a container, this function will return
5370  * CXCursor_InvalidCode.
5371  *
5372  * \param Results the code completion results to query
5373  *
5374  * \param IsIncomplete on return, this value will be false if Clang has complete
5375  * information about the container. If Clang does not have complete
5376  * information, this value will be true.
5377  *
5378  * \returns the container kind, or CXCursor_InvalidCode if there is not a
5379  * container
5380  */
5383  CXCodeCompleteResults *Results,
5384  unsigned *IsIncomplete);
5385 
5386 /**
5387  * \brief Returns the USR for the container for the current code completion
5388  * context. If there is not a container for the current context, this
5389  * function will return the empty string.
5390  *
5391  * \param Results the code completion results to query
5392  *
5393  * \returns the USR for the container
5394  */
5397 
5398 /**
5399  * \brief Returns the currently-entered selector for an Objective-C message
5400  * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
5401  * non-empty string for CXCompletionContext_ObjCInstanceMessage and
5402  * CXCompletionContext_ObjCClassMessage.
5403  *
5404  * \param Results the code completion results to query
5405  *
5406  * \returns the selector (or partial selector) that has been entered thus far
5407  * for an Objective-C message send.
5408  */
5411 
5412 /**
5413  * @}
5414  */
5415 
5416 /**
5417  * \defgroup CINDEX_MISC Miscellaneous utility functions
5418  *
5419  * @{
5420  */
5421 
5422 /**
5423  * \brief Return a version string, suitable for showing to a user, but not
5424  * intended to be parsed (the format is not guaranteed to be stable).
5425  */
5427 
5428 /**
5429  * \brief Enable/disable crash recovery.
5430  *
5431  * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero
5432  * value enables crash recovery, while 0 disables it.
5433  */
5435 
5436  /**
5437  * \brief Visitor invoked for each file in a translation unit
5438  * (used with clang_getInclusions()).
5439  *
5440  * This visitor function will be invoked by clang_getInclusions() for each
5441  * file included (either at the top-level or by \#include directives) within
5442  * a translation unit. The first argument is the file being included, and
5443  * the second and third arguments provide the inclusion stack. The
5444  * array is sorted in order of immediate inclusion. For example,
5445  * the first element refers to the location that included 'included_file'.
5446  */
5447 typedef void (*CXInclusionVisitor)(CXFile included_file,
5448  CXSourceLocation* inclusion_stack,
5449  unsigned include_len,
5450  CXClientData client_data);
5451 
5452 /**
5453  * \brief Visit the set of preprocessor inclusions in a translation unit.
5454  * The visitor function is called with the provided data for every included
5455  * file. This does not include headers included by the PCH file (unless one
5456  * is inspecting the inclusions in the PCH file itself).
5457  */
5458 CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
5459  CXInclusionVisitor visitor,
5460  CXClientData client_data);
5461 
5462 typedef enum {
5469 
5471 
5472 } CXEvalResultKind ;
5473 
5474 /**
5475  * \brief Evaluation result of a cursor
5476  */
5477 typedef void * CXEvalResult;
5478 
5479 /**
5480  * \brief If cursor is a statement declaration tries to evaluate the
5481  * statement and if its variable, tries to evaluate its initializer,
5482  * into its corresponding type.
5483  */
5485 
5486 /**
5487  * \brief Returns the kind of the evaluated result.
5488  */
5490 
5491 /**
5492  * \brief Returns the evaluation result as integer if the
5493  * kind is Int.
5494  */
5495 CINDEX_LINKAGE int clang_EvalResult_getAsInt(CXEvalResult E);
5496 
5497 /**
5498  * \brief Returns the evaluation result as a long long integer if the
5499  * kind is Int. This prevents overflows that may happen if the result is
5500  * returned with clang_EvalResult_getAsInt.
5501  */
5502 CINDEX_LINKAGE long long clang_EvalResult_getAsLongLong(CXEvalResult E);
5503 
5504 /**
5505  * \brief Returns a non-zero value if the kind is Int and the evaluation
5506  * result resulted in an unsigned integer.
5507  */
5508 CINDEX_LINKAGE unsigned clang_EvalResult_isUnsignedInt(CXEvalResult E);
5509 
5510 /**
5511  * \brief Returns the evaluation result as an unsigned integer if
5512  * the kind is Int and clang_EvalResult_isUnsignedInt is non-zero.
5513  */
5514 CINDEX_LINKAGE unsigned long long clang_EvalResult_getAsUnsigned(CXEvalResult E);
5515 
5516 /**
5517  * \brief Returns the evaluation result as double if the
5518  * kind is double.
5519  */
5520 CINDEX_LINKAGE double clang_EvalResult_getAsDouble(CXEvalResult E);
5521 
5522 /**
5523  * \brief Returns the evaluation result as a constant string if the
5524  * kind is other than Int or float. User must not free this pointer,
5525  * instead call clang_EvalResult_dispose on the CXEvalResult returned
5526  * by clang_Cursor_Evaluate.
5527  */
5528 CINDEX_LINKAGE const char* clang_EvalResult_getAsStr(CXEvalResult E);
5529 
5530 /**
5531  * \brief Disposes the created Eval memory.
5532  */
5533 CINDEX_LINKAGE void clang_EvalResult_dispose(CXEvalResult E);
5534 /**
5535  * @}
5536  */
5537 
5538 /** \defgroup CINDEX_REMAPPING Remapping functions
5539  *
5540  * @{
5541  */
5542 
5543 /**
5544  * \brief A remapping of original source files and their translated files.
5545  */
5546 typedef void *CXRemapping;
5547 
5548 /**
5549  * \brief Retrieve a remapping.
5550  *
5551  * \param path the path that contains metadata about remappings.
5552  *
5553  * \returns the requested remapping. This remapping must be freed
5554  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5555  */
5556 CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
5557 
5558 /**
5559  * \brief Retrieve a remapping.
5560  *
5561  * \param filePaths pointer to an array of file paths containing remapping info.
5562  *
5563  * \param numFiles number of file paths.
5564  *
5565  * \returns the requested remapping. This remapping must be freed
5566  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5567  */
5569 CXRemapping clang_getRemappingsFromFileList(const char **filePaths,
5570  unsigned numFiles);
5571 
5572 /**
5573  * \brief Determine the number of remappings.
5574  */
5575 CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
5576 
5577 /**
5578  * \brief Get the original and the associated filename from the remapping.
5579  *
5580  * \param original If non-NULL, will be set to the original filename.
5581  *
5582  * \param transformed If non-NULL, will be set to the filename that the original
5583  * is associated with.
5584  */
5585 CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
5586  CXString *original, CXString *transformed);
5587 
5588 /**
5589  * \brief Dispose the remapping.
5590  */
5591 CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
5592 
5593 /**
5594  * @}
5595  */
5596 
5597 /** \defgroup CINDEX_HIGH Higher level API functions
5598  *
5599  * @{
5600  */
5601 
5605 };
5606 
5607 typedef struct CXCursorAndRangeVisitor {
5608  void *context;
5609  enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
5611 
5612 typedef enum {
5613  /**
5614  * \brief Function returned successfully.
5615  */
5617  /**
5618  * \brief One of the parameters was invalid for the function.
5619  */
5621  /**
5622  * \brief The function was terminated by a callback (e.g. it returned
5623  * CXVisit_Break)
5624  */
5626 
5627 } CXResult;
5628 
5629 /**
5630  * \brief Find references of a declaration in a specific file.
5631  *
5632  * \param cursor pointing to a declaration or a reference of one.
5633  *
5634  * \param file to search for references.
5635  *
5636  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5637  * each reference found.
5638  * The CXSourceRange will point inside the file; if the reference is inside
5639  * a macro (and not a macro argument) the CXSourceRange will be invalid.
5640  *
5641  * \returns one of the CXResult enumerators.
5642  */
5644  CXCursorAndRangeVisitor visitor);
5645 
5646 /**
5647  * \brief Find #import/#include directives in a specific file.
5648  *
5649  * \param TU translation unit containing the file to query.
5650  *
5651  * \param file to search for #import/#include directives.
5652  *
5653  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5654  * each directive found.
5655  *
5656  * \returns one of the CXResult enumerators.
5657  */
5658 CINDEX_LINKAGE CXResult clang_findIncludesInFile(CXTranslationUnit TU,
5659  CXFile file,
5660  CXCursorAndRangeVisitor visitor);
5661 
5662 #ifdef __has_feature
5663 # if __has_feature(blocks)
5664 
5665 typedef enum CXVisitorResult
5666  (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange);
5667 
5669 CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile,
5670  CXCursorAndRangeVisitorBlock);
5671 
5673 CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile,
5674  CXCursorAndRangeVisitorBlock);
5675 
5676 # endif
5677 #endif
5678 
5679 /**
5680  * \brief The client's data object that is associated with a CXFile.
5681  */
5682 typedef void *CXIdxClientFile;
5683 
5684 /**
5685  * \brief The client's data object that is associated with a semantic entity.
5686  */
5687 typedef void *CXIdxClientEntity;
5688 
5689 /**
5690  * \brief The client's data object that is associated with a semantic container
5691  * of entities.
5692  */
5693 typedef void *CXIdxClientContainer;
5694 
5695 /**
5696  * \brief The client's data object that is associated with an AST file (PCH
5697  * or module).
5698  */
5699 typedef void *CXIdxClientASTFile;
5700 
5701 /**
5702  * \brief Source location passed to index callbacks.
5703  */
5704 typedef struct {
5705  void *ptr_data[2];
5706  unsigned int_data;
5707 } CXIdxLoc;
5708 
5709 /**
5710  * \brief Data for ppIncludedFile callback.
5711  */
5712 typedef struct {
5713  /**
5714  * \brief Location of '#' in the \#include/\#import directive.
5715  */
5717  /**
5718  * \brief Filename as written in the \#include/\#import directive.
5719  */
5720  const char *filename;
5721  /**
5722  * \brief The actual file that the \#include/\#import directive resolved to.
5723  */
5724  CXFile file;
5727  /**
5728  * \brief Non-zero if the directive was automatically turned into a module
5729  * import.
5730  */
5733 
5734 /**
5735  * \brief Data for IndexerCallbacks#importedASTFile.
5736