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