clang  3.7.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 30
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 /**
290  * \brief Retrieve the complete file and path name of the given file.
291  */
293 
294 /**
295  * \brief Retrieve the last modification time of the given file.
296  */
297 CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile);
298 
299 /**
300  * \brief Uniquely identifies a CXFile, that refers to the same underlying file,
301  * across an indexing session.
302  */
303 typedef struct {
304  unsigned long long data[3];
306 
307 /**
308  * \brief Retrieve the unique ID for the given \c file.
309  *
310  * \param file the file to get the ID for.
311  * \param outID stores the returned CXFileUniqueID.
312  * \returns If there was a failure getting the unique ID, returns non-zero,
313  * otherwise returns 0.
314 */
315 CINDEX_LINKAGE int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID);
316 
317 /**
318  * \brief Determine whether the given header is guarded against
319  * multiple inclusions, either with the conventional
320  * \#ifndef/\#define/\#endif macro guards or with \#pragma once.
321  */
322 CINDEX_LINKAGE unsigned
323 clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file);
324 
325 /**
326  * \brief Retrieve a file handle within the given translation unit.
327  *
328  * \param tu the translation unit
329  *
330  * \param file_name the name of the file.
331  *
332  * \returns the file handle for the named file in the translation unit \p tu,
333  * or a NULL file handle if the file was not a part of this translation unit.
334  */
335 CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu,
336  const char *file_name);
337 
338 /**
339  * \brief Returns non-zero if the \c file1 and \c file2 point to the same file,
340  * or they are both NULL.
341  */
342 CINDEX_LINKAGE int clang_File_isEqual(CXFile file1, CXFile file2);
343 
344 /**
345  * @}
346  */
347 
348 /**
349  * \defgroup CINDEX_LOCATIONS Physical source locations
350  *
351  * Clang represents physical source locations in its abstract syntax tree in
352  * great detail, with file, line, and column information for the majority of
353  * the tokens parsed in the source code. These data types and functions are
354  * used to represent source location information, either for a particular
355  * point in the program or for a range of points in the program, and extract
356  * specific location information from those data types.
357  *
358  * @{
359  */
360 
361 /**
362  * \brief Identifies a specific source location within a translation
363  * unit.
364  *
365  * Use clang_getExpansionLocation() or clang_getSpellingLocation()
366  * to map a source location to a particular file, line, and column.
367  */
368 typedef struct {
369  const void *ptr_data[2];
370  unsigned int_data;
372 
373 /**
374  * \brief Identifies a half-open character range in the source code.
375  *
376  * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the
377  * starting and end locations from a source range, respectively.
378  */
379 typedef struct {
380  const void *ptr_data[2];
381  unsigned begin_int_data;
382  unsigned end_int_data;
383 } CXSourceRange;
384 
385 /**
386  * \brief Retrieve a NULL (invalid) source location.
387  */
389 
390 /**
391  * \brief Determine whether two source locations, which must refer into
392  * the same translation unit, refer to exactly the same point in the source
393  * code.
394  *
395  * \returns non-zero if the source locations refer to the same location, zero
396  * if they refer to different locations.
397  */
399  CXSourceLocation loc2);
400 
401 /**
402  * \brief Retrieves the source location associated with a given file/line/column
403  * in a particular translation unit.
404  */
406  CXFile file,
407  unsigned line,
408  unsigned column);
409 /**
410  * \brief Retrieves the source location associated with a given character offset
411  * in a particular translation unit.
412  */
414  CXFile file,
415  unsigned offset);
416 
417 /**
418  * \brief Returns non-zero if the given source location is in a system header.
419  */
421 
422 /**
423  * \brief Returns non-zero if the given source location is in the main file of
424  * the corresponding translation unit.
425  */
427 
428 /**
429  * \brief Retrieve a NULL (invalid) source range.
430  */
432 
433 /**
434  * \brief Retrieve a source range given the beginning and ending source
435  * locations.
436  */
438  CXSourceLocation end);
439 
440 /**
441  * \brief Determine whether two ranges are equivalent.
442  *
443  * \returns non-zero if the ranges are the same, zero if they differ.
444  */
446  CXSourceRange range2);
447 
448 /**
449  * \brief Returns non-zero if \p range is null.
450  */
452 
453 /**
454  * \brief Retrieve the file, line, column, and offset represented by
455  * the given source location.
456  *
457  * If the location refers into a macro expansion, retrieves the
458  * location of the macro expansion.
459  *
460  * \param location the location within a source file that will be decomposed
461  * into its parts.
462  *
463  * \param file [out] if non-NULL, will be set to the file to which the given
464  * source location points.
465  *
466  * \param line [out] if non-NULL, will be set to the line to which the given
467  * source location points.
468  *
469  * \param column [out] if non-NULL, will be set to the column to which the given
470  * source location points.
471  *
472  * \param offset [out] if non-NULL, will be set to the offset into the
473  * buffer to which the given source location points.
474  */
476  CXFile *file,
477  unsigned *line,
478  unsigned *column,
479  unsigned *offset);
480 
481 /**
482  * \brief Retrieve the file, line, column, and offset represented by
483  * the given source location, as specified in a # line directive.
484  *
485  * Example: given the following source code in a file somefile.c
486  *
487  * \code
488  * #123 "dummy.c" 1
489  *
490  * static int func(void)
491  * {
492  * return 0;
493  * }
494  * \endcode
495  *
496  * the location information returned by this function would be
497  *
498  * File: dummy.c Line: 124 Column: 12
499  *
500  * whereas clang_getExpansionLocation would have returned
501  *
502  * File: somefile.c Line: 3 Column: 12
503  *
504  * \param location the location within a source file that will be decomposed
505  * into its parts.
506  *
507  * \param filename [out] if non-NULL, will be set to the filename of the
508  * source location. Note that filenames returned will be for "virtual" files,
509  * which don't necessarily exist on the machine running clang - e.g. when
510  * parsing preprocessed output obtained from a different environment. If
511  * a non-NULL value is passed in, remember to dispose of the returned value
512  * using \c clang_disposeString() once you've finished with it. For an invalid
513  * source location, an empty string is returned.
514  *
515  * \param line [out] if non-NULL, will be set to the line number of the
516  * source location. For an invalid source location, zero is returned.
517  *
518  * \param column [out] if non-NULL, will be set to the column number of the
519  * source location. For an invalid source location, zero is returned.
520  */
522  CXString *filename,
523  unsigned *line,
524  unsigned *column);
525 
526 /**
527  * \brief Legacy API to retrieve the file, line, column, and offset represented
528  * by the given source location.
529  *
530  * This interface has been replaced by the newer interface
531  * #clang_getExpansionLocation(). See that interface's documentation for
532  * details.
533  */
535  CXFile *file,
536  unsigned *line,
537  unsigned *column,
538  unsigned *offset);
539 
540 /**
541  * \brief Retrieve the file, line, column, and offset represented by
542  * the given source location.
543  *
544  * If the location refers into a macro instantiation, return where the
545  * location was originally spelled in the source file.
546  *
547  * \param location the location within a source file that will be decomposed
548  * into its parts.
549  *
550  * \param file [out] if non-NULL, will be set to the file to which the given
551  * source location points.
552  *
553  * \param line [out] if non-NULL, will be set to the line to which the given
554  * source location points.
555  *
556  * \param column [out] if non-NULL, will be set to the column to which the given
557  * source location points.
558  *
559  * \param offset [out] if non-NULL, will be set to the offset into the
560  * buffer to which the given source location points.
561  */
563  CXFile *file,
564  unsigned *line,
565  unsigned *column,
566  unsigned *offset);
567 
568 /**
569  * \brief Retrieve the file, line, column, and offset represented by
570  * the given source location.
571  *
572  * If the location refers into a macro expansion, return where the macro was
573  * expanded or where the macro argument was written, if the location points at
574  * a macro argument.
575  *
576  * \param location the location within a source file that will be decomposed
577  * into its parts.
578  *
579  * \param file [out] if non-NULL, will be set to the file to which the given
580  * source location points.
581  *
582  * \param line [out] if non-NULL, will be set to the line to which the given
583  * source location points.
584  *
585  * \param column [out] if non-NULL, will be set to the column to which the given
586  * source location points.
587  *
588  * \param offset [out] if non-NULL, will be set to the offset into the
589  * buffer to which the given source location points.
590  */
592  CXFile *file,
593  unsigned *line,
594  unsigned *column,
595  unsigned *offset);
596 
597 /**
598  * \brief Retrieve a source location representing the first character within a
599  * source range.
600  */
602 
603 /**
604  * \brief Retrieve a source location representing the last character within a
605  * source range.
606  */
608 
609 /**
610  * \brief Identifies an array of ranges.
611  */
612 typedef struct {
613  /** \brief The number of ranges in the \c ranges array. */
614  unsigned count;
615  /**
616  * \brief An array of \c CXSourceRanges.
617  */
620 
621 /**
622  * \brief Retrieve all ranges that were skipped by the preprocessor.
623  *
624  * The preprocessor will skip lines when they are surrounded by an
625  * if/ifdef/ifndef directive whose condition does not evaluate to true.
626  */
628  CXFile file);
629 
630 /**
631  * \brief Destroy the given \c CXSourceRangeList.
632  */
634 
635 /**
636  * @}
637  */
638 
639 /**
640  * \defgroup CINDEX_DIAG Diagnostic reporting
641  *
642  * @{
643  */
644 
645 /**
646  * \brief Describes the severity of a particular diagnostic.
647  */
649  /**
650  * \brief A diagnostic that has been suppressed, e.g., by a command-line
651  * option.
652  */
654 
655  /**
656  * \brief This diagnostic is a note that should be attached to the
657  * previous (non-note) diagnostic.
658  */
660 
661  /**
662  * \brief This diagnostic indicates suspicious code that may not be
663  * wrong.
664  */
666 
667  /**
668  * \brief This diagnostic indicates that the code is ill-formed.
669  */
671 
672  /**
673  * \brief This diagnostic indicates that the code is ill-formed such
674  * that future parser recovery is unlikely to produce useful
675  * results.
676  */
678 };
679 
680 /**
681  * \brief A single diagnostic, containing the diagnostic's severity,
682  * location, text, source ranges, and fix-it hints.
683  */
684 typedef void *CXDiagnostic;
685 
686 /**
687  * \brief A group of CXDiagnostics.
688  */
689 typedef void *CXDiagnosticSet;
690 
691 /**
692  * \brief Determine the number of diagnostics in a CXDiagnosticSet.
693  */
694 CINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags);
695 
696 /**
697  * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet.
698  *
699  * \param Diags the CXDiagnosticSet to query.
700  * \param Index the zero-based diagnostic number to retrieve.
701  *
702  * \returns the requested diagnostic. This diagnostic must be freed
703  * via a call to \c clang_disposeDiagnostic().
704  */
705 CINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags,
706  unsigned Index);
707 
708 
709 /**
710  * \brief Describes the kind of error that occurred (if any) in a call to
711  * \c clang_loadDiagnostics.
712  */
714  /**
715  * \brief Indicates that no error occurred.
716  */
718 
719  /**
720  * \brief Indicates that an unknown error occurred while attempting to
721  * deserialize diagnostics.
722  */
724 
725  /**
726  * \brief Indicates that the file containing the serialized diagnostics
727  * could not be opened.
728  */
730 
731  /**
732  * \brief Indicates that the serialized diagnostics file is invalid or
733  * corrupt.
734  */
736 };
737 
738 /**
739  * \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode
740  * file.
741  *
742  * \param file The name of the file to deserialize.
743  * \param error A pointer to a enum value recording if there was a problem
744  * deserializing the diagnostics.
745  * \param errorString A pointer to a CXString for recording the error string
746  * if the file was not successfully loaded.
747  *
748  * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise. These
749  * diagnostics should be released using clang_disposeDiagnosticSet().
750  */
751 CINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file,
752  enum CXLoadDiag_Error *error,
753  CXString *errorString);
754 
755 /**
756  * \brief Release a CXDiagnosticSet and all of its contained diagnostics.
757  */
758 CINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags);
759 
760 /**
761  * \brief Retrieve the child diagnostics of a CXDiagnostic.
762  *
763  * This CXDiagnosticSet does not need to be released by
764  * clang_disposeDiagnosticSet.
765  */
766 CINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D);
767 
768 /**
769  * \brief Determine the number of diagnostics produced for the given
770  * translation unit.
771  */
772 CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit);
773 
774 /**
775  * \brief Retrieve a diagnostic associated with the given translation unit.
776  *
777  * \param Unit the translation unit to query.
778  * \param Index the zero-based diagnostic number to retrieve.
779  *
780  * \returns the requested diagnostic. This diagnostic must be freed
781  * via a call to \c clang_disposeDiagnostic().
782  */
783 CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit,
784  unsigned Index);
785 
786 /**
787  * \brief Retrieve the complete set of diagnostics associated with a
788  * translation unit.
789  *
790  * \param Unit the translation unit to query.
791  */
792 CINDEX_LINKAGE CXDiagnosticSet
793  clang_getDiagnosticSetFromTU(CXTranslationUnit Unit);
794 
795 /**
796  * \brief Destroy a diagnostic.
797  */
798 CINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic);
799 
800 /**
801  * \brief Options to control the display of diagnostics.
802  *
803  * The values in this enum are meant to be combined to customize the
804  * behavior of \c clang_formatDiagnostic().
805  */
807  /**
808  * \brief Display the source-location information where the
809  * diagnostic was located.
810  *
811  * When set, diagnostics will be prefixed by the file, line, and
812  * (optionally) column to which the diagnostic refers. For example,
813  *
814  * \code
815  * test.c:28: warning: extra tokens at end of #endif directive
816  * \endcode
817  *
818  * This option corresponds to the clang flag \c -fshow-source-location.
819  */
821 
822  /**
823  * \brief If displaying the source-location information of the
824  * diagnostic, also include the column number.
825  *
826  * This option corresponds to the clang flag \c -fshow-column.
827  */
829 
830  /**
831  * \brief If displaying the source-location information of the
832  * diagnostic, also include information about source ranges in a
833  * machine-parsable format.
834  *
835  * This option corresponds to the clang flag
836  * \c -fdiagnostics-print-source-range-info.
837  */
839 
840  /**
841  * \brief Display the option name associated with this diagnostic, if any.
842  *
843  * The option name displayed (e.g., -Wconversion) will be placed in brackets
844  * after the diagnostic text. This option corresponds to the clang flag
845  * \c -fdiagnostics-show-option.
846  */
848 
849  /**
850  * \brief Display the category number associated with this diagnostic, if any.
851  *
852  * The category number is displayed within brackets after the diagnostic text.
853  * This option corresponds to the clang flag
854  * \c -fdiagnostics-show-category=id.
855  */
857 
858  /**
859  * \brief Display the category name associated with this diagnostic, if any.
860  *
861  * The category name is displayed within brackets after the diagnostic text.
862  * This option corresponds to the clang flag
863  * \c -fdiagnostics-show-category=name.
864  */
866 };
867 
868 /**
869  * \brief Format the given diagnostic in a manner that is suitable for display.
870  *
871  * This routine will format the given diagnostic to a string, rendering
872  * the diagnostic according to the various options given. The
873  * \c clang_defaultDiagnosticDisplayOptions() function returns the set of
874  * options that most closely mimics the behavior of the clang compiler.
875  *
876  * \param Diagnostic The diagnostic to print.
877  *
878  * \param Options A set of options that control the diagnostic display,
879  * created by combining \c CXDiagnosticDisplayOptions values.
880  *
881  * \returns A new string containing for formatted diagnostic.
882  */
883 CINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic,
884  unsigned Options);
885 
886 /**
887  * \brief Retrieve the set of display options most similar to the
888  * default behavior of the clang compiler.
889  *
890  * \returns A set of display options suitable for use with \c
891  * clang_formatDiagnostic().
892  */
894 
895 /**
896  * \brief Determine the severity of the given diagnostic.
897  */
899 clang_getDiagnosticSeverity(CXDiagnostic);
900 
901 /**
902  * \brief Retrieve the source location of the given diagnostic.
903  *
904  * This location is where Clang would print the caret ('^') when
905  * displaying the diagnostic on the command line.
906  */
908 
909 /**
910  * \brief Retrieve the text of the given diagnostic.
911  */
913 
914 /**
915  * \brief Retrieve the name of the command-line option that enabled this
916  * diagnostic.
917  *
918  * \param Diag The diagnostic to be queried.
919  *
920  * \param Disable If non-NULL, will be set to the option that disables this
921  * diagnostic (if any).
922  *
923  * \returns A string that contains the command-line option used to enable this
924  * warning, such as "-Wconversion" or "-pedantic".
925  */
927  CXString *Disable);
928 
929 /**
930  * \brief Retrieve the category number for this diagnostic.
931  *
932  * Diagnostics can be categorized into groups along with other, related
933  * diagnostics (e.g., diagnostics under the same warning flag). This routine
934  * retrieves the category number for the given diagnostic.
935  *
936  * \returns The number of the category that contains this diagnostic, or zero
937  * if this diagnostic is uncategorized.
938  */
939 CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic);
940 
941 /**
942  * \brief Retrieve the name of a particular diagnostic category. This
943  * is now deprecated. Use clang_getDiagnosticCategoryText()
944  * instead.
945  *
946  * \param Category A diagnostic category number, as returned by
947  * \c clang_getDiagnosticCategory().
948  *
949  * \returns The name of the given diagnostic category.
950  */
952 CXString clang_getDiagnosticCategoryName(unsigned Category);
953 
954 /**
955  * \brief Retrieve the diagnostic category text for a given diagnostic.
956  *
957  * \returns The text of the given diagnostic category.
958  */
960 
961 /**
962  * \brief Determine the number of source ranges associated with the given
963  * diagnostic.
964  */
965 CINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic);
966 
967 /**
968  * \brief Retrieve a source range associated with the diagnostic.
969  *
970  * A diagnostic's source ranges highlight important elements in the source
971  * code. On the command line, Clang displays source ranges by
972  * underlining them with '~' characters.
973  *
974  * \param Diagnostic the diagnostic whose range is being extracted.
975  *
976  * \param Range the zero-based index specifying which range to
977  *
978  * \returns the requested source range.
979  */
981  unsigned Range);
982 
983 /**
984  * \brief Determine the number of fix-it hints associated with the
985  * given diagnostic.
986  */
987 CINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic);
988 
989 /**
990  * \brief Retrieve the replacement information for a given fix-it.
991  *
992  * Fix-its are described in terms of a source range whose contents
993  * should be replaced by a string. This approach generalizes over
994  * three kinds of operations: removal of source code (the range covers
995  * the code to be removed and the replacement string is empty),
996  * replacement of source code (the range covers the code to be
997  * replaced and the replacement string provides the new code), and
998  * insertion (both the start and end of the range point at the
999  * insertion location, and the replacement string provides the text to
1000  * insert).
1001  *
1002  * \param Diagnostic The diagnostic whose fix-its are being queried.
1003  *
1004  * \param FixIt The zero-based index of the fix-it.
1005  *
1006  * \param ReplacementRange The source range whose contents will be
1007  * replaced with the returned replacement string. Note that source
1008  * ranges are half-open ranges [a, b), so the source code should be
1009  * replaced from a and up to (but not including) b.
1010  *
1011  * \returns A string containing text that should be replace the source
1012  * code indicated by the \c ReplacementRange.
1013  */
1014 CINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic,
1015  unsigned FixIt,
1016  CXSourceRange *ReplacementRange);
1017 
1018 /**
1019  * @}
1020  */
1021 
1022 /**
1023  * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation
1024  *
1025  * The routines in this group provide the ability to create and destroy
1026  * translation units from files, either by parsing the contents of the files or
1027  * by reading in a serialized representation of a translation unit.
1028  *
1029  * @{
1030  */
1031 
1032 /**
1033  * \brief Get the original translation unit source file name.
1034  */
1036 clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
1037 
1038 /**
1039  * \brief Return the CXTranslationUnit for a given source file and the provided
1040  * command line arguments one would pass to the compiler.
1041  *
1042  * Note: The 'source_filename' argument is optional. If the caller provides a
1043  * NULL pointer, the name of the source file is expected to reside in the
1044  * specified command line arguments.
1045  *
1046  * Note: When encountered in 'clang_command_line_args', the following options
1047  * are ignored:
1048  *
1049  * '-c'
1050  * '-emit-ast'
1051  * '-fsyntax-only'
1052  * '-o <output file>' (both '-o' and '<output file>' are ignored)
1053  *
1054  * \param CIdx The index object with which the translation unit will be
1055  * associated.
1056  *
1057  * \param source_filename The name of the source file to load, or NULL if the
1058  * source file is included in \p clang_command_line_args.
1059  *
1060  * \param num_clang_command_line_args The number of command-line arguments in
1061  * \p clang_command_line_args.
1062  *
1063  * \param clang_command_line_args The command-line arguments that would be
1064  * passed to the \c clang executable if it were being invoked out-of-process.
1065  * These command-line options will be parsed and will affect how the translation
1066  * unit is parsed. Note that the following options are ignored: '-c',
1067  * '-emit-ast', '-fsyntax-only' (which is the default), and '-o <output file>'.
1068  *
1069  * \param num_unsaved_files the number of unsaved file entries in \p
1070  * unsaved_files.
1071  *
1072  * \param unsaved_files the files that have not yet been saved to disk
1073  * but may be required for code completion, including the contents of
1074  * those files. The contents and name of these files (as specified by
1075  * CXUnsavedFile) are copied when necessary, so the client only needs to
1076  * guarantee their validity until the call to this function returns.
1077  */
1079  CXIndex CIdx,
1080  const char *source_filename,
1081  int num_clang_command_line_args,
1082  const char * const *clang_command_line_args,
1083  unsigned num_unsaved_files,
1084  struct CXUnsavedFile *unsaved_files);
1085 
1086 /**
1087  * \brief Same as \c clang_createTranslationUnit2, but returns
1088  * the \c CXTranslationUnit instead of an error code. In case of an error this
1089  * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1090  * error codes.
1091  */
1093  CXIndex CIdx,
1094  const char *ast_filename);
1095 
1096 /**
1097  * \brief Create a translation unit from an AST file (\c -emit-ast).
1098  *
1099  * \param[out] out_TU A non-NULL pointer to store the created
1100  * \c CXTranslationUnit.
1101  *
1102  * \returns Zero on success, otherwise returns an error code.
1103  */
1105  CXIndex CIdx,
1106  const char *ast_filename,
1107  CXTranslationUnit *out_TU);
1108 
1109 /**
1110  * \brief Flags that control the creation of translation units.
1111  *
1112  * The enumerators in this enumeration type are meant to be bitwise
1113  * ORed together to specify which options should be used when
1114  * constructing the translation unit.
1115  */
1117  /**
1118  * \brief Used to indicate that no special translation-unit options are
1119  * needed.
1120  */
1122 
1123  /**
1124  * \brief Used to indicate that the parser should construct a "detailed"
1125  * preprocessing record, including all macro definitions and instantiations.
1126  *
1127  * Constructing a detailed preprocessing record requires more memory
1128  * and time to parse, since the information contained in the record
1129  * is usually not retained. However, it can be useful for
1130  * applications that require more detailed information about the
1131  * behavior of the preprocessor.
1132  */
1134 
1135  /**
1136  * \brief Used to indicate that the translation unit is incomplete.
1137  *
1138  * When a translation unit is considered "incomplete", semantic
1139  * analysis that is typically performed at the end of the
1140  * translation unit will be suppressed. For example, this suppresses
1141  * the completion of tentative declarations in C and of
1142  * instantiation of implicitly-instantiation function templates in
1143  * C++. This option is typically used when parsing a header with the
1144  * intent of producing a precompiled header.
1145  */
1147 
1148  /**
1149  * \brief Used to indicate that the translation unit should be built with an
1150  * implicit precompiled header for the preamble.
1151  *
1152  * An implicit precompiled header is used as an optimization when a
1153  * particular translation unit is likely to be reparsed many times
1154  * when the sources aren't changing that often. In this case, an
1155  * implicit precompiled header will be built containing all of the
1156  * initial includes at the top of the main file (what we refer to as
1157  * the "preamble" of the file). In subsequent parses, if the
1158  * preamble or the files in it have not changed, \c
1159  * clang_reparseTranslationUnit() will re-use the implicit
1160  * precompiled header to improve parsing performance.
1161  */
1163 
1164  /**
1165  * \brief Used to indicate that the translation unit should cache some
1166  * code-completion results with each reparse of the source file.
1167  *
1168  * Caching of code-completion results is a performance optimization that
1169  * introduces some overhead to reparsing but improves the performance of
1170  * code-completion operations.
1171  */
1173 
1174  /**
1175  * \brief Used to indicate that the translation unit will be serialized with
1176  * \c clang_saveTranslationUnit.
1177  *
1178  * This option is typically used when parsing a header with the intent of
1179  * producing a precompiled header.
1180  */
1182 
1183  /**
1184  * \brief DEPRECATED: Enabled chained precompiled preambles in C++.
1185  *
1186  * Note: this is a *temporary* option that is available only while
1187  * we are testing C++ precompiled preamble support. It is deprecated.
1188  */
1190 
1191  /**
1192  * \brief Used to indicate that function/method bodies should be skipped while
1193  * parsing.
1194  *
1195  * This option can be used to search for declarations/definitions while
1196  * ignoring the usages.
1197  */
1199 
1200  /**
1201  * \brief Used to indicate that brief documentation comments should be
1202  * included into the set of code completions returned from this translation
1203  * unit.
1204  */
1206 };
1207 
1208 /**
1209  * \brief Returns the set of flags that is suitable for parsing a translation
1210  * unit that is being edited.
1211  *
1212  * The set of flags returned provide options for \c clang_parseTranslationUnit()
1213  * to indicate that the translation unit is likely to be reparsed many times,
1214  * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly
1215  * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag
1216  * set contains an unspecified set of optimizations (e.g., the precompiled
1217  * preamble) geared toward improving the performance of these routines. The
1218  * set of optimizations enabled may change from one version to the next.
1219  */
1221 
1222 /**
1223  * \brief Same as \c clang_parseTranslationUnit2, but returns
1224  * the \c CXTranslationUnit instead of an error code. In case of an error this
1225  * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1226  * error codes.
1227  */
1228 CINDEX_LINKAGE CXTranslationUnit
1229 clang_parseTranslationUnit(CXIndex CIdx,
1230  const char *source_filename,
1231  const char *const *command_line_args,
1232  int num_command_line_args,
1233  struct CXUnsavedFile *unsaved_files,
1234  unsigned num_unsaved_files,
1235  unsigned options);
1236 
1237 /**
1238  * \brief Parse the given source file and the translation unit corresponding
1239  * to that file.
1240  *
1241  * This routine is the main entry point for the Clang C API, providing the
1242  * ability to parse a source file into a translation unit that can then be
1243  * queried by other functions in the API. This routine accepts a set of
1244  * command-line arguments so that the compilation can be configured in the same
1245  * way that the compiler is configured on the command line.
1246  *
1247  * \param CIdx The index object with which the translation unit will be
1248  * associated.
1249  *
1250  * \param source_filename The name of the source file to load, or NULL if the
1251  * source file is included in \c command_line_args.
1252  *
1253  * \param command_line_args The command-line arguments that would be
1254  * passed to the \c clang executable if it were being invoked out-of-process.
1255  * These command-line options will be parsed and will affect how the translation
1256  * unit is parsed. Note that the following options are ignored: '-c',
1257  * '-emit-ast', '-fsyntax-only' (which is the default), and '-o <output file>'.
1258  *
1259  * \param num_command_line_args The number of command-line arguments in
1260  * \c command_line_args.
1261  *
1262  * \param unsaved_files the files that have not yet been saved to disk
1263  * but may be required for parsing, including the contents of
1264  * those files. The contents and name of these files (as specified by
1265  * CXUnsavedFile) are copied when necessary, so the client only needs to
1266  * guarantee their validity until the call to this function returns.
1267  *
1268  * \param num_unsaved_files the number of unsaved file entries in \p
1269  * unsaved_files.
1270  *
1271  * \param options A bitmask of options that affects how the translation unit
1272  * is managed but not its compilation. This should be a bitwise OR of the
1273  * CXTranslationUnit_XXX flags.
1274  *
1275  * \param[out] out_TU A non-NULL pointer to store the created
1276  * \c CXTranslationUnit, describing the parsed code and containing any
1277  * diagnostics produced by the compiler.
1278  *
1279  * \returns Zero on success, otherwise returns an error code.
1280  */
1282 clang_parseTranslationUnit2(CXIndex CIdx,
1283  const char *source_filename,
1284  const char *const *command_line_args,
1285  int num_command_line_args,
1286  struct CXUnsavedFile *unsaved_files,
1287  unsigned num_unsaved_files,
1288  unsigned options,
1289  CXTranslationUnit *out_TU);
1290 
1291 /**
1292  * \brief Flags that control how translation units are saved.
1293  *
1294  * The enumerators in this enumeration type are meant to be bitwise
1295  * ORed together to specify which options should be used when
1296  * saving the translation unit.
1297  */
1299  /**
1300  * \brief Used to indicate that no special saving options are needed.
1301  */
1303 };
1304 
1305 /**
1306  * \brief Returns the set of flags that is suitable for saving a translation
1307  * unit.
1308  *
1309  * The set of flags returned provide options for
1310  * \c clang_saveTranslationUnit() by default. The returned flag
1311  * set contains an unspecified set of options that save translation units with
1312  * the most commonly-requested data.
1313  */
1314 CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU);
1315 
1316 /**
1317  * \brief Describes the kind of error that occurred (if any) in a call to
1318  * \c clang_saveTranslationUnit().
1319  */
1321  /**
1322  * \brief Indicates that no error occurred while saving a translation unit.
1323  */
1325 
1326  /**
1327  * \brief Indicates that an unknown error occurred while attempting to save
1328  * the file.
1329  *
1330  * This error typically indicates that file I/O failed when attempting to
1331  * write the file.
1332  */
1334 
1335  /**
1336  * \brief Indicates that errors during translation prevented this attempt
1337  * to save the translation unit.
1338  *
1339  * Errors that prevent the translation unit from being saved can be
1340  * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic().
1341  */
1343 
1344  /**
1345  * \brief Indicates that the translation unit to be saved was somehow
1346  * invalid (e.g., NULL).
1347  */
1349 };
1350 
1351 /**
1352  * \brief Saves a translation unit into a serialized representation of
1353  * that translation unit on disk.
1354  *
1355  * Any translation unit that was parsed without error can be saved
1356  * into a file. The translation unit can then be deserialized into a
1357  * new \c CXTranslationUnit with \c clang_createTranslationUnit() or,
1358  * if it is an incomplete translation unit that corresponds to a
1359  * header, used as a precompiled header when parsing other translation
1360  * units.
1361  *
1362  * \param TU The translation unit to save.
1363  *
1364  * \param FileName The file to which the translation unit will be saved.
1365  *
1366  * \param options A bitmask of options that affects how the translation unit
1367  * is saved. This should be a bitwise OR of the
1368  * CXSaveTranslationUnit_XXX flags.
1369  *
1370  * \returns A value that will match one of the enumerators of the CXSaveError
1371  * enumeration. Zero (CXSaveError_None) indicates that the translation unit was
1372  * saved successfully, while a non-zero value indicates that a problem occurred.
1373  */
1374 CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU,
1375  const char *FileName,
1376  unsigned options);
1377 
1378 /**
1379  * \brief Destroy the specified CXTranslationUnit object.
1380  */
1381 CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit);
1382 
1383 /**
1384  * \brief Flags that control the reparsing of translation units.
1385  *
1386  * The enumerators in this enumeration type are meant to be bitwise
1387  * ORed together to specify which options should be used when
1388  * reparsing the translation unit.
1389  */
1391  /**
1392  * \brief Used to indicate that no special reparsing options are needed.
1393  */
1395 };
1396 
1397 /**
1398  * \brief Returns the set of flags that is suitable for reparsing a translation
1399  * unit.
1400  *
1401  * The set of flags returned provide options for
1402  * \c clang_reparseTranslationUnit() by default. The returned flag
1403  * set contains an unspecified set of optimizations geared toward common uses
1404  * of reparsing. The set of optimizations enabled may change from one version
1405  * to the next.
1406  */
1407 CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU);
1408 
1409 /**
1410  * \brief Reparse the source files that produced this translation unit.
1411  *
1412  * This routine can be used to re-parse the source files that originally
1413  * created the given translation unit, for example because those source files
1414  * have changed (either on disk or as passed via \p unsaved_files). The
1415  * source code will be reparsed with the same command-line options as it
1416  * was originally parsed.
1417  *
1418  * Reparsing a translation unit invalidates all cursors and source locations
1419  * that refer into that translation unit. This makes reparsing a translation
1420  * unit semantically equivalent to destroying the translation unit and then
1421  * creating a new translation unit with the same command-line arguments.
1422  * However, it may be more efficient to reparse a translation
1423  * unit using this routine.
1424  *
1425  * \param TU The translation unit whose contents will be re-parsed. The
1426  * translation unit must originally have been built with
1427  * \c clang_createTranslationUnitFromSourceFile().
1428  *
1429  * \param num_unsaved_files The number of unsaved file entries in \p
1430  * unsaved_files.
1431  *
1432  * \param unsaved_files The files that have not yet been saved to disk
1433  * but may be required for parsing, including the contents of
1434  * those files. The contents and name of these files (as specified by
1435  * CXUnsavedFile) are copied when necessary, so the client only needs to
1436  * guarantee their validity until the call to this function returns.
1437  *
1438  * \param options A bitset of options composed of the flags in CXReparse_Flags.
1439  * The function \c clang_defaultReparseOptions() produces a default set of
1440  * options recommended for most uses, based on the translation unit.
1441  *
1442  * \returns 0 if the sources could be reparsed. A non-zero error code will be
1443  * returned if reparsing was impossible, such that the translation unit is
1444  * invalid. In such cases, the only valid call for \c TU is
1445  * \c clang_disposeTranslationUnit(TU). The error codes returned by this
1446  * routine are described by the \c CXErrorCode enum.
1447  */
1448 CINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU,
1449  unsigned num_unsaved_files,
1450  struct CXUnsavedFile *unsaved_files,
1451  unsigned options);
1452 
1453 /**
1454  * \brief Categorizes how memory is being used by a translation unit.
1455  */
1474 
1477 };
1478 
1479 /**
1480  * \brief Returns the human-readable null-terminated C string that represents
1481  * the name of the memory category. This string should never be freed.
1482  */
1485 
1486 typedef struct CXTUResourceUsageEntry {
1487  /* \brief The memory usage category. */
1489  /* \brief Amount of resources used.
1490  The units will depend on the resource kind. */
1491  unsigned long amount;
1493 
1494 /**
1495  * \brief The memory usage of a CXTranslationUnit, broken into categories.
1496  */
1497 typedef struct CXTUResourceUsage {
1498  /* \brief Private data member, used for queries. */
1499  void *data;
1500 
1501  /* \brief The number of entries in the 'entries' array. */
1502  unsigned numEntries;
1503 
1504  /* \brief An array of key-value pairs, representing the breakdown of memory
1505  usage. */
1507 
1509 
1510 /**
1511  * \brief Return the memory usage of a translation unit. This object
1512  * should be released with clang_disposeCXTUResourceUsage().
1513  */
1515 
1517 
1518 /**
1519  * @}
1520  */
1521 
1522 /**
1523  * \brief Describes the kind of entity that a cursor refers to.
1524  */
1526  /* Declarations */
1527  /**
1528  * \brief A declaration whose specific kind is not exposed via this
1529  * interface.
1530  *
1531  * Unexposed declarations have the same operations as any other kind
1532  * of declaration; one can extract their location information,
1533  * spelling, find their definitions, etc. However, the specific kind
1534  * of the declaration is not reported.
1535  */
1537  /** \brief A C or C++ struct. */
1539  /** \brief A C or C++ union. */
1541  /** \brief A C++ class. */
1543  /** \brief An enumeration. */
1545  /**
1546  * \brief A field (in C) or non-static data member (in C++) in a
1547  * struct, union, or C++ class.
1548  */
1550  /** \brief An enumerator constant. */
1552  /** \brief A function. */
1554  /** \brief A variable. */
1556  /** \brief A function or method parameter. */
1558  /** \brief An Objective-C \@interface. */
1560  /** \brief An Objective-C \@interface for a category. */
1562  /** \brief An Objective-C \@protocol declaration. */
1564  /** \brief An Objective-C \@property declaration. */
1566  /** \brief An Objective-C instance variable. */
1568  /** \brief An Objective-C instance method. */
1570  /** \brief An Objective-C class method. */
1572  /** \brief An Objective-C \@implementation. */
1574  /** \brief An Objective-C \@implementation for a category. */
1576  /** \brief A typedef */
1578  /** \brief A C++ class method. */
1580  /** \brief A C++ namespace. */
1582  /** \brief A linkage specification, e.g. 'extern "C"'. */
1584  /** \brief A C++ constructor. */
1586  /** \brief A C++ destructor. */
1588  /** \brief A C++ conversion function. */
1590  /** \brief A C++ template type parameter. */
1592  /** \brief A C++ non-type template parameter. */
1594  /** \brief A C++ template template parameter. */
1596  /** \brief A C++ function template. */
1598  /** \brief A C++ class template. */
1600  /** \brief A C++ class template partial specialization. */
1602  /** \brief A C++ namespace alias declaration. */
1604  /** \brief A C++ using directive. */
1606  /** \brief A C++ using declaration. */
1608  /** \brief A C++ alias declaration */
1610  /** \brief An Objective-C \@synthesize definition. */
1612  /** \brief An Objective-C \@dynamic definition. */
1614  /** \brief An access specifier. */
1616 
1619 
1620  /* References */
1621  CXCursor_FirstRef = 40, /* Decl references */
1625  /**
1626  * \brief A reference to a type declaration.
1627  *
1628  * A type reference occurs anywhere where a type is named but not
1629  * declared. For example, given:
1630  *
1631  * \code
1632  * typedef unsigned size_type;
1633  * size_type size;
1634  * \endcode
1635  *
1636  * The typedef is a declaration of size_type (CXCursor_TypedefDecl),
1637  * while the type of the variable "size" is referenced. The cursor
1638  * referenced by the type of size is the typedef for size_type.
1639  */
1642  /**
1643  * \brief A reference to a class template, function template, template
1644  * template parameter, or class template partial specialization.
1645  */
1647  /**
1648  * \brief A reference to a namespace or namespace alias.
1649  */
1651  /**
1652  * \brief A reference to a member of a struct, union, or class that occurs in
1653  * some non-expression context, e.g., a designated initializer.
1654  */
1656  /**
1657  * \brief A reference to a labeled statement.
1658  *
1659  * This cursor kind is used to describe the jump to "start_over" in the
1660  * goto statement in the following example:
1661  *
1662  * \code
1663  * start_over:
1664  * ++counter;
1665  *
1666  * goto start_over;
1667  * \endcode
1668  *
1669  * A label reference cursor refers to a label statement.
1670  */
1672 
1673  /**
1674  * \brief A reference to a set of overloaded functions or function templates
1675  * that has not yet been resolved to a specific function or function template.
1676  *
1677  * An overloaded declaration reference cursor occurs in C++ templates where
1678  * a dependent name refers to a function. For example:
1679  *
1680  * \code
1681  * template<typename T> void swap(T&, T&);
1682  *
1683  * struct X { ... };
1684  * void swap(X&, X&);
1685  *
1686  * template<typename T>
1687  * void reverse(T* first, T* last) {
1688  * while (first < last - 1) {
1689  * swap(*first, *--last);
1690  * ++first;
1691  * }
1692  * }
1693  *
1694  * struct Y { };
1695  * void swap(Y&, Y&);
1696  * \endcode
1697  *
1698  * Here, the identifier "swap" is associated with an overloaded declaration
1699  * reference. In the template definition, "swap" refers to either of the two
1700  * "swap" functions declared above, so both results will be available. At
1701  * instantiation time, "swap" may also refer to other functions found via
1702  * argument-dependent lookup (e.g., the "swap" function at the end of the
1703  * example).
1704  *
1705  * The functions \c clang_getNumOverloadedDecls() and
1706  * \c clang_getOverloadedDecl() can be used to retrieve the definitions
1707  * referenced by this cursor.
1708  */
1710 
1711  /**
1712  * \brief A reference to a variable that occurs in some non-expression
1713  * context, e.g., a C++ lambda capture list.
1714  */
1716 
1718 
1719  /* Error conditions */
1726 
1727  /* Expressions */
1729 
1730  /**
1731  * \brief An expression whose specific kind is not exposed via this
1732  * interface.
1733  *
1734  * Unexposed expressions have the same operations as any other kind
1735  * of expression; one can extract their location information,
1736  * spelling, children, etc. However, the specific kind of the
1737  * expression is not reported.
1738  */
1740 
1741  /**
1742  * \brief An expression that refers to some value declaration, such
1743  * as a function, variable, or enumerator.
1744  */
1746 
1747  /**
1748  * \brief An expression that refers to a member of a struct, union,
1749  * class, Objective-C class, etc.
1750  */
1752 
1753  /** \brief An expression that calls a function. */
1755 
1756  /** \brief An expression that sends a message to an Objective-C
1757  object or class. */
1759 
1760  /** \brief An expression that represents a block literal. */
1762 
1763  /** \brief An integer literal.
1764  */
1766 
1767  /** \brief A floating point number literal.
1768  */
1770 
1771  /** \brief An imaginary number literal.
1772  */
1774 
1775  /** \brief A string literal.
1776  */
1778 
1779  /** \brief A character literal.
1780  */
1782 
1783  /** \brief A parenthesized expression, e.g. "(1)".
1784  *
1785  * This AST node is only formed if full location information is requested.
1786  */
1788 
1789  /** \brief This represents the unary-expression's (except sizeof and
1790  * alignof).
1791  */
1793 
1794  /** \brief [C99 6.5.2.1] Array Subscripting.
1795  */
1797 
1798  /** \brief A builtin binary operation expression such as "x + y" or
1799  * "x <= y".
1800  */
1802 
1803  /** \brief Compound assignment such as "+=".
1804  */
1806 
1807  /** \brief The ?: ternary operator.
1808  */
1810 
1811  /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++
1812  * (C++ [expr.cast]), which uses the syntax (Type)expr.
1813  *
1814  * For example: (int)f.
1815  */
1817 
1818  /** \brief [C99 6.5.2.5]
1819  */
1821 
1822  /** \brief Describes an C or C++ initializer list.
1823  */
1825 
1826  /** \brief The GNU address of label extension, representing &&label.
1827  */
1829 
1830  /** \brief This is the GNU Statement Expression extension: ({int X=4; X;})
1831  */
1833 
1834  /** \brief Represents a C11 generic selection.
1835  */
1837 
1838  /** \brief Implements the GNU __null extension, which is a name for a null
1839  * pointer constant that has integral type (e.g., int or long) and is the same
1840  * size and alignment as a pointer.
1841  *
1842  * The __null extension is typically only used by system headers, which define
1843  * NULL as __null in C++ rather than using 0 (which is an integer that may not
1844  * match the size of a pointer).
1845  */
1847 
1848  /** \brief C++'s static_cast<> expression.
1849  */
1851 
1852  /** \brief C++'s dynamic_cast<> expression.
1853  */
1855 
1856  /** \brief C++'s reinterpret_cast<> expression.
1857  */
1859 
1860  /** \brief C++'s const_cast<> expression.
1861  */
1863 
1864  /** \brief Represents an explicit C++ type conversion that uses "functional"
1865  * notion (C++ [expr.type.conv]).
1866  *
1867  * Example:
1868  * \code
1869  * x = int(0.5);
1870  * \endcode
1871  */
1873 
1874  /** \brief A C++ typeid expression (C++ [expr.typeid]).
1875  */
1877 
1878  /** \brief [C++ 2.13.5] C++ Boolean Literal.
1879  */
1881 
1882  /** \brief [C++0x 2.14.7] C++ Pointer Literal.
1883  */
1885 
1886  /** \brief Represents the "this" expression in C++
1887  */
1889 
1890  /** \brief [C++ 15] C++ Throw Expression.
1891  *
1892  * This handles 'throw' and 'throw' assignment-expression. When
1893  * assignment-expression isn't present, Op will be null.
1894  */
1896 
1897  /** \brief A new expression for memory allocation and constructor calls, e.g:
1898  * "new CXXNewExpr(foo)".
1899  */
1901 
1902  /** \brief A delete expression for memory deallocation and destructor calls,
1903  * e.g. "delete[] pArray".
1904  */
1906 
1907  /** \brief A unary expression.
1908  */
1910 
1911  /** \brief An Objective-C string literal i.e. @"foo".
1912  */
1914 
1915  /** \brief An Objective-C \@encode expression.
1916  */
1918 
1919  /** \brief An Objective-C \@selector expression.
1920  */
1922 
1923  /** \brief An Objective-C \@protocol expression.
1924  */
1926 
1927  /** \brief An Objective-C "bridged" cast expression, which casts between
1928  * Objective-C pointers and C pointers, transferring ownership in the process.
1929  *
1930  * \code
1931  * NSString *str = (__bridge_transfer NSString *)CFCreateString();
1932  * \endcode
1933  */
1935 
1936  /** \brief Represents a C++0x pack expansion that produces a sequence of
1937  * expressions.
1938  *
1939  * A pack expansion expression contains a pattern (which itself is an
1940  * expression) followed by an ellipsis. For example:
1941  *
1942  * \code
1943  * template<typename F, typename ...Types>
1944  * void forward(F f, Types &&...args) {
1945  * f(static_cast<Types&&>(args)...);
1946  * }
1947  * \endcode
1948  */
1950 
1951  /** \brief Represents an expression that computes the length of a parameter
1952  * pack.
1953  *
1954  * \code
1955  * template<typename ...Types>
1956  * struct count {
1957  * static const unsigned value = sizeof...(Types);
1958  * };
1959  * \endcode
1960  */
1962 
1963  /* \brief Represents a C++ lambda expression that produces a local function
1964  * object.
1965  *
1966  * \code
1967  * void abssort(float *x, unsigned N) {
1968  * std::sort(x, x + N,
1969  * [](float a, float b) {
1970  * return std::abs(a) < std::abs(b);
1971  * });
1972  * }
1973  * \endcode
1974  */
1976 
1977  /** \brief Objective-c Boolean Literal.
1978  */
1980 
1981  /** \brief Represents the "self" expression in an Objective-C method.
1982  */
1984 
1986 
1987  /* Statements */
1989  /**
1990  * \brief A statement whose specific kind is not exposed via this
1991  * interface.
1992  *
1993  * Unexposed statements have the same operations as any other kind of
1994  * statement; one can extract their location information, spelling,
1995  * children, etc. However, the specific kind of the statement is not
1996  * reported.
1997  */
1999 
2000  /** \brief A labelled statement in a function.
2001  *
2002  * This cursor kind is used to describe the "start_over:" label statement in
2003  * the following example:
2004  *
2005  * \code
2006  * start_over:
2007  * ++counter;
2008  * \endcode
2009  *
2010  */
2012 
2013  /** \brief A group of statements like { stmt stmt }.
2014  *
2015  * This cursor kind is used to describe compound statements, e.g. function
2016  * bodies.
2017  */
2019 
2020  /** \brief A case statement.
2021  */
2023 
2024  /** \brief A default statement.
2025  */
2027 
2028  /** \brief An if statement
2029  */
2031 
2032  /** \brief A switch statement.
2033  */
2035 
2036  /** \brief A while statement.
2037  */
2039 
2040  /** \brief A do statement.
2041  */
2043 
2044  /** \brief A for statement.
2045  */
2047 
2048  /** \brief A goto statement.
2049  */
2051 
2052  /** \brief An indirect goto statement.
2053  */
2055 
2056  /** \brief A continue statement.
2057  */
2059 
2060  /** \brief A break statement.
2061  */
2063 
2064  /** \brief A return statement.
2065  */
2067 
2068  /** \brief A GCC inline assembly statement extension.
2069  */
2072 
2073  /** \brief Objective-C's overall \@try-\@catch-\@finally statement.
2074  */
2076 
2077  /** \brief Objective-C's \@catch statement.
2078  */
2080 
2081  /** \brief Objective-C's \@finally statement.
2082  */
2084 
2085  /** \brief Objective-C's \@throw statement.
2086  */
2088 
2089  /** \brief Objective-C's \@synchronized statement.
2090  */
2092 
2093  /** \brief Objective-C's autorelease pool statement.
2094  */
2096 
2097  /** \brief Objective-C's collection statement.
2098  */
2100 
2101  /** \brief C++'s catch statement.
2102  */
2104 
2105  /** \brief C++'s try statement.
2106  */
2108 
2109  /** \brief C++'s for (* : *) statement.
2110  */
2112 
2113  /** \brief Windows Structured Exception Handling's try statement.
2114  */
2116 
2117  /** \brief Windows Structured Exception Handling's except statement.
2118  */
2120 
2121  /** \brief Windows Structured Exception Handling's finally statement.
2122  */
2124 
2125  /** \brief A MS inline assembly statement extension.
2126  */
2128 
2129  /** \brief The null statement ";": C99 6.8.3p3.
2130  *
2131  * This cursor kind is used to describe the null statement.
2132  */
2134 
2135  /** \brief Adaptor class for mixing declarations with statements and
2136  * expressions.
2137  */
2139 
2140  /** \brief OpenMP parallel directive.
2141  */
2143 
2144  /** \brief OpenMP SIMD directive.
2145  */
2147 
2148  /** \brief OpenMP for directive.
2149  */
2151 
2152  /** \brief OpenMP sections directive.
2153  */
2155 
2156  /** \brief OpenMP section directive.
2157  */
2159 
2160  /** \brief OpenMP single directive.
2161  */
2163 
2164  /** \brief OpenMP parallel for directive.
2165  */
2167 
2168  /** \brief OpenMP parallel sections directive.
2169  */
2171 
2172  /** \brief OpenMP task directive.
2173  */
2175 
2176  /** \brief OpenMP master directive.
2177  */
2179 
2180  /** \brief OpenMP critical directive.
2181  */
2183 
2184  /** \brief OpenMP taskyield directive.
2185  */
2187 
2188  /** \brief OpenMP barrier directive.
2189  */
2191 
2192  /** \brief OpenMP taskwait directive.
2193  */
2195 
2196  /** \brief OpenMP flush directive.
2197  */
2199 
2200  /** \brief Windows Structured Exception Handling's leave statement.
2201  */
2203 
2204  /** \brief OpenMP ordered directive.
2205  */
2207 
2208  /** \brief OpenMP atomic directive.
2209  */
2211 
2212  /** \brief OpenMP for SIMD directive.
2213  */
2215 
2216  /** \brief OpenMP parallel for SIMD directive.
2217  */
2219 
2220  /** \brief OpenMP target directive.
2221  */
2223 
2224  /** \brief OpenMP teams directive.
2225  */
2227 
2228  /** \brief OpenMP taskgroup directive.
2229  */
2231 
2232  /** \brief OpenMP cancellation point directive.
2233  */
2235 
2236  /** \brief OpenMP cancel directive.
2237  */
2239 
2241 
2242  /**
2243  * \brief Cursor that represents the translation unit itself.
2244  *
2245  * The translation unit cursor exists primarily to act as the root
2246  * cursor for traversing the contents of a translation unit.
2247  */
2249 
2250  /* Attributes */
2252  /**
2253  * \brief An attribute whose specific kind is not exposed via this
2254  * interface.
2255  */
2257 
2275 
2276  /* Preprocessing */
2284 
2285  /* Extra Declarations */
2286  /**
2287  * \brief A module import declaration.
2288  */
2292 
2293  /**
2294  * \brief A code completion overload candidate.
2295  */
2297 };
2298 
2299 /**
2300  * \brief A cursor representing some element in the abstract syntax tree for
2301  * a translation unit.
2302  *
2303  * The cursor abstraction unifies the different kinds of entities in a
2304  * program--declaration, statements, expressions, references to declarations,
2305  * etc.--under a single "cursor" abstraction with a common set of operations.
2306  * Common operation for a cursor include: getting the physical location in
2307  * a source file where the cursor points, getting the name associated with a
2308  * cursor, and retrieving cursors for any child nodes of a particular cursor.
2309  *
2310  * Cursors can be produced in two specific ways.
2311  * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
2312  * from which one can use clang_visitChildren() to explore the rest of the
2313  * translation unit. clang_getCursor() maps from a physical source location
2314  * to the entity that resides at that location, allowing one to map from the
2315  * source code into the AST.
2316  */
2317 typedef struct {
2319  int xdata;
2320  const void *data[3];
2321 } CXCursor;
2322 
2323 /**
2324  * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
2325  *
2326  * @{
2327  */
2328 
2329 /**
2330  * \brief Retrieve the NULL cursor, which represents no entity.
2331  */
2333 
2334 /**
2335  * \brief Retrieve the cursor that represents the given translation unit.
2336  *
2337  * The translation unit cursor can be used to start traversing the
2338  * various declarations within the given translation unit.
2339  */
2341 
2342 /**
2343  * \brief Determine whether two cursors are equivalent.
2344  */
2346 
2347 /**
2348  * \brief Returns non-zero if \p cursor is null.
2349  */
2351 
2352 /**
2353  * \brief Compute a hash value for the given cursor.
2354  */
2356 
2357 /**
2358  * \brief Retrieve the kind of the given cursor.
2359  */
2361 
2362 /**
2363  * \brief Determine whether the given cursor kind represents a declaration.
2364  */
2366 
2367 /**
2368  * \brief Determine whether the given cursor kind represents a simple
2369  * reference.
2370  *
2371  * Note that other kinds of cursors (such as expressions) can also refer to
2372  * other cursors. Use clang_getCursorReferenced() to determine whether a
2373  * particular cursor refers to another entity.
2374  */
2376 
2377 /**
2378  * \brief Determine whether the given cursor kind represents an expression.
2379  */
2381 
2382 /**
2383  * \brief Determine whether the given cursor kind represents a statement.
2384  */
2386 
2387 /**
2388  * \brief Determine whether the given cursor kind represents an attribute.
2389  */
2391 
2392 /**
2393  * \brief Determine whether the given cursor kind represents an invalid
2394  * cursor.
2395  */
2397 
2398 /**
2399  * \brief Determine whether the given cursor kind represents a translation
2400  * unit.
2401  */
2403 
2404 /***
2405  * \brief Determine whether the given cursor represents a preprocessing
2406  * element, such as a preprocessor directive or macro instantiation.
2407  */
2409 
2410 /***
2411  * \brief Determine whether the given cursor represents a currently
2412  * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
2413  */
2415 
2416 /**
2417  * \brief Describe the linkage of the entity referred to by a cursor.
2418  */
2420  /** \brief This value indicates that no linkage information is available
2421  * for a provided CXCursor. */
2423  /**
2424  * \brief This is the linkage for variables, parameters, and so on that
2425  * have automatic storage. This covers normal (non-extern) local variables.
2426  */
2428  /** \brief This is the linkage for static variables and static functions. */
2430  /** \brief This is the linkage for entities with external linkage that live
2431  * in C++ anonymous namespaces.*/
2433  /** \brief This is the linkage for entities with true, external linkage. */
2435 };
2436 
2437 /**
2438  * \brief Determine the linkage of the entity referred to by a given cursor.
2439  */
2441 
2442 /**
2443  * \brief Determine the availability of the entity that this cursor refers to,
2444  * taking the current target platform into account.
2445  *
2446  * \param cursor The cursor to query.
2447  *
2448  * \returns The availability of the cursor.
2449  */
2452 
2453 /**
2454  * Describes the availability of a given entity on a particular platform, e.g.,
2455  * a particular class might only be available on Mac OS 10.7 or newer.
2456  */
2457 typedef struct CXPlatformAvailability {
2458  /**
2459  * \brief A string that describes the platform for which this structure
2460  * provides availability information.
2461  *
2462  * Possible values are "ios" or "macosx".
2463  */
2465  /**
2466  * \brief The version number in which this entity was introduced.
2467  */
2469  /**
2470  * \brief The version number in which this entity was deprecated (but is
2471  * still available).
2472  */
2474  /**
2475  * \brief The version number in which this entity was obsoleted, and therefore
2476  * is no longer available.
2477  */
2479  /**
2480  * \brief Whether the entity is unconditionally unavailable on this platform.
2481  */
2483  /**
2484  * \brief An optional message to provide to a user of this API, e.g., to
2485  * suggest replacement APIs.
2486  */
2489 
2490 /**
2491  * \brief Determine the availability of the entity that this cursor refers to
2492  * on any platforms for which availability information is known.
2493  *
2494  * \param cursor The cursor to query.
2495  *
2496  * \param always_deprecated If non-NULL, will be set to indicate whether the
2497  * entity is deprecated on all platforms.
2498  *
2499  * \param deprecated_message If non-NULL, will be set to the message text
2500  * provided along with the unconditional deprecation of this entity. The client
2501  * is responsible for deallocating this string.
2502  *
2503  * \param always_unavailable If non-NULL, will be set to indicate whether the
2504  * entity is unavailable on all platforms.
2505  *
2506  * \param unavailable_message If non-NULL, will be set to the message text
2507  * provided along with the unconditional unavailability of this entity. The
2508  * client is responsible for deallocating this string.
2509  *
2510  * \param availability If non-NULL, an array of CXPlatformAvailability instances
2511  * that will be populated with platform availability information, up to either
2512  * the number of platforms for which availability information is available (as
2513  * returned by this function) or \c availability_size, whichever is smaller.
2514  *
2515  * \param availability_size The number of elements available in the
2516  * \c availability array.
2517  *
2518  * \returns The number of platforms (N) for which availability information is
2519  * available (which is unrelated to \c availability_size).
2520  *
2521  * Note that the client is responsible for calling
2522  * \c clang_disposeCXPlatformAvailability to free each of the
2523  * platform-availability structures returned. There are
2524  * \c min(N, availability_size) such structures.
2525  */
2526 CINDEX_LINKAGE int
2528  int *always_deprecated,
2529  CXString *deprecated_message,
2530  int *always_unavailable,
2531  CXString *unavailable_message,
2532  CXPlatformAvailability *availability,
2533  int availability_size);
2534 
2535 /**
2536  * \brief Free the memory associated with a \c CXPlatformAvailability structure.
2537  */
2538 CINDEX_LINKAGE void
2540 
2541 /**
2542  * \brief Describe the "language" of the entity referred to by a cursor.
2543  */
2549 };
2550 
2551 /**
2552  * \brief Determine the "language" of the entity referred to by a given cursor.
2553  */
2555 
2556 /**
2557  * \brief Returns the translation unit that a cursor originated from.
2558  */
2560 
2561 
2562 /**
2563  * \brief A fast container representing a set of CXCursors.
2564  */
2565 typedef struct CXCursorSetImpl *CXCursorSet;
2566 
2567 /**
2568  * \brief Creates an empty CXCursorSet.
2569  */
2570 CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void);
2571 
2572 /**
2573  * \brief Disposes a CXCursorSet and releases its associated memory.
2574  */
2575 CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
2576 
2577 /**
2578  * \brief Queries a CXCursorSet to see if it contains a specific CXCursor.
2579  *
2580  * \returns non-zero if the set contains the specified cursor.
2581 */
2582 CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
2583  CXCursor cursor);
2584 
2585 /**
2586  * \brief Inserts a CXCursor into a CXCursorSet.
2587  *
2588  * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
2589 */
2590 CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
2591  CXCursor cursor);
2592 
2593 /**
2594  * \brief Determine the semantic parent of the given cursor.
2595  *
2596  * The semantic parent of a cursor is the cursor that semantically contains
2597  * the given \p cursor. For many declarations, the lexical and semantic parents
2598  * are equivalent (the lexical parent is returned by
2599  * \c clang_getCursorLexicalParent()). They diverge when declarations or
2600  * definitions are provided out-of-line. For example:
2601  *
2602  * \code
2603  * class C {
2604  * void f();
2605  * };
2606  *
2607  * void C::f() { }
2608  * \endcode
2609  *
2610  * In the out-of-line definition of \c C::f, the semantic parent is
2611  * the class \c C, of which this function is a member. The lexical parent is
2612  * the place where the declaration actually occurs in the source code; in this
2613  * case, the definition occurs in the translation unit. In general, the
2614  * lexical parent for a given entity can change without affecting the semantics
2615  * of the program, and the lexical parent of different declarations of the
2616  * same entity may be different. Changing the semantic parent of a declaration,
2617  * on the other hand, can have a major impact on semantics, and redeclarations
2618  * of a particular entity should all have the same semantic context.
2619  *
2620  * In the example above, both declarations of \c C::f have \c C as their
2621  * semantic context, while the lexical context of the first \c C::f is \c C
2622  * and the lexical context of the second \c C::f is the translation unit.
2623  *
2624  * For global declarations, the semantic parent is the translation unit.
2625  */
2627 
2628 /**
2629  * \brief Determine the lexical parent of the given cursor.
2630  *
2631  * The lexical parent of a cursor is the cursor in which the given \p cursor
2632  * was actually written. For many declarations, the lexical and semantic parents
2633  * are equivalent (the semantic parent is returned by
2634  * \c clang_getCursorSemanticParent()). They diverge when declarations or
2635  * definitions are provided out-of-line. For example:
2636  *
2637  * \code
2638  * class C {
2639  * void f();
2640  * };
2641  *
2642  * void C::f() { }
2643  * \endcode
2644  *
2645  * In the out-of-line definition of \c C::f, the semantic parent is
2646  * the class \c C, of which this function is a member. The lexical parent is
2647  * the place where the declaration actually occurs in the source code; in this
2648  * case, the definition occurs in the translation unit. In general, the
2649  * lexical parent for a given entity can change without affecting the semantics
2650  * of the program, and the lexical parent of different declarations of the
2651  * same entity may be different. Changing the semantic parent of a declaration,
2652  * on the other hand, can have a major impact on semantics, and redeclarations
2653  * of a particular entity should all have the same semantic context.
2654  *
2655  * In the example above, both declarations of \c C::f have \c C as their
2656  * semantic context, while the lexical context of the first \c C::f is \c C
2657  * and the lexical context of the second \c C::f is the translation unit.
2658  *
2659  * For declarations written in the global scope, the lexical parent is
2660  * the translation unit.
2661  */
2663 
2664 /**
2665  * \brief Determine the set of methods that are overridden by the given
2666  * method.
2667  *
2668  * In both Objective-C and C++, a method (aka virtual member function,
2669  * in C++) can override a virtual method in a base class. For
2670  * Objective-C, a method is said to override any method in the class's
2671  * base class, its protocols, or its categories' protocols, that has the same
2672  * selector and is of the same kind (class or instance).
2673  * If no such method exists, the search continues to the class's superclass,
2674  * its protocols, and its categories, and so on. A method from an Objective-C
2675  * implementation is considered to override the same methods as its
2676  * corresponding method in the interface.
2677  *
2678  * For C++, a virtual member function overrides any virtual member
2679  * function with the same signature that occurs in its base
2680  * classes. With multiple inheritance, a virtual member function can
2681  * override several virtual member functions coming from different
2682  * base classes.
2683  *
2684  * In all cases, this function determines the immediate overridden
2685  * method, rather than all of the overridden methods. For example, if
2686  * a method is originally declared in a class A, then overridden in B
2687  * (which in inherits from A) and also in C (which inherited from B),
2688  * then the only overridden method returned from this function when
2689  * invoked on C's method will be B's method. The client may then
2690  * invoke this function again, given the previously-found overridden
2691  * methods, to map out the complete method-override set.
2692  *
2693  * \param cursor A cursor representing an Objective-C or C++
2694  * method. This routine will compute the set of methods that this
2695  * method overrides.
2696  *
2697  * \param overridden A pointer whose pointee will be replaced with a
2698  * pointer to an array of cursors, representing the set of overridden
2699  * methods. If there are no overridden methods, the pointee will be
2700  * set to NULL. The pointee must be freed via a call to
2701  * \c clang_disposeOverriddenCursors().
2702  *
2703  * \param num_overridden A pointer to the number of overridden
2704  * functions, will be set to the number of overridden functions in the
2705  * array pointed to by \p overridden.
2706  */
2708  CXCursor **overridden,
2709  unsigned *num_overridden);
2710 
2711 /**
2712  * \brief Free the set of overridden cursors returned by \c
2713  * clang_getOverriddenCursors().
2714  */
2716 
2717 /**
2718  * \brief Retrieve the file that is included by the given inclusion directive
2719  * cursor.
2720  */
2722 
2723 /**
2724  * @}
2725  */
2726 
2727 /**
2728  * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
2729  *
2730  * Cursors represent a location within the Abstract Syntax Tree (AST). These
2731  * routines help map between cursors and the physical locations where the
2732  * described entities occur in the source code. The mapping is provided in
2733  * both directions, so one can map from source code to the AST and back.
2734  *
2735  * @{
2736  */
2737 
2738 /**
2739  * \brief Map a source location to the cursor that describes the entity at that
2740  * location in the source code.
2741  *
2742  * clang_getCursor() maps an arbitrary source location within a translation
2743  * unit down to the most specific cursor that describes the entity at that
2744  * location. For example, given an expression \c x + y, invoking
2745  * clang_getCursor() with a source location pointing to "x" will return the
2746  * cursor for "x"; similarly for "y". If the cursor points anywhere between
2747  * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
2748  * will return a cursor referring to the "+" expression.
2749  *
2750  * \returns a cursor representing the entity at the given source location, or
2751  * a NULL cursor if no such entity can be found.
2752  */
2754 
2755 /**
2756  * \brief Retrieve the physical location of the source constructor referenced
2757  * by the given cursor.
2758  *
2759  * The location of a declaration is typically the location of the name of that
2760  * declaration, where the name of that declaration would occur if it is
2761  * unnamed, or some keyword that introduces that particular declaration.
2762  * The location of a reference is where that reference occurs within the
2763  * source code.
2764  */
2766 
2767 /**
2768  * \brief Retrieve the physical extent of the source construct referenced by
2769  * the given cursor.
2770  *
2771  * The extent of a cursor starts with the file/line/column pointing at the
2772  * first character within the source construct that the cursor refers to and
2773  * ends with the last character within that source construct. For a
2774  * declaration, the extent covers the declaration itself. For a reference,
2775  * the extent covers the location of the reference (e.g., where the referenced
2776  * entity was actually used).
2777  */
2779 
2780 /**
2781  * @}
2782  */
2783 
2784 /**
2785  * \defgroup CINDEX_TYPES Type information for CXCursors
2786  *
2787  * @{
2788  */
2789 
2790 /**
2791  * \brief Describes the kind of type
2792  */
2794  /**
2795  * \brief Represents an invalid type (e.g., where no type is available).
2796  */
2798 
2799  /**
2800  * \brief A type whose specific kind is not exposed via this
2801  * interface.
2802  */
2804 
2805  /* Builtin types */
2836 
2855 };
2856 
2857 /**
2858  * \brief Describes the calling convention of a function type
2859  */
2869  /* Value 8 was PnaclCall, but it was never used, so it could safely be re-used. */
2874 
2877 };
2878 
2879 
2880 /**
2881  * \brief The type of an element in the abstract syntax tree.
2882  *
2883  */
2884 typedef struct {
2886  void *data[2];
2887 } CXType;
2888 
2889 /**
2890  * \brief Retrieve the type of a CXCursor (if any).
2891  */
2893 
2894 /**
2895  * \brief Pretty-print the underlying type using the rules of the
2896  * language of the translation unit from which it came.
2897  *
2898  * If the type is invalid, an empty string is returned.
2899  */
2901 
2902 /**
2903  * \brief Retrieve the underlying type of a typedef declaration.
2904  *
2905  * If the cursor does not reference a typedef declaration, an invalid type is
2906  * returned.
2907  */
2909 
2910 /**
2911  * \brief Retrieve the integer type of an enum declaration.
2912  *
2913  * If the cursor does not reference an enum declaration, an invalid type is
2914  * returned.
2915  */
2917 
2918 /**
2919  * \brief Retrieve the integer value of an enum constant declaration as a signed
2920  * long long.
2921  *
2922  * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned.
2923  * Since this is also potentially a valid constant value, the kind of the cursor
2924  * must be verified before calling this function.
2925  */
2927 
2928 /**
2929  * \brief Retrieve the integer value of an enum constant declaration as an unsigned
2930  * long long.
2931  *
2932  * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned.
2933  * Since this is also potentially a valid constant value, the kind of the cursor
2934  * must be verified before calling this function.
2935  */
2937 
2938 /**
2939  * \brief Retrieve the bit width of a bit field declaration as an integer.
2940  *
2941  * If a cursor that is not a bit field declaration is passed in, -1 is returned.
2942  */
2944 
2945 /**
2946  * \brief Retrieve the number of non-variadic arguments associated with a given
2947  * cursor.
2948  *
2949  * The number of arguments can be determined for calls as well as for
2950  * declarations of functions or methods. For other cursors -1 is returned.
2951  */
2953 
2954 /**
2955  * \brief Retrieve the argument cursor of a function or method.
2956  *
2957  * The argument cursor can be determined for calls as well as for declarations
2958  * of functions or methods. For other cursors and for invalid indices, an
2959  * invalid cursor is returned.
2960  */
2962 
2963 /**
2964  * \brief Describes the kind of a template argument.
2965  *
2966  * See the definition of llvm::clang::TemplateArgument::ArgKind for full
2967  * element descriptions.
2968  */
2979  /* Indicates an error case, preventing the kind from being deduced. */
2981 };
2982 
2983 /**
2984  *\brief Returns the number of template args of a function decl representing a
2985  * template specialization.
2986  *
2987  * If the argument cursor cannot be converted into a template function
2988  * declaration, -1 is returned.
2989  *
2990  * For example, for the following declaration and specialization:
2991  * template <typename T, int kInt, bool kBool>
2992  * void foo() { ... }
2993  *
2994  * template <>
2995  * void foo<float, -7, true>();
2996  *
2997  * The value 3 would be returned from this call.
2998  */
3000 
3001 /**
3002  * \brief Retrieve the kind of the I'th template argument of the CXCursor C.
3003  *
3004  * If the argument CXCursor does not represent a FunctionDecl, an invalid
3005  * template argument kind is returned.
3006  *
3007  * For example, for the following declaration and specialization:
3008  * template <typename T, int kInt, bool kBool>
3009  * void foo() { ... }
3010  *
3011  * template <>
3012  * void foo<float, -7, true>();
3013  *
3014  * For I = 0, 1, and 2, Type, Integral, and Integral will be returned,
3015  * respectively.
3016  */
3018  CXCursor C, unsigned I);
3019 
3020 /**
3021  * \brief Retrieve a CXType representing the type of a TemplateArgument of a
3022  * function decl representing a template specialization.
3023  *
3024  * If the argument CXCursor does not represent a FunctionDecl whose I'th
3025  * template argument has a kind of CXTemplateArgKind_Integral, an invalid type
3026  * is returned.
3027  *
3028  * For example, for the following declaration and specialization:
3029  * template <typename T, int kInt, bool kBool>
3030  * void foo() { ... }
3031  *
3032  * template <>
3033  * void foo<float, -7, true>();
3034  *
3035  * If called with I = 0, "float", will be returned.
3036  * Invalid types will be returned for I == 1 or 2.
3037  */
3039  unsigned I);
3040 
3041 /**
3042  * \brief Retrieve the value of an Integral TemplateArgument (of a function
3043  * decl representing a template specialization) as a signed long long.
3044  *
3045  * It is undefined to call this function on a CXCursor that does not represent a
3046  * FunctionDecl or whose I'th template argument is not an integral value.
3047  *
3048  * For example, for the following declaration and specialization:
3049  * template <typename T, int kInt, bool kBool>
3050  * void foo() { ... }
3051  *
3052  * template <>
3053  * void foo<float, -7, true>();
3054  *
3055  * If called with I = 1 or 2, -7 or true will be returned, respectively.
3056  * For I == 0, this function's behavior is undefined.
3057  */
3059  unsigned I);
3060 
3061 /**
3062  * \brief Retrieve the value of an Integral TemplateArgument (of a function
3063  * decl representing a template specialization) as an unsigned long long.
3064  *
3065  * It is undefined to call this function on a CXCursor that does not represent a
3066  * FunctionDecl or whose I'th template argument is not an integral value.
3067  *
3068  * For example, for the following declaration and specialization:
3069  * template <typename T, int kInt, bool kBool>
3070  * void foo() { ... }
3071  *
3072  * template <>
3073  * void foo<float, 2147483649, true>();
3074  *
3075  * If called with I = 1 or 2, 2147483649 or true will be returned, respectively.
3076  * For I == 0, this function's behavior is undefined.
3077  */
3079  CXCursor C, unsigned I);
3080 
3081 /**
3082  * \brief Determine whether two CXTypes represent the same type.
3083  *
3084  * \returns non-zero if the CXTypes represent the same type and
3085  * zero otherwise.
3086  */
3088 
3089 /**
3090  * \brief Return the canonical type for a CXType.
3091  *
3092  * Clang's type system explicitly models typedefs and all the ways
3093  * a specific type can be represented. The canonical type is the underlying
3094  * type with all the "sugar" removed. For example, if 'T' is a typedef
3095  * for 'int', the canonical type for 'T' would be 'int'.
3096  */
3098 
3099 /**
3100  * \brief Determine whether a CXType has the "const" qualifier set,
3101  * without looking through typedefs that may have added "const" at a
3102  * different level.
3103  */
3105 
3106 /**
3107  * \brief Determine whether a CXType has the "volatile" qualifier set,
3108  * without looking through typedefs that may have added "volatile" at
3109  * a different level.
3110  */
3112 
3113 /**
3114  * \brief Determine whether a CXType has the "restrict" qualifier set,
3115  * without looking through typedefs that may have added "restrict" at a
3116  * different level.
3117  */
3119 
3120 /**
3121  * \brief For pointer types, returns the type of the pointee.
3122  */
3124 
3125 /**
3126  * \brief Return the cursor for the declaration of the given type.
3127  */
3129 
3130 /**
3131  * Returns the Objective-C type encoding for the specified declaration.
3132  */
3134 
3135 /**
3136  * \brief Retrieve the spelling of a given CXTypeKind.
3137  */
3139 
3140 /**
3141  * \brief Retrieve the calling convention associated with a function type.
3142  *
3143  * If a non-function type is passed in, CXCallingConv_Invalid is returned.
3144  */
3146 
3147 /**
3148  * \brief Retrieve the return type associated with a function type.
3149  *
3150  * If a non-function type is passed in, an invalid type is returned.
3151  */
3153 
3154 /**
3155  * \brief Retrieve the number of non-variadic parameters associated with a
3156  * function type.
3157  *
3158  * If a non-function type is passed in, -1 is returned.
3159  */
3161 
3162 /**
3163  * \brief Retrieve the type of a parameter of a function type.
3164  *
3165  * If a non-function type is passed in or the function does not have enough
3166  * parameters, an invalid type is returned.
3167  */
3169 
3170 /**
3171  * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise.
3172  */
3174 
3175 /**
3176  * \brief Retrieve the return type associated with a given cursor.
3177  *
3178  * This only returns a valid type if the cursor refers to a function or method.
3179  */
3181 
3182 /**
3183  * \brief Return 1 if the CXType is a POD (plain old data) type, and 0
3184  * otherwise.
3185  */
3187 
3188 /**
3189  * \brief Return the element type of an array, complex, or vector type.
3190  *
3191  * If a type is passed in that is not an array, complex, or vector type,
3192  * an invalid type is returned.
3193  */
3195 
3196 /**
3197  * \brief Return the number of elements of an array or vector type.
3198  *
3199  * If a type is passed in that is not an array or vector type,
3200  * -1 is returned.
3201  */
3203 
3204 /**
3205  * \brief Return the element type of an array type.
3206  *
3207  * If a non-array type is passed in, an invalid type is returned.
3208  */
3210 
3211 /**
3212  * \brief Return the array size of a constant array.
3213  *
3214  * If a non-array type is passed in, -1 is returned.
3215  */
3217 
3218 /**
3219  * \brief List the possible error codes for \c clang_Type_getSizeOf,
3220  * \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and
3221  * \c clang_Cursor_getOffsetOf.
3222  *
3223  * A value of this enumeration type can be returned if the target type is not
3224  * a valid argument to sizeof, alignof or offsetof.
3225  */
3227  /**
3228  * \brief Type is of kind CXType_Invalid.
3229  */
3231  /**
3232  * \brief The type is an incomplete Type.
3233  */
3235  /**
3236  * \brief The type is a dependent Type.
3237  */
3239  /**
3240  * \brief The type is not a constant size type.
3241  */
3243  /**
3244  * \brief The Field name is not valid for this record.
3245  */
3247 };
3248 
3249 /**
3250  * \brief Return the alignment of a type in bytes as per C++[expr.alignof]
3251  * standard.
3252  *
3253  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3254  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3255  * is returned.
3256  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3257  * returned.
3258  * If the type declaration is not a constant size type,
3259  * CXTypeLayoutError_NotConstantSize is returned.
3260  */
3262 
3263 /**
3264  * \brief Return the class type of an member pointer type.
3265  *
3266  * If a non-member-pointer type is passed in, an invalid type is returned.
3267  */
3269 
3270 /**
3271  * \brief Return the size of a type in bytes as per C++[expr.sizeof] standard.
3272  *
3273  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3274  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3275  * is returned.
3276  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3277  * returned.
3278  */
3280 
3281 /**
3282  * \brief Return the offset of a field named S in a record of type T in bits
3283  * as it would be returned by __offsetof__ as per C++11[18.2p4]
3284  *
3285  * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
3286  * is returned.
3287  * If the field's type declaration is an incomplete type,
3288  * CXTypeLayoutError_Incomplete is returned.
3289  * If the field's type declaration is a dependent type,
3290  * CXTypeLayoutError_Dependent is returned.
3291  * If the field's name S is not found,
3292  * CXTypeLayoutError_InvalidFieldName is returned.
3293  */
3294 CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S);
3295 
3296 /**
3297  * \brief Return the offset of the field represented by the Cursor.
3298  *
3299  * If the cursor is not a field declaration, -1 is returned.
3300  * If the cursor semantic parent is not a record field declaration,
3301  * CXTypeLayoutError_Invalid is returned.
3302  * If the field's type declaration is an incomplete type,
3303  * CXTypeLayoutError_Incomplete is returned.
3304  * If the field's type declaration is a dependent type,
3305  * CXTypeLayoutError_Dependent is returned.
3306  * If the field's name S is not found,
3307  * CXTypeLayoutError_InvalidFieldName is returned.
3308  */
3310 
3311 /**
3312  * \brief Determine whether the given cursor represents an anonymous record
3313  * declaration.
3314  */
3316 
3317 
3319  /** \brief No ref-qualifier was provided. */
3321  /** \brief An lvalue ref-qualifier was provided (\c &). */
3323  /** \brief An rvalue ref-qualifier was provided (\c &&). */
3325 };
3326 
3327 /**
3328  * \brief Returns the number of template arguments for given class template
3329  * specialization, or -1 if type \c T is not a class template specialization.
3330  *
3331  * Variadic argument packs count as only one argument, and can not be inspected
3332  * further.
3333  */
3335 
3336 /**
3337  * \brief Returns the type template argument of a template class specialization
3338  * at given index.
3339  *
3340  * This function only returns template type arguments and does not handle
3341  * template template arguments or variadic packs.
3342  */
3344 
3345 /**
3346  * \brief Retrieve the ref-qualifier kind of a function or method.
3347  *
3348  * The ref-qualifier is returned for C++ functions or methods. For other types
3349  * or non-C++ declarations, CXRefQualifier_None is returned.
3350  */
3352 
3353 /**
3354  * \brief Returns non-zero if the cursor specifies a Record member that is a
3355  * bitfield.
3356  */
3358 
3359 /**
3360  * \brief Returns 1 if the base class specified by the cursor with kind
3361  * CX_CXXBaseSpecifier is virtual.
3362  */
3364 
3365 /**
3366  * \brief Represents the C++ access control level to a base class for a
3367  * cursor with kind CX_CXXBaseSpecifier.
3368  */
3374 };
3375 
3376 /**
3377  * \brief Returns the access control level for the referenced object.
3378  *
3379  * If the cursor refers to a C++ declaration, its access control level within its
3380  * parent scope is returned. Otherwise, if the cursor refers to a base specifier or
3381  * access specifier, the specifier itself is returned.
3382  */
3384 
3385 /**
3386  * \brief Represents the storage classes as declared in the source. CX_SC_Invalid
3387  * was added for the case that the passed cursor in not a declaration.
3388  */
3398 };
3399 
3400 /**
3401  * \brief Returns the storage class for a function or variable declaration.
3402  *
3403  * If the passed in Cursor is not a function or variable declaration,
3404  * CX_SC_Invalid is returned else the storage class.
3405  */
3407 
3408 /**
3409  * \brief Determine the number of overloaded declarations referenced by a
3410  * \c CXCursor_OverloadedDeclRef cursor.
3411  *
3412  * \param cursor The cursor whose overloaded declarations are being queried.
3413  *
3414  * \returns The number of overloaded declarations referenced by \c cursor. If it
3415  * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
3416  */
3418 
3419 /**
3420  * \brief Retrieve a cursor for one of the overloaded declarations referenced
3421  * by a \c CXCursor_OverloadedDeclRef cursor.
3422  *
3423  * \param cursor The cursor whose overloaded declarations are being queried.
3424  *
3425  * \param index The zero-based index into the set of overloaded declarations in
3426  * the cursor.
3427  *
3428  * \returns A cursor representing the declaration referenced by the given
3429  * \c cursor at the specified \c index. If the cursor does not have an
3430  * associated set of overloaded declarations, or if the index is out of bounds,
3431  * returns \c clang_getNullCursor();
3432  */
3434  unsigned index);
3435 
3436 /**
3437  * @}
3438  */
3439 
3440 /**
3441  * \defgroup CINDEX_ATTRIBUTES Information for attributes
3442  *
3443  * @{
3444  */
3445 
3446 
3447 /**
3448  * \brief For cursors representing an iboutletcollection attribute,
3449  * this function returns the collection element type.
3450  *
3451  */
3453 
3454 /**
3455  * @}
3456  */
3457 
3458 /**
3459  * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
3460  *
3461  * These routines provide the ability to traverse the abstract syntax tree
3462  * using cursors.
3463  *
3464  * @{
3465  */
3466 
3467 /**
3468  * \brief Describes how the traversal of the children of a particular
3469  * cursor should proceed after visiting a particular child cursor.
3470  *
3471  * A value of this enumeration type should be returned by each
3472  * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
3473  */
3475  /**
3476  * \brief Terminates the cursor traversal.
3477  */
3479  /**
3480  * \brief Continues the cursor traversal with the next sibling of
3481  * the cursor just visited, without visiting its children.
3482  */
3484  /**
3485  * \brief Recursively traverse the children of this cursor, using
3486  * the same visitor and client data.
3487  */
3489 };
3490 
3491 /**
3492  * \brief Visitor invoked for each cursor found by a traversal.
3493  *
3494  * This visitor function will be invoked for each cursor found by
3495  * clang_visitCursorChildren(). Its first argument is the cursor being
3496  * visited, its second argument is the parent visitor for that cursor,
3497  * and its third argument is the client data provided to
3498  * clang_visitCursorChildren().
3499  *
3500  * The visitor should return one of the \c CXChildVisitResult values
3501  * to direct clang_visitCursorChildren().
3502  */
3504  CXCursor parent,
3505  CXClientData client_data);
3506 
3507 /**
3508  * \brief Visit the children of a particular cursor.
3509  *
3510  * This function visits all the direct children of the given cursor,
3511  * invoking the given \p visitor function with the cursors of each
3512  * visited child. The traversal may be recursive, if the visitor returns
3513  * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
3514  * the visitor returns \c CXChildVisit_Break.
3515  *
3516  * \param parent the cursor whose child may be visited. All kinds of
3517  * cursors can be visited, including invalid cursors (which, by
3518  * definition, have no children).
3519  *
3520  * \param visitor the visitor function that will be invoked for each
3521  * child of \p parent.
3522  *
3523  * \param client_data pointer data supplied by the client, which will
3524  * be passed to the visitor each time it is invoked.
3525  *
3526  * \returns a non-zero value if the traversal was terminated
3527  * prematurely by the visitor returning \c CXChildVisit_Break.
3528  */
3530  CXCursorVisitor visitor,
3531  CXClientData client_data);
3532 #ifdef __has_feature
3533 # if __has_feature(blocks)
3534 /**
3535  * \brief Visitor invoked for each cursor found by a traversal.
3536  *
3537  * This visitor block will be invoked for each cursor found by
3538  * clang_visitChildrenWithBlock(). Its first argument is the cursor being
3539  * visited, its second argument is the parent visitor for that cursor.
3540  *
3541  * The visitor should return one of the \c CXChildVisitResult values
3542  * to direct clang_visitChildrenWithBlock().
3543  */
3544 typedef enum CXChildVisitResult
3545  (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
3546 
3547 /**
3548  * Visits the children of a cursor using the specified block. Behaves
3549  * identically to clang_visitChildren() in all other respects.
3550  */
3551 unsigned clang_visitChildrenWithBlock(CXCursor parent,
3552  CXCursorVisitorBlock block);
3553 # endif
3554 #endif
3555 
3556 /**
3557  * @}
3558  */
3559 
3560 /**
3561  * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
3562  *
3563  * These routines provide the ability to determine references within and
3564  * across translation units, by providing the names of the entities referenced
3565  * by cursors, follow reference cursors to the declarations they reference,
3566  * and associate declarations with their definitions.
3567  *
3568  * @{
3569  */
3570 
3571 /**
3572  * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced
3573  * by the given cursor.
3574  *
3575  * A Unified Symbol Resolution (USR) is a string that identifies a particular
3576  * entity (function, class, variable, etc.) within a program. USRs can be
3577  * compared across translation units to determine, e.g., when references in
3578  * one translation refer to an entity defined in another translation unit.
3579  */
3581 
3582 /**
3583  * \brief Construct a USR for a specified Objective-C class.
3584  */
3585 CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
3586 
3587 /**
3588  * \brief Construct a USR for a specified Objective-C category.
3589  */
3591  clang_constructUSR_ObjCCategory(const char *class_name,
3592  const char *category_name);
3593 
3594 /**
3595  * \brief Construct a USR for a specified Objective-C protocol.
3596  */
3598  clang_constructUSR_ObjCProtocol(const char *protocol_name);
3599 
3600 
3601 /**
3602  * \brief Construct a USR for a specified Objective-C instance variable and
3603  * the USR for its containing class.
3604  */
3606  CXString classUSR);
3607 
3608 /**
3609  * \brief Construct a USR for a specified Objective-C method and
3610  * the USR for its containing class.
3611  */
3613  unsigned isInstanceMethod,
3614  CXString classUSR);
3615 
3616 /**
3617  * \brief Construct a USR for a specified Objective-C property and the USR
3618  * for its containing class.
3619  */
3621  CXString classUSR);
3622 
3623 /**
3624  * \brief Retrieve a name for the entity referenced by this cursor.
3625  */
3627 
3628 /**
3629  * \brief Retrieve a range for a piece that forms the cursors spelling name.
3630  * Most of the times there is only one range for the complete spelling but for
3631  * Objective-C methods and Objective-C message expressions, there are multiple
3632  * pieces for each selector identifier.
3633  *
3634  * \param pieceIndex the index of the spelling name piece. If this is greater
3635  * than the actual number of pieces, it will return a NULL (invalid) range.
3636  *
3637  * \param options Reserved.
3638  */
3640  unsigned pieceIndex,
3641  unsigned options);
3642 
3643 /**
3644  * \brief Retrieve the display name for the entity referenced by this cursor.
3645  *
3646  * The display name contains extra information that helps identify the cursor,
3647  * such as the parameters of a function or template or the arguments of a
3648  * class template specialization.
3649  */
3651 
3652 /** \brief For a cursor that is a reference, retrieve a cursor representing the
3653  * entity that it references.
3654  *
3655  * Reference cursors refer to other entities in the AST. For example, an
3656  * Objective-C superclass reference cursor refers to an Objective-C class.
3657  * This function produces the cursor for the Objective-C class from the
3658  * cursor for the superclass reference. If the input cursor is a declaration or
3659  * definition, it returns that declaration or definition unchanged.
3660  * Otherwise, returns the NULL cursor.
3661  */
3663 
3664 /**
3665  * \brief For a cursor that is either a reference to or a declaration
3666  * of some entity, retrieve a cursor that describes the definition of
3667  * that entity.
3668  *
3669  * Some entities can be declared multiple times within a translation
3670  * unit, but only one of those declarations can also be a
3671  * definition. For example, given:
3672  *
3673  * \code
3674  * int f(int, int);
3675  * int g(int x, int y) { return f(x, y); }
3676  * int f(int a, int b) { return a + b; }
3677  * int f(int, int);
3678  * \endcode
3679  *
3680  * there are three declarations of the function "f", but only the
3681  * second one is a definition. The clang_getCursorDefinition()
3682  * function will take any cursor pointing to a declaration of "f"
3683  * (the first or fourth lines of the example) or a cursor referenced
3684  * that uses "f" (the call to "f' inside "g") and will return a
3685  * declaration cursor pointing to the definition (the second "f"
3686  * declaration).
3687  *
3688  * If given a cursor for which there is no corresponding definition,
3689  * e.g., because there is no definition of that entity within this
3690  * translation unit, returns a NULL cursor.
3691  */
3693 
3694 /**
3695  * \brief Determine whether the declaration pointed to by this cursor
3696  * is also a definition of that entity.
3697  */
3699 
3700 /**
3701  * \brief Retrieve the canonical cursor corresponding to the given cursor.
3702  *
3703  * In the C family of languages, many kinds of entities can be declared several
3704  * times within a single translation unit. For example, a structure type can
3705  * be forward-declared (possibly multiple times) and later defined:
3706  *
3707  * \code
3708  * struct X;
3709  * struct X;
3710  * struct X {
3711  * int member;
3712  * };
3713  * \endcode
3714  *
3715  * The declarations and the definition of \c X are represented by three
3716  * different cursors, all of which are declarations of the same underlying
3717  * entity. One of these cursor is considered the "canonical" cursor, which
3718  * is effectively the representative for the underlying entity. One can
3719  * determine if two cursors are declarations of the same underlying entity by
3720  * comparing their canonical cursors.
3721  *
3722  * \returns The canonical cursor for the entity referred to by the given cursor.
3723  */
3725 
3726 
3727 /**
3728  * \brief If the cursor points to a selector identifier in an Objective-C
3729  * method or message expression, this returns the selector index.
3730  *
3731  * After getting a cursor with #clang_getCursor, this can be called to
3732  * determine if the location points to a selector identifier.
3733  *
3734  * \returns The selector index if the cursor is an Objective-C method or message
3735  * expression and the cursor is pointing to a selector identifier, or -1
3736  * otherwise.
3737  */
3739 
3740 /**
3741  * \brief Given a cursor pointing to a C++ method call or an Objective-C
3742  * message, returns non-zero if the method/message is "dynamic", meaning:
3743  *
3744  * For a C++ method: the call is virtual.
3745  * For an Objective-C message: the receiver is an object instance, not 'super'
3746  * or a specific class.
3747  *
3748  * If the method/message is "static" or the cursor does not point to a
3749  * method/message, it will return zero.
3750  */
3752 
3753 /**
3754  * \brief Given a cursor pointing to an Objective-C message, returns the CXType
3755  * of the receiver.
3756  */
3758 
3759 /**
3760  * \brief Property attributes for a \c CXCursor_ObjCPropertyDecl.
3761  */
3762 typedef enum {
3777 
3778 /**
3779  * \brief Given a cursor that represents a property declaration, return the
3780  * associated property attributes. The bits are formed from
3781  * \c CXObjCPropertyAttrKind.
3782  *
3783  * \param reserved Reserved for future use, pass 0.
3784  */
3786  unsigned reserved);
3787 
3788 /**
3789  * \brief 'Qualifiers' written next to the return and parameter types in
3790  * Objective-C method declarations.
3791  */
3792 typedef enum {
3801 
3802 /**
3803  * \brief Given a cursor that represents an Objective-C method or parameter
3804  * declaration, return the associated Objective-C qualifiers for the return
3805  * type or the parameter respectively. The bits are formed from
3806  * CXObjCDeclQualifierKind.
3807  */
3809 
3810 /**
3811  * \brief Given a cursor that represents an Objective-C method or property
3812  * declaration, return non-zero if the declaration was affected by "@optional".
3813  * Returns zero if the cursor is not such a declaration or it is "@required".
3814  */
3816 
3817 /**
3818  * \brief Returns non-zero if the given cursor is a variadic function or method.
3819  */
3821 
3822 /**
3823  * \brief Given a cursor that represents a declaration, return the associated
3824  * comment's source range. The range may include multiple consecutive comments
3825  * with whitespace in between.
3826  */
3828 
3829 /**
3830  * \brief Given a cursor that represents a declaration, return the associated
3831  * comment text, including comment markers.
3832  */
3834 
3835 /**
3836  * \brief Given a cursor that represents a documentable entity (e.g.,
3837  * declaration), return the associated \\brief paragraph; otherwise return the
3838  * first paragraph.
3839  */
3841 
3842 /**
3843  * @}
3844  */
3845 
3846 /** \defgroup CINDEX_MANGLE Name Mangling API Functions
3847  *
3848  * @{
3849  */
3850 
3851 /**
3852  * \brief Retrieve the CXString representing the mangled name of the cursor.
3853  */
3855 
3856 /**
3857  * @}
3858  */
3859 
3860 /**
3861  * \defgroup CINDEX_MODULE Module introspection
3862  *
3863  * The functions in this group provide access to information about modules.
3864  *
3865  * @{
3866  */
3867 
3868 typedef void *CXModule;
3869 
3870 /**
3871  * \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module.
3872  */
3874 
3875 /**
3876  * \brief Given a CXFile header file, return the module that contains it, if one
3877  * exists.
3878  */
3879 CINDEX_LINKAGE CXModule clang_getModuleForFile(CXTranslationUnit, CXFile);
3880 
3881 /**
3882  * \param Module a module object.
3883  *
3884  * \returns the module file where the provided module object came from.
3885  */
3886 CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module);
3887 
3888 /**
3889  * \param Module a module object.
3890  *
3891  * \returns the parent of a sub-module or NULL if the given module is top-level,
3892  * e.g. for 'std.vector' it will return the 'std' module.
3893  */
3894 CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module);
3895 
3896 /**
3897  * \param Module a module object.
3898  *
3899  * \returns the name of the module, e.g. for the 'std.vector' sub-module it
3900  * will return "vector".
3901  */
3903 
3904 /**
3905  * \param Module a module object.
3906  *
3907  * \returns the full name of the module, e.g. "std.vector".
3908  */
3910 
3911 /**
3912  * \param Module a module object.
3913  *
3914  * \returns non-zero if the module is a system one.
3915  */
3916 CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module);
3917 
3918 /**
3919  * \param Module a module object.
3920  *
3921  * \returns the number of top level headers associated with this module.
3922  */
3923 CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit,
3924  CXModule Module);
3925 
3926 /**
3927  * \param Module a module object.
3928  *
3929  * \param Index top level header index (zero-based).
3930  *
3931  * \returns the specified top level header associated with the module.
3932  */
3934 CXFile clang_Module_getTopLevelHeader(CXTranslationUnit,
3935  CXModule Module, unsigned Index);
3936 
3937 /**
3938  * @}
3939  */
3940 
3941 /**
3942  * \defgroup CINDEX_CPP C++ AST introspection
3943  *
3944  * The routines in this group provide access information in the ASTs specific
3945  * to C++ language features.
3946  *
3947  * @{
3948  */
3949 
3950 /**
3951  * \brief Determine if a C++ member function or member function template is
3952  * pure virtual.
3953  */
3955 
3956 /**
3957  * \brief Determine if a C++ member function or member function template is
3958  * declared 'static'.
3959  */
3961 
3962 /**
3963  * \brief Determine if a C++ member function or member function template is
3964  * explicitly declared 'virtual' or if it overrides a virtual method from
3965  * one of the base classes.
3966  */
3968 
3969 /**
3970  * \brief Determine if a C++ member function or member function template is
3971  * declared 'const'.
3972  */
3974 
3975 /**
3976  * \brief Given a cursor that represents a template, determine
3977  * the cursor kind of the specializations would be generated by instantiating
3978  * the template.
3979  *
3980  * This routine can be used to determine what flavor of function template,
3981  * class template, or class template partial specialization is stored in the
3982  * cursor. For example, it can describe whether a class template cursor is
3983  * declared with "struct", "class" or "union".
3984  *
3985  * \param C The cursor to query. This cursor should represent a template
3986  * declaration.
3987  *
3988  * \returns The cursor kind of the specializations that would be generated
3989  * by instantiating the template \p C. If \p C is not a template, returns
3990  * \c CXCursor_NoDeclFound.
3991  */
3993 
3994 /**
3995  * \brief Given a cursor that may represent a specialization or instantiation
3996  * of a template, retrieve the cursor that represents the template that it
3997  * specializes or from which it was instantiated.
3998  *
3999  * This routine determines the template involved both for explicit
4000  * specializations of templates and for implicit instantiations of the template,
4001  * both of which are referred to as "specializations". For a class template
4002  * specialization (e.g., \c std::vector<bool>), this routine will return
4003  * either the primary template (\c std::vector) or, if the specialization was
4004  * instantiated from a class template partial specialization, the class template
4005  * partial specialization. For a class template partial specialization and a
4006  * function template specialization (including instantiations), this
4007  * this routine will return the specialized template.
4008  *
4009  * For members of a class template (e.g., member functions, member classes, or
4010  * static data members), returns the specialized or instantiated member.
4011  * Although not strictly "templates" in the C++ language, members of class
4012  * templates have the same notions of specializations and instantiations that
4013  * templates do, so this routine treats them similarly.
4014  *
4015  * \param C A cursor that may be a specialization of a template or a member
4016  * of a template.
4017  *
4018  * \returns If the given cursor is a specialization or instantiation of a
4019  * template or a member thereof, the template or member that it specializes or
4020  * from which it was instantiated. Otherwise, returns a NULL cursor.
4021  */
4023 
4024 /**
4025  * \brief Given a cursor that references something else, return the source range
4026  * covering that reference.
4027  *
4028  * \param C A cursor pointing to a member reference, a declaration reference, or
4029  * an operator call.
4030  * \param NameFlags A bitset with three independent flags:
4031  * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
4032  * CXNameRange_WantSinglePiece.
4033  * \param PieceIndex For contiguous names or when passing the flag
4034  * CXNameRange_WantSinglePiece, only one piece with index 0 is
4035  * available. When the CXNameRange_WantSinglePiece flag is not passed for a
4036  * non-contiguous names, this index can be used to retrieve the individual
4037  * pieces of the name. See also CXNameRange_WantSinglePiece.
4038  *
4039  * \returns The piece of the name pointed to by the given cursor. If there is no
4040  * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
4041  */
4043  unsigned NameFlags,
4044  unsigned PieceIndex);
4045 
4047  /**
4048  * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
4049  * range.
4050  */
4052 
4053  /**
4054  * \brief Include the explicit template arguments, e.g. <int> in x.f<int>,
4055  * in the range.
4056  */
4058 
4059  /**
4060  * \brief If the name is non-contiguous, return the full spanning range.
4061  *
4062  * Non-contiguous names occur in Objective-C when a selector with two or more
4063  * parameters is used, or in C++ when using an operator:
4064  * \code
4065  * [object doSomething:here withValue:there]; // Objective-C
4066  * return some_vector[1]; // C++
4067  * \endcode
4068  */
4070 };
4071 
4072 /**
4073  * @}
4074  */
4075 
4076 /**
4077  * \defgroup CINDEX_LEX Token extraction and manipulation
4078  *
4079  * The routines in this group provide access to the tokens within a
4080  * translation unit, along with a semantic mapping of those tokens to
4081  * their corresponding cursors.
4082  *
4083  * @{
4084  */
4085 
4086 /**
4087  * \brief Describes a kind of token.
4088  */
4089 typedef enum CXTokenKind {
4090  /**
4091  * \brief A token that contains some kind of punctuation.
4092  */
4094 
4095  /**
4096  * \brief A language keyword.
4097  */
4099 
4100  /**
4101  * \brief An identifier (that is not a keyword).
4102  */
4104 
4105  /**
4106  * \brief A numeric, string, or character literal.
4107  */
4109 
4110  /**
4111  * \brief A comment.
4112  */
4114 } CXTokenKind;
4115 
4116 /**
4117  * \brief Describes a single preprocessing token.
4118  */
4119 typedef struct {
4120  unsigned int_data[4];
4121  void *ptr_data;
4122 } CXToken;
4123 
4124 /**
4125  * \brief Determine the kind of the given token.
4126  */
4128 
4129 /**
4130  * \brief Determine the spelling of the given token.
4131  *
4132  * The spelling of a token is the textual representation of that token, e.g.,
4133  * the text of an identifier or keyword.
4134  */
4136 
4137 /**
4138  * \brief Retrieve the source location of the given token.
4139  */
4141  CXToken);
4142 
4143 /**
4144  * \brief Retrieve a source range that covers the given token.
4145  */
4147 
4148 /**
4149  * \brief Tokenize the source code described by the given range into raw
4150  * lexical tokens.
4151  *
4152  * \param TU the translation unit whose text is being tokenized.
4153  *
4154  * \param Range the source range in which text should be tokenized. All of the
4155  * tokens produced by tokenization will fall within this source range,
4156  *
4157  * \param Tokens this pointer will be set to point to the array of tokens
4158  * that occur within the given source range. The returned pointer must be
4159  * freed with clang_disposeTokens() before the translation unit is destroyed.
4160  *
4161  * \param NumTokens will be set to the number of tokens in the \c *Tokens
4162  * array.
4163  *
4164  */
4165 CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
4166  CXToken **Tokens, unsigned *NumTokens);
4167 
4168 /**
4169  * \brief Annotate the given set of tokens by providing cursors for each token
4170  * that can be mapped to a specific entity within the abstract syntax tree.
4171  *
4172  * This token-annotation routine is equivalent to invoking
4173  * clang_getCursor() for the source locations of each of the
4174  * tokens. The cursors provided are filtered, so that only those
4175  * cursors that have a direct correspondence to the token are
4176  * accepted. For example, given a function call \c f(x),
4177  * clang_getCursor() would provide the following cursors:
4178  *
4179  * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
4180  * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
4181  * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
4182  *
4183  * Only the first and last of these cursors will occur within the
4184  * annotate, since the tokens "f" and "x' directly refer to a function
4185  * and a variable, respectively, but the parentheses are just a small
4186  * part of the full syntax of the function call expression, which is
4187  * not provided as an annotation.
4188  *
4189  * \param TU the translation unit that owns the given tokens.
4190  *
4191  * \param Tokens the set of tokens to annotate.
4192  *
4193  * \param NumTokens the number of tokens in \p Tokens.
4194  *
4195  * \param Cursors an array of \p NumTokens cursors, whose contents will be
4196  * replaced with the cursors corresponding to each token.
4197  */
4198 CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
4199  CXToken *Tokens, unsigned NumTokens,
4200  CXCursor *Cursors);
4201 
4202 /**
4203  * \brief Free the given set of tokens.
4204  */
4205 CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
4206  CXToken *Tokens, unsigned NumTokens);
4207 
4208 /**
4209  * @}
4210  */
4211 
4212 /**
4213  * \defgroup CINDEX_DEBUG Debugging facilities
4214  *
4215  * These routines are used for testing and debugging, only, and should not
4216  * be relied upon.
4217  *
4218  * @{
4219  */
4220 
4221 /* for debug/testing */
4224  const char **startBuf,
4225  const char **endBuf,
4226  unsigned *startLine,
4227  unsigned *startColumn,
4228  unsigned *endLine,
4229  unsigned *endColumn);
4231 CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
4232  unsigned stack_size);
4233 
4234 /**
4235  * @}
4236  */
4237 
4238 /**
4239  * \defgroup CINDEX_CODE_COMPLET Code completion
4240  *
4241  * Code completion involves taking an (incomplete) source file, along with
4242  * knowledge of where the user is actively editing that file, and suggesting
4243  * syntactically- and semantically-valid constructs that the user might want to
4244  * use at that particular point in the source code. These data structures and
4245  * routines provide support for code completion.
4246  *
4247  * @{
4248  */
4249 
4250 /**
4251  * \brief A semantic string that describes a code-completion result.
4252  *
4253  * A semantic string that describes the formatting of a code-completion
4254  * result as a single "template" of text that should be inserted into the
4255  * source buffer when a particular code-completion result is selected.
4256  * Each semantic string is made up of some number of "chunks", each of which
4257  * contains some text along with a description of what that text means, e.g.,
4258  * the name of the entity being referenced, whether the text chunk is part of
4259  * the template, or whether it is a "placeholder" that the user should replace
4260  * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
4261  * description of the different kinds of chunks.
4262  */
4263 typedef void *CXCompletionString;
4264 
4265 /**
4266  * \brief A single result of code completion.
4267  */
4268 typedef struct {
4269  /**
4270  * \brief The kind of entity that this completion refers to.
4271  *
4272  * The cursor kind will be a macro, keyword, or a declaration (one of the
4273  * *Decl cursor kinds), describing the entity that the completion is
4274  * referring to.
4275  *
4276  * \todo In the future, we would like to provide a full cursor, to allow
4277  * the client to extract additional information from declaration.
4278  */
4279  enum CXCursorKind CursorKind;
4280 
4281  /**
4282  * \brief The code-completion string that describes how to insert this
4283  * code-completion result into the editing buffer.
4284  */
4285  CXCompletionString CompletionString;
4287 
4288 /**
4289  * \brief Describes a single piece of text within a code-completion string.
4290  *
4291  * Each "chunk" within a code-completion string (\c CXCompletionString) is
4292  * either a piece of text with a specific "kind" that describes how that text
4293  * should be interpreted by the client or is another completion string.
4294  */
4296  /**
4297  * \brief A code-completion string that describes "optional" text that
4298  * could be a part of the template (but is not required).
4299  *
4300  * The Optional chunk is the only kind of chunk that has a code-completion
4301  * string for its representation, which is accessible via
4302  * \c clang_getCompletionChunkCompletionString(). The code-completion string
4303  * describes an additional part of the template that is completely optional.
4304  * For example, optional chunks can be used to describe the placeholders for
4305  * arguments that match up with defaulted function parameters, e.g. given:
4306  *
4307  * \code
4308  * void f(int x, float y = 3.14, double z = 2.71828);
4309  * \endcode
4310  *
4311  * The code-completion string for this function would contain:
4312  * - a TypedText chunk for "f".
4313  * - a LeftParen chunk for "(".
4314  * - a Placeholder chunk for "int x"
4315  * - an Optional chunk containing the remaining defaulted arguments, e.g.,
4316  * - a Comma chunk for ","
4317  * - a Placeholder chunk for "float y"
4318  * - an Optional chunk containing the last defaulted argument:
4319  * - a Comma chunk for ","
4320  * - a Placeholder chunk for "double z"
4321  * - a RightParen chunk for ")"
4322  *
4323  * There are many ways to handle Optional chunks. Two simple approaches are:
4324  * - Completely ignore optional chunks, in which case the template for the
4325  * function "f" would only include the first parameter ("int x").
4326  * - Fully expand all optional chunks, in which case the template for the
4327  * function "f" would have all of the parameters.
4328  */
4330  /**
4331  * \brief Text that a user would be expected to type to get this
4332  * code-completion result.
4333  *
4334  * There will be exactly one "typed text" chunk in a semantic string, which
4335  * will typically provide the spelling of a keyword or the name of a
4336  * declaration that could be used at the current code point. Clients are
4337  * expected to filter the code-completion results based on the text in this
4338  * chunk.
4339  */
4341  /**
4342  * \brief Text that should be inserted as part of a code-completion result.
4343  *
4344  * A "text" chunk represents text that is part of the template to be
4345  * inserted into user code should this particular code-completion result
4346  * be selected.
4347  */
4349  /**
4350  * \brief Placeholder text that should be replaced by the user.
4351  *
4352  * A "placeholder" chunk marks a place where the user should insert text
4353  * into the code-completion template. For example, placeholders might mark
4354  * the function parameters for a function declaration, to indicate that the
4355  * user should provide arguments for each of those parameters. The actual
4356  * text in a placeholder is a suggestion for the text to display before
4357  * the user replaces the placeholder with real code.
4358  */
4360  /**
4361  * \brief Informative text that should be displayed but never inserted as
4362  * part of the template.
4363  *
4364  * An "informative" chunk contains annotations that can be displayed to
4365  * help the user decide whether a particular code-completion result is the
4366  * right option, but which is not part of the actual template to be inserted
4367  * by code completion.
4368  */
4370  /**
4371  * \brief Text that describes the current parameter when code-completion is
4372  * referring to function call, message send, or template specialization.
4373  *
4374  * A "current parameter" chunk occurs when code-completion is providing
4375  * information about a parameter corresponding to the argument at the
4376  * code-completion point. For example, given a function
4377  *
4378  * \code
4379  * int add(int x, int y);
4380  * \endcode
4381  *
4382  * and the source code \c add(, where the code-completion point is after the
4383  * "(", the code-completion string will contain a "current parameter" chunk
4384  * for "int x", indicating that the current argument will initialize that
4385  * parameter. After typing further, to \c add(17, (where the code-completion
4386  * point is after the ","), the code-completion string will contain a
4387  * "current paremeter" chunk to "int y".
4388  */
4390  /**
4391  * \brief A left parenthesis ('('), used to initiate a function call or
4392  * signal the beginning of a function parameter list.
4393  */
4395  /**
4396  * \brief A right parenthesis (')'), used to finish a function call or
4397  * signal the end of a function parameter list.
4398  */
4400  /**
4401  * \brief A left bracket ('[').
4402  */
4404  /**
4405  * \brief A right bracket (']').
4406  */
4408  /**
4409  * \brief A left brace ('{').
4410  */
4412  /**
4413  * \brief A right brace ('}').
4414  */
4416  /**
4417  * \brief A left angle bracket ('<').
4418  */
4420  /**
4421  * \brief A right angle bracket ('>').
4422  */
4424  /**
4425  * \brief A comma separator (',').
4426  */
4428  /**
4429  * \brief Text that specifies the result type of a given result.
4430  *
4431  * This special kind of informative chunk is not meant to be inserted into
4432  * the text buffer. Rather, it is meant to illustrate the type that an
4433  * expression using the given completion string would have.
4434  */
4436  /**
4437  * \brief A colon (':').
4438  */
4440  /**
4441  * \brief A semicolon (';').
4442  */
4444  /**
4445  * \brief An '=' sign.
4446  */
4448  /**
4449  * Horizontal space (' ').
4450  */
4452  /**
4453  * Vertical space ('\n'), after which it is generally a good idea to
4454  * perform indentation.
4455  */
4457 };
4458 
4459 /**
4460  * \brief Determine the kind of a particular chunk within a completion string.
4461  *
4462  * \param completion_string the completion string to query.
4463  *
4464  * \param chunk_number the 0-based index of the chunk in the completion string.
4465  *
4466  * \returns the kind of the chunk at the index \c chunk_number.
4467  */
4469 clang_getCompletionChunkKind(CXCompletionString completion_string,
4470  unsigned chunk_number);
4471 
4472 /**
4473  * \brief Retrieve the text associated with a particular chunk within a
4474  * completion string.
4475  *
4476  * \param completion_string the completion string to query.
4477  *
4478  * \param chunk_number the 0-based index of the chunk in the completion string.
4479  *
4480  * \returns the text associated with the chunk at index \c chunk_number.
4481  */
4483 clang_getCompletionChunkText(CXCompletionString completion_string,
4484  unsigned chunk_number);
4485 
4486 /**
4487  * \brief Retrieve the completion string associated with a particular chunk
4488  * within a completion string.
4489  *
4490  * \param completion_string the completion string to query.
4491  *
4492  * \param chunk_number the 0-based index of the chunk in the completion string.
4493  *
4494  * \returns the completion string associated with the chunk at index
4495  * \c chunk_number.
4496  */
4497 CINDEX_LINKAGE CXCompletionString
4498 clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
4499  unsigned chunk_number);
4500 
4501 /**
4502  * \brief Retrieve the number of chunks in the given code-completion string.
4503  */
4504 CINDEX_LINKAGE unsigned
4505 clang_getNumCompletionChunks(CXCompletionString completion_string);
4506 
4507 /**
4508  * \brief Determine the priority of this code completion.
4509  *
4510  * The priority of a code completion indicates how likely it is that this
4511  * particular completion is the completion that the user will select. The
4512  * priority is selected by various internal heuristics.
4513  *
4514  * \param completion_string The completion string to query.
4515  *
4516  * \returns The priority of this completion string. Smaller values indicate
4517  * higher-priority (more likely) completions.
4518  */
4519 CINDEX_LINKAGE unsigned
4520 clang_getCompletionPriority(CXCompletionString completion_string);
4521 
4522 /**
4523  * \brief Determine the availability of the entity that this code-completion
4524  * string refers to.
4525  *
4526  * \param completion_string The completion string to query.
4527  *
4528  * \returns The availability of the completion string.
4529  */
4531 clang_getCompletionAvailability(CXCompletionString completion_string);
4532 
4533 /**
4534  * \brief Retrieve the number of annotations associated with the given
4535  * completion string.
4536  *
4537  * \param completion_string the completion string to query.
4538  *
4539  * \returns the number of annotations associated with the given completion
4540  * string.
4541  */
4542 CINDEX_LINKAGE unsigned
4543 clang_getCompletionNumAnnotations(CXCompletionString completion_string);
4544 
4545 /**
4546  * \brief Retrieve the annotation associated with the given completion string.
4547  *
4548  * \param completion_string the completion string to query.
4549  *
4550  * \param annotation_number the 0-based index of the annotation of the
4551  * completion string.
4552  *
4553  * \returns annotation string associated with the completion at index
4554  * \c annotation_number, or a NULL string if that annotation is not available.
4555  */
4557 clang_getCompletionAnnotation(CXCompletionString completion_string,
4558  unsigned annotation_number);
4559 
4560 /**
4561  * \brief Retrieve the parent context of the given completion string.
4562  *
4563  * The parent context of a completion string is the semantic parent of
4564  * the declaration (if any) that the code completion represents. For example,
4565  * a code completion for an Objective-C method would have the method's class
4566  * or protocol as its context.
4567  *
4568  * \param completion_string The code completion string whose parent is
4569  * being queried.
4570  *
4571  * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
4572  *
4573  * \returns The name of the completion parent, e.g., "NSObject" if
4574  * the completion string represents a method in the NSObject class.
4575  */
4577 clang_getCompletionParent(CXCompletionString completion_string,
4578  enum CXCursorKind *kind);
4579 
4580 /**
4581  * \brief Retrieve the brief documentation comment attached to the declaration
4582  * that corresponds to the given completion string.
4583  */
4585 clang_getCompletionBriefComment(CXCompletionString completion_string);
4586 
4587 /**
4588  * \brief Retrieve a completion string for an arbitrary declaration or macro
4589  * definition cursor.
4590  *
4591  * \param cursor The cursor to query.
4592  *
4593  * \returns A non-context-sensitive completion string for declaration and macro
4594  * definition cursors, or NULL for other kinds of cursors.
4595  */
4596 CINDEX_LINKAGE CXCompletionString
4598 
4599 /**
4600  * \brief Contains the results of code-completion.
4601  *
4602  * This data structure contains the results of code completion, as
4603  * produced by \c clang_codeCompleteAt(). Its contents must be freed by
4604  * \c clang_disposeCodeCompleteResults.
4605  */
4606 typedef struct {
4607  /**
4608  * \brief The code-completion results.
4609  */
4611 
4612  /**
4613  * \brief The number of code-completion results stored in the
4614  * \c Results array.
4615  */
4616  unsigned NumResults;
4618 
4619 /**
4620  * \brief Flags that can be passed to \c clang_codeCompleteAt() to
4621  * modify its behavior.
4622  *
4623  * The enumerators in this enumeration can be bitwise-OR'd together to
4624  * provide multiple options to \c clang_codeCompleteAt().
4625  */
4627  /**
4628  * \brief Whether to include macros within the set of code
4629  * completions returned.
4630  */
4632 
4633  /**
4634  * \brief Whether to include code patterns for language constructs
4635  * within the set of code completions, e.g., for loops.
4636  */
4638 
4639  /**
4640  * \brief Whether to include brief documentation within the set of code
4641  * completions returned.
4642  */
4644 };
4645 
4646 /**
4647  * \brief Bits that represent the context under which completion is occurring.
4648  *
4649  * The enumerators in this enumeration may be bitwise-OR'd together if multiple
4650  * contexts are occurring simultaneously.
4651  */
4653  /**
4654  * \brief The context for completions is unexposed, as only Clang results
4655  * should be included. (This is equivalent to having no context bits set.)
4656  */
4658 
4659  /**
4660  * \brief Completions for any possible type should be included in the results.
4661  */
4663 
4664  /**
4665  * \brief Completions for any possible value (variables, function calls, etc.)
4666  * should be included in the results.
4667  */
4669  /**
4670  * \brief Completions for values that resolve to an Objective-C object should
4671  * be included in the results.
4672  */
4674  /**
4675  * \brief Completions for values that resolve to an Objective-C selector
4676  * should be included in the results.
4677  */
4679  /**
4680  * \brief Completions for values that resolve to a C++ class type should be
4681  * included in the results.
4682  */
4684 
4685  /**
4686  * \brief Completions for fields of the member being accessed using the dot
4687  * operator should be included in the results.
4688  */
4690  /**
4691  * \brief Completions for fields of the member being accessed using the arrow
4692  * operator should be included in the results.
4693  */
4695  /**
4696  * \brief Completions for properties of the Objective-C object being accessed
4697  * using the dot operator should be included in the results.
4698  */
4700 
4701  /**
4702  * \brief Completions for enum tags should be included in the results.
4703  */
4705  /**
4706  * \brief Completions for union tags should be included in the results.
4707  */
4709  /**
4710  * \brief Completions for struct tags should be included in the results.
4711  */
4713 
4714  /**
4715  * \brief Completions for C++ class names should be included in the results.
4716  */
4718  /**
4719  * \brief Completions for C++ namespaces and namespace aliases should be
4720  * included in the results.
4721  */
4723  /**
4724  * \brief Completions for C++ nested name specifiers should be included in
4725  * the results.
4726  */
4728 
4729  /**
4730  * \brief Completions for Objective-C interfaces (classes) should be included
4731  * in the results.
4732  */
4734  /**
4735  * \brief Completions for Objective-C protocols should be included in
4736  * the results.
4737  */
4739  /**
4740  * \brief Completions for Objective-C categories should be included in
4741  * the results.
4742  */
4744  /**
4745  * \brief Completions for Objective-C instance messages should be included
4746  * in the results.
4747  */
4749  /**
4750  * \brief Completions for Objective-C class messages should be included in
4751  * the results.
4752  */
4754  /**
4755  * \brief Completions for Objective-C selector names should be included in
4756  * the results.
4757  */
4759 
4760  /**
4761  * \brief Completions for preprocessor macro names should be included in
4762  * the results.
4763  */
4765 
4766  /**
4767  * \brief Natural language completions should be included in the results.
4768  */
4770 
4771  /**
4772  * \brief The current context is unknown, so set all contexts.
4773  */
4775 };
4776 
4777 /**
4778  * \brief Returns a default set of code-completion options that can be
4779  * passed to\c clang_codeCompleteAt().
4780  */
4782 
4783 /**
4784  * \brief Perform code completion at a given location in a translation unit.
4785  *
4786  * This function performs code completion at a particular file, line, and
4787  * column within source code, providing results that suggest potential
4788  * code snippets based on the context of the completion. The basic model
4789  * for code completion is that Clang will parse a complete source file,
4790  * performing syntax checking up to the location where code-completion has
4791  * been requested. At that point, a special code-completion token is passed
4792  * to the parser, which recognizes this token and determines, based on the
4793  * current location in the C/Objective-C/C++ grammar and the state of
4794  * semantic analysis, what completions to provide. These completions are
4795  * returned via a new \c CXCodeCompleteResults structure.
4796  *
4797  * Code completion itself is meant to be triggered by the client when the
4798  * user types punctuation characters or whitespace, at which point the
4799  * code-completion location will coincide with the cursor. For example, if \c p
4800  * is a pointer, code-completion might be triggered after the "-" and then
4801  * after the ">" in \c p->. When the code-completion location is afer the ">",
4802  * the completion results will provide, e.g., the members of the struct that
4803  * "p" points to. The client is responsible for placing the cursor at the
4804  * beginning of the token currently being typed, then filtering the results
4805  * based on the contents of the token. For example, when code-completing for
4806  * the expression \c p->get, the client should provide the location just after
4807  * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
4808  * client can filter the results based on the current token text ("get"), only
4809  * showing those results that start with "get". The intent of this interface
4810  * is to separate the relatively high-latency acquisition of code-completion
4811  * results from the filtering of results on a per-character basis, which must
4812  * have a lower latency.
4813  *
4814  * \param TU The translation unit in which code-completion should
4815  * occur. The source files for this translation unit need not be
4816  * completely up-to-date (and the contents of those source files may
4817  * be overridden via \p unsaved_files). Cursors referring into the
4818  * translation unit may be invalidated by this invocation.
4819  *
4820  * \param complete_filename The name of the source file where code
4821  * completion should be performed. This filename may be any file
4822  * included in the translation unit.
4823  *
4824  * \param complete_line The line at which code-completion should occur.
4825  *
4826  * \param complete_column The column at which code-completion should occur.
4827  * Note that the column should point just after the syntactic construct that
4828  * initiated code completion, and not in the middle of a lexical token.
4829  *
4830  * \param unsaved_files the Tiles that have not yet been saved to disk
4831  * but may be required for parsing or code completion, including the
4832  * contents of those files. The contents and name of these files (as
4833  * specified by CXUnsavedFile) are copied when necessary, so the
4834  * client only needs to guarantee their validity until the call to
4835  * this function returns.
4836  *
4837  * \param num_unsaved_files The number of unsaved file entries in \p
4838  * unsaved_files.
4839  *
4840  * \param options Extra options that control the behavior of code
4841  * completion, expressed as a bitwise OR of the enumerators of the
4842  * CXCodeComplete_Flags enumeration. The
4843  * \c clang_defaultCodeCompleteOptions() function returns a default set
4844  * of code-completion options.
4845  *
4846  * \returns If successful, a new \c CXCodeCompleteResults structure
4847  * containing code-completion results, which should eventually be
4848  * freed with \c clang_disposeCodeCompleteResults(). If code
4849  * completion fails, returns NULL.
4850  */
4852 CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
4853  const char *complete_filename,
4854  unsigned complete_line,
4855  unsigned complete_column,
4856  struct CXUnsavedFile *unsaved_files,
4857  unsigned num_unsaved_files,
4858  unsigned options);
4859 
4860 /**
4861  * \brief Sort the code-completion results in case-insensitive alphabetical
4862  * order.
4863  *
4864  * \param Results The set of results to sort.
4865  * \param NumResults The number of results in \p Results.
4866  */
4869  unsigned NumResults);
4870 
4871 /**
4872  * \brief Free the given set of code-completion results.
4873  */
4876 
4877 /**
4878  * \brief Determine the number of diagnostics produced prior to the
4879  * location where code completion was performed.
4880  */
4883 
4884 /**
4885  * \brief Retrieve a diagnostic associated with the given code completion.
4886  *
4887  * \param Results the code completion results to query.
4888  * \param Index the zero-based diagnostic number to retrieve.
4889  *
4890  * \returns the requested diagnostic. This diagnostic must be freed
4891  * via a call to \c clang_disposeDiagnostic().
4892  */
4895  unsigned Index);
4896 
4897 /**
4898  * \brief Determines what completions are appropriate for the context
4899  * the given code completion.
4900  *
4901  * \param Results the code completion results to query
4902  *
4903  * \returns the kinds of completions that are appropriate for use
4904  * along with the given code completion results.
4905  */
4907 unsigned long long clang_codeCompleteGetContexts(
4908  CXCodeCompleteResults *Results);
4909 
4910 /**
4911  * \brief Returns the cursor kind for the container for the current code
4912  * completion context. The container is only guaranteed to be set for
4913  * contexts where a container exists (i.e. member accesses or Objective-C
4914  * message sends); if there is not a container, this function will return
4915  * CXCursor_InvalidCode.
4916  *
4917  * \param Results the code completion results to query
4918  *
4919  * \param IsIncomplete on return, this value will be false if Clang has complete
4920  * information about the container. If Clang does not have complete
4921  * information, this value will be true.
4922  *
4923  * \returns the container kind, or CXCursor_InvalidCode if there is not a
4924  * container
4925  */
4928  CXCodeCompleteResults *Results,
4929  unsigned *IsIncomplete);
4930 
4931 /**
4932  * \brief Returns the USR for the container for the current code completion
4933  * context. If there is not a container for the current context, this
4934  * function will return the empty string.
4935  *
4936  * \param Results the code completion results to query
4937  *
4938  * \returns the USR for the container
4939  */
4942 
4943 
4944 /**
4945  * \brief Returns the currently-entered selector for an Objective-C message
4946  * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
4947  * non-empty string for CXCompletionContext_ObjCInstanceMessage and
4948  * CXCompletionContext_ObjCClassMessage.
4949  *
4950  * \param Results the code completion results to query
4951  *
4952  * \returns the selector (or partial selector) that has been entered thus far
4953  * for an Objective-C message send.
4954  */
4957 
4958 /**
4959  * @}
4960  */
4961 
4962 
4963 /**
4964  * \defgroup CINDEX_MISC Miscellaneous utility functions
4965  *
4966  * @{
4967  */
4968 
4969 /**
4970  * \brief Return a version string, suitable for showing to a user, but not
4971  * intended to be parsed (the format is not guaranteed to be stable).
4972  */
4974 
4975 
4976 /**
4977  * \brief Enable/disable crash recovery.
4978  *
4979  * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero
4980  * value enables crash recovery, while 0 disables it.
4981  */
4983 
4984  /**
4985  * \brief Visitor invoked for each file in a translation unit
4986  * (used with clang_getInclusions()).
4987  *
4988  * This visitor function will be invoked by clang_getInclusions() for each
4989  * file included (either at the top-level or by \#include directives) within
4990  * a translation unit. The first argument is the file being included, and
4991  * the second and third arguments provide the inclusion stack. The
4992  * array is sorted in order of immediate inclusion. For example,
4993  * the first element refers to the location that included 'included_file'.
4994  */
4995 typedef void (*CXInclusionVisitor)(CXFile included_file,
4996  CXSourceLocation* inclusion_stack,
4997  unsigned include_len,
4998  CXClientData client_data);
4999 
5000 /**
5001  * \brief Visit the set of preprocessor inclusions in a translation unit.
5002  * The visitor function is called with the provided data for every included
5003  * file. This does not include headers included by the PCH file (unless one
5004  * is inspecting the inclusions in the PCH file itself).
5005  */
5006 CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
5007  CXInclusionVisitor visitor,
5008  CXClientData client_data);
5009 
5010 /**
5011  * @}
5012  */
5013 
5014 /** \defgroup CINDEX_REMAPPING Remapping functions
5015  *
5016  * @{
5017  */
5018 
5019 /**
5020  * \brief A remapping of original source files and their translated files.
5021  */
5022 typedef void *CXRemapping;
5023 
5024 /**
5025  * \brief Retrieve a remapping.
5026  *
5027  * \param path the path that contains metadata about remappings.
5028  *
5029  * \returns the requested remapping. This remapping must be freed
5030  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5031  */
5032 CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
5033 
5034 /**
5035  * \brief Retrieve a remapping.
5036  *
5037  * \param filePaths pointer to an array of file paths containing remapping info.
5038  *
5039  * \param numFiles number of file paths.
5040  *
5041  * \returns the requested remapping. This remapping must be freed
5042  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5043  */
5045 CXRemapping clang_getRemappingsFromFileList(const char **filePaths,
5046  unsigned numFiles);
5047 
5048 /**
5049  * \brief Determine the number of remappings.
5050  */
5051 CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
5052 
5053 /**
5054  * \brief Get the original and the associated filename from the remapping.
5055  *
5056  * \param original If non-NULL, will be set to the original filename.
5057  *
5058  * \param transformed If non-NULL, will be set to the filename that the original
5059  * is associated with.
5060  */
5061 CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
5062  CXString *original, CXString *transformed);
5063 
5064 /**
5065  * \brief Dispose the remapping.
5066  */
5067 CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
5068 
5069 /**
5070  * @}
5071  */
5072 
5073 /** \defgroup CINDEX_HIGH Higher level API functions
5074  *
5075  * @{
5076  */
5077 
5081 };
5082 
5083 typedef struct {
5084  void *context;
5085  enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
5087 
5088 typedef enum {
5089  /**
5090  * \brief Function returned successfully.
5091  */
5093  /**
5094  * \brief One of the parameters was invalid for the function.
5095  */
5097  /**
5098  * \brief The function was terminated by a callback (e.g. it returned
5099  * CXVisit_Break)
5100  */
5102 
5103 } CXResult;
5104 
5105 /**
5106  * \brief Find references of a declaration in a specific file.
5107  *
5108  * \param cursor pointing to a declaration or a reference of one.
5109  *
5110  * \param file to search for references.
5111  *
5112  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5113  * each reference found.
5114  * The CXSourceRange will point inside the file; if the reference is inside
5115  * a macro (and not a macro argument) the CXSourceRange will be invalid.
5116  *
5117  * \returns one of the CXResult enumerators.
5118  */
5120  CXCursorAndRangeVisitor visitor);
5121 
5122 /**
5123  * \brief Find #import/#include directives in a specific file.
5124  *
5125  * \param TU translation unit containing the file to query.
5126  *
5127  * \param file to search for #import/#include directives.
5128  *
5129  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5130  * each directive found.
5131  *
5132  * \returns one of the CXResult enumerators.
5133  */
5134 CINDEX_LINKAGE CXResult clang_findIncludesInFile(CXTranslationUnit TU,
5135  CXFile file,
5136  CXCursorAndRangeVisitor visitor);
5137 
5138 #ifdef __has_feature
5139 # if __has_feature(blocks)
5140 
5141 typedef enum CXVisitorResult
5142  (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange);
5143 
5145 CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile,
5146  CXCursorAndRangeVisitorBlock);
5147 
5149 CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile,
5150  CXCursorAndRangeVisitorBlock);
5151 
5152 # endif
5153 #endif
5154 
5155 /**
5156  * \brief The client's data object that is associated with a CXFile.
5157  */
5158 typedef void *CXIdxClientFile;
5159 
5160 /**
5161  * \brief The client's data object that is associated with a semantic entity.
5162  */
5163 typedef void *CXIdxClientEntity;
5164 
5165 /**
5166  * \brief The client's data object that is associated with a semantic container
5167  * of entities.
5168  */
5169 typedef void *CXIdxClientContainer;
5170 
5171 /**
5172  * \brief The client's data object that is associated with an AST file (PCH
5173  * or module).
5174  */
5175 typedef void *CXIdxClientASTFile;
5176 
5177 /**
5178  * \brief Source location passed to index callbacks.
5179  */
5180 typedef struct {
5181  void *ptr_data[2];
5182  unsigned int_data;
5183 } CXIdxLoc;
5184 
5185 /**
5186  * \brief Data for ppIncludedFile callback.
5187  */
5188 typedef struct {
5189  /**
5190  * \brief Location of '#' in the \#include/\#import directive.
5191  */
5193  /**
5194  * \brief Filename as written in the \#include/\#import directive.
5195  */
5196  const char *filename;
5197  /**
5198  * \brief The actual file that the \#include/\#import directive resolved to.
5199  */
5200  CXFile file;
5203  /**
5204  * \brief Non-zero if the directive was automatically turned into a module
5205  * import.
5206  */
5209 
5210 /**
5211  * \brief Data for IndexerCallbacks#importedASTFile.
5212  */
5213 typedef struct {
5214  /**
5215  * \brief Top level AST file containing the imported PCH, module or submodule.
5216  */
5217  CXFile file;
5218  /**
5219  * \brief The imported module or NULL if the AST file is a PCH.
5220  */
5221  CXModule module;
5222  /**
5223  * \brief Location where the file is imported. Applicable only for modules.
5224  */
5226  /**
5227  * \brief Non-zero if an inclusion directive was automatically turned into
5228  * a module import. Applicable only for modules.
5229  */
5231 
5233 
5234 typedef enum {
5241 
5245 
5250 
5254 
5266 
5267 } CXIdxEntityKind;
5268 
5269 typedef enum {
5275 
5276 /**
5277  * \brief Extra C++ template information for an entity. This can apply to:
5278  * CXIdxEntity_Function
5279  * CXIdxEntity_CXXClass
5280  * CXIdxEntity_CXXStaticMethod
5281  * CXIdxEntity_CXXInstanceMethod
5282  * CXIdxEntity_CXXConstructor
5283  * CXIdxEntity_CXXConversionFunction
5284  * CXIdxEntity_CXXTypeAlias
5285  */
5286 typedef enum {
5292 
5293 typedef enum {
5298 } CXIdxAttrKind;
5299 
5300 typedef struct {
5302  CXCursor cursor;
5304 } CXIdxAttrInfo;
5305 
5306 typedef struct {
5310  const char *name;
5311  const char *USR;
5312  CXCursor cursor;
5313  const CXIdxAttrInfo *const *attributes;
5314  unsigned numAttributes;
5315 } CXIdxEntityInfo;
5316 
5317 typedef struct {
5318  CXCursor cursor;
5320 
5321 typedef struct {
5324  CXCursor classCursor;
5327 
5328 typedef enum {
5331 
5332 typedef struct {
5334  CXCursor cursor;
5337  /**
5338  * \brief Generally same as #semanticContainer but can be different in
5339  * cases like out-of-line C++ member functions.
5340  */
5346  /**
5347  * \brief Whether the declaration exists in code or was created implicitly
5348  * by the compiler, e.g. implicit Objective-C methods for properties.
5349  */
5351  const CXIdxAttrInfo *const *attributes;
5352  unsigned numAttributes;
5353 
5354  unsigned flags;
5355 
5356 } CXIdxDeclInfo;
5357 
5358 typedef enum {
5363 
5364 typedef struct {
5368 
5369 typedef struct {
5371  CXCursor cursor;
5374 
5375 typedef struct {
5377  CXCursor cursor;
5380 
5381 typedef struct {
5383  unsigned numProtocols;
5385 
5386 typedef struct {
5391 
5392 typedef struct {
5395  CXCursor classCursor;
5399 
5400 typedef struct {
5405 
5406 typedef struct {
5408  const CXIdxBaseClassInfo *const *bases;
5409  unsigned numBases;
5411 
5412 /**
5413  * \brief Data for IndexerCallbacks#indexEntityReference.
5414  */
5415 typedef enum {
5416  /**
5417  * \brief The entity is referenced directly in user's code.
5418  */
5420  /**
5421  * \brief An implicit reference, e.g. a reference of an Objective-C method
5422  * via the dot syntax.
5423  */
5426 
5427 /**
5428  * \brief Data for IndexerCallbacks#indexEntityReference.
5429  */
5430 typedef struct {
5432  /**
5433  * \brief Reference cursor.
5434  */
5435  CXCursor cursor;
5437  /**
5438  * \brief The entity that gets referenced.
5439  */
5441  /**
5442  * \brief Immediate "parent" of the reference. For example:
5443  *
5444  * \code
5445  * Foo *var;
5446  * \endcode
5447  *
5448  * The parent of reference of type 'Foo' is the variable 'var'.
5449  * For references inside statement bodies of functions/methods,
5450  * the parentEntity will be the function/method.
5451  */
5453  /**
5454  * \brief Lexical container context of the reference.
5455  */
5458 
5459 /**
5460  * \brief A group of callbacks used by #clang_indexSourceFile and
5461  * #clang_indexTranslationUnit.
5462  */
5463 typedef struct {
5464  /**
5465  * \brief Called periodically to check whether indexing should be aborted.
5466  * Should return 0 to continue, and non-zero to abort.
5467  */
5468  int (*abortQuery)(CXClientData client_data, void *reserved);
5469 
5470  /**
5471  * \brief Called at the end of indexing; passes the complete diagnostic set.
5472  */
5473  void (*diagnostic)(CXClientData client_data,
5474  CXDiagnosticSet, void *reserved);
5475 
5476  CXIdxClientFile (*enteredMainFile)(CXClientData client_data,
5477  CXFile mainFile, void *reserved);
5478 
5479  /**
5480  * \brief Called when a file gets \#included/\#imported.
5481  */
5482  CXIdxClientFile (*ppIncludedFile)(CXClientData client_data,
5483  const CXIdxIncludedFileInfo *);
5484 
5485  /**
5486  * \brief Called when a AST file (PCH or module) gets imported.
5487  *
5488  * AST files will not get indexed (there will not be callbacks to index all
5489  * the entities in an AST file). The recommended action is that, if the AST
5490  * file is not already indexed, to initiate a new indexing job specific to
5491  * the AST file.
5492  */
5493  CXIdxClientASTFile (*importedASTFile)(CXClientData client_data,
5494  const CXIdxImportedASTFileInfo *);
5495 
5496  /**
5497  * \brief Called at the beginning of indexing a translation unit.
5498  */
5499  CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data,
5500  void *reserved);
5501 
5502  void (*indexDeclaration)(CXClientData client_data,
5503  const CXIdxDeclInfo *);
5504 
5505  /**
5506  * \brief Called to index a reference of an entity.
5507  */
5508  void (*indexEntityReference)(CXClientData client_data,
5509  const CXIdxEntityRefInfo *);
5510 
5512 
5516 
5519 
5523 
5526 
5529 
5532 
5535 
5536 /**
5537  * \brief For retrieving a custom CXIdxClientContainer attached to a
5538  * container.
5539  */
5540 CINDEX_LINKAGE CXIdxClientContainer
5542 
5543 /**
5544  * \brief For setting a custom CXIdxClientContainer attached to a
5545  * container.
5546  */
5547 CINDEX_LINKAGE void
5548 clang_index_setClientContainer(const CXIdxContainerInfo *,CXIdxClientContainer);
5549 
5550 /**
5551  * \brief For retrieving a custom CXIdxClientEntity attached to an entity.
5552  */
5553 CINDEX_LINKAGE CXIdxClientEntity
5555 
5556 /**
5557  * \brief For setting a custom CXIdxClientEntity attached to an entity.
5558  */
5559 CINDEX_LINKAGE void
5560 clang_index_setClientEntity(const CXIdxEntityInfo *, CXIdxClientEntity);
5561 
5562 /**
5563  * \brief An indexing action/session, to be applied to one or multiple
5564  * translation units.
5565  */
5566 typedef void *CXIndexAction;
5567 
5568 /**
5569  * \brief An indexing action/session, to be applied to one or multiple
5570  * translation units.
5571  *
5572  * \param CIdx The index object with which the index action will be associated.
5573  */
5574 CINDEX_LINKAGE CXIndexAction clang_IndexAction_create(CXIndex CIdx);
5575 
5576 /**
5577  * \brief Destroy the given index action.
5578  *
5579  * The index action must not be destroyed until all of the translation units
5580  * created within that index action have been destroyed.
5581  */
5582 CINDEX_LINKAGE void clang_IndexAction_dispose(CXIndexAction);
5583 
5584 typedef enum {
5585  /**
5586  * \brief Used to indicate that no special indexing options are needed.
5587  */
5589 
5590  /**
5591  * \brief Used to indicate that IndexerCallbacks#indexEntityReference should
5592  * be invoked for only one reference of an entity per source file that does
5593  * not also include a declaration/definition of the entity.
5594  */
5596 
5597  /**
5598  * \brief Function-local symbols should be indexed. If this is not set
5599  * function-local symbols will be ignored.
5600  */
5602 
5603  /**
5604  * \brief Implicit function/class template instantiations should be indexed.
5605  * If this is not set, implicit instantiations will be ignored.
5606  */
5608 
5609  /**
5610  * \brief Suppress all compiler warnings when parsing for indexing.
5611  */
5613 
5614  /**
5615  * \brief Skip a function/method body that was already parsed during an
5616  * indexing session associated with a \c CXIndexAction object.
5617  * Bodies in system headers are always skipped.
5618  */
5620 
5621 } CXIndexOptFlags;
5622 
5623 /**
5624  * \brief Index the given source file and the translation unit corresponding
5625  * to that file via callbacks implemented through #IndexerCallbacks.
5626  *
5627  * \param client_data pointer data supplied by the client, which will
5628  * be passed to the invoked callbacks.
5629  *
5630  * \param index_callbacks Pointer to indexing callbacks that the client
5631  * implements.
5632  *
5633  * \param index_callbacks_size Size of #IndexerCallbacks structure that gets
5634  * passed in index_callbacks.
5635  *
5636  * \param index_options A bitmask of options that affects how indexing is
5637  * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags.
5638  *
5639  * \param[out] out_TU pointer to store a \c CXTranslationUnit that can be
5640  * reused after indexing is finished. Set to \c NULL if you do not require it.
5641  *
5642  * \returns 0 on success or if there were errors from which the compiler could
5643  * recover. If there is a failure from which there is no recovery, returns
5644  * a non-zero \c CXErrorCode.
5645  *
5646  * The rest of the parameters are the same as #clang_parseTranslationUnit.
5647  */
5648 CINDEX_LINKAGE int clang_indexSourceFile(CXIndexAction,
5649  CXClientData client_data,
5650  IndexerCallbacks *index_callbacks,
5651  unsigned index_callbacks_size,
5652  unsigned index_options,
5653  const char *source_filename,
5654  const char * const *command_line_args,
5655  int num_command_line_args,
5656  struct CXUnsavedFile *unsaved_files,
5657  unsigned num_unsaved_files,
5658  CXTranslationUnit *out_TU,
5659  unsigned TU_options);
5660 
5661 /**
5662  * \brief Index the given translation unit via callbacks implemented through
5663  * #IndexerCallbacks.
5664  *
5665  * The order of callback invocations is not guaranteed to be the same as
5666  * when indexing a source file. The high level order will be:
5667  *
5668  * -Preprocessor callbacks invocations
5669  * -Declaration/reference callbacks invocations
5670  * -Diagnostic callback invocations
5671  *
5672  * The parameters are the same as #clang_indexSourceFile.
5673  *
5674  * \returns If there is a failure from which there is no recovery, returns
5675  * non-zero, otherwise returns 0.
5676  */
5677 CINDEX_LINKAGE int clang_indexTranslationUnit(CXIndexAction,
5678  CXClientData client_data,
5679  IndexerCallbacks *index_callbacks,
5680  unsigned index_callbacks_size,
5681  unsigned index_options,
5682  CXTranslationUnit);
5683 
5684 /**
5685  * \brief Retrieve the CXIdxFile, file, line, column, and offset represented by
5686  * the given CXIdxLoc.
5687  *
5688  * If the location refers into a macro expansion, retrieves the
5689  * location of the macro expansion and if it refers into a macro argument
5690  * retrieves the location of the argument.
5691  */
5693  CXIdxClientFile *indexFile,
5694  CXFile *file,
5695  unsigned *line,
5696  unsigned *column,
5697  unsigned *offset);
5698 
5699 /**
5700  * \brief Retrieve the CXSourceLocation represented by the given CXIdxLoc.
5701  */
5704 
5705 /**
5706  * \brief Visitor invoked for each field found by a traversal.
5707  *
5708  * This visitor function will be invoked for each field found by
5709  * \c clang_Type_visitFields. Its first argument is the cursor being
5710  * visited, its second argument is the client data provided to
5711  * \c clang_Type_visitFields.
5712  *
5713  * The visitor should return one of the \c CXVisitorResult values
5714  * to direct \c clang_Type_visitFields.
5715  */
5716 typedef enum CXVisitorResult (*CXFieldVisitor)(CXCursor C,
5717  CXClientData client_data);
5718 
5719 /**
5720  * \brief Visit the fields of a particular type.
5721  *
5722  * This function visits all the direct fields of the given cursor,
5723  * invoking the given \p visitor function with the cursors of each
5724  * visited field. The traversal may be ended prematurely, if
5725  * the visitor returns \c CXFieldVisit_Break.
5726  *
5727  * \param T the record type whose field may be visited.
5728  *
5729  * \param visitor the visitor function that will be invoked for each
5730  * field of \p T.
5731  *
5732  * \param client_data pointer data supplied by the client, which will
5733  * be passed to the visitor each time it is invoked.
5734  *
5735  * \returns a non-zero value if the traversal was terminated
5736  * prematurely by the visitor returning \c CXFieldVisit_Break.
5737  */
5739  CXFieldVisitor visitor,
5740  CXClientData client_data);
5741 
5742 
5743 /**
5744  * @}
5745  */
5746 
5747 /**
5748  * @}
5749  */
5750 
5751 #ifdef __cplusplus
5752 }
5753 #endif
5754 #endif
5755 
const CXIdxBaseClassInfo *const * bases
Definition: Index.h:5408
A C++ function template.
Definition: Index.h:1597
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:2182
A break statement.
Definition: Index.h:2062
Informative text that should be displayed but never inserted as part of the template.
Definition: Index.h:4369
Completions for Objective-C categories should be included in the results.
Definition: Index.h:4743
const char * USR
Definition: Index.h:5311
An expression that represents a block literal.
Definition: Index.h:1761
CINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken)
Determine the kind of the given token.
Function-local symbols should be indexed. If this is not set function-local symbols will be ignored...
Definition: Index.h:5601
const CXIdxDeclInfo * declInfo
Definition: Index.h:5407
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:1781
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:1609
Objective-C's @catch statement.
Definition: Index.h:2079
The type is a dependent Type.
Definition: Index.h:3238
A C++ namespace alias declaration.
Definition: Index.h:1603
CXCursor cursor
Definition: Index.h:5312
int Subminor
The subminor version number, e.g., the '3' in '10.7.3'. This value will be negative if no minor or su...
Definition: Index.h:166
OpenMP cancellation point directive.
Definition: Index.h:2234
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:2022
CINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU)
Return the memory usage of a translation unit. This object should be released with clang_disposeCXTUR...
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:1555
const CXIdxDeclInfo * declInfo
Definition: Index.h:5401
C++'s try statement.
Definition: Index.h:2107
CINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo * clang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *)
Objective-C's @throw statement.
Definition: Index.h:2087
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:2797
CINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C)
[C++ 15] C++ Throw Expression.
Definition: Index.h:1895
CXSaveTranslationUnit_Flags
Flags that control how translation units are saved.
Definition: Index.h:1298
A reference to a class template, function template, template template parameter, or class template pa...
Definition: Index.h:1646
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:4616
Data for IndexerCallbacks::indexEntityReference.
Definition: Index.h:5430
If the name is non-contiguous, return the full spanning range.
Definition: Index.h:4069
A unary expression.
Definition: Index.h:1909
CXIdxLoc hashLoc
Location of '#' in the #include/#import directive.
Definition: Index.h:5192
The type of an element in the abstract syntax tree.
Definition: Index.h:2884
A while statement.
Definition: Index.h:2038
If displaying the source-location information of the diagnostic, also include information about sourc...
Definition: Index.h:838
const CXIdxEntityInfo * parentEntity
Immediate "parent" of the reference. For example:
Definition: Index.h:5452
The GNU address of label extension, representing &&label.
Definition: Index.h:1828
A floating point number literal.
Definition: Index.h:1769
CINDEX_LINKAGE long long clang_getNumElements(CXType T)
Return the number of elements of an array or vector type.
Display the category name associated with this diagnostic, if any.
Definition: Index.h:865
Completions for fields of the member being accessed using the dot operator should be included in the ...
Definition: Index.h:4689
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:3369
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:5269
An lvalue ref-qualifier was provided (&).
Definition: Index.h:3322
struct CXTranslationUnitImpl * CXTranslationUnit
A single translation unit, which resides in an index.
Definition: Index.h:86
Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the range.
Definition: Index.h:4051
A MS inline assembly statement extension.
Definition: Index.h:2127
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:1615
CXSourceRange * ranges
An array of CXSourceRanges.
Definition: Index.h:618
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 master directive.
Definition: Index.h:2178
A reference to a variable that occurs in some non-expression context, e.g., a C++ lambda capture list...
Definition: Index.h:1715
CINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor)
Determine the lexical parent of the given cursor.
A C++ non-type template parameter.
Definition: Index.h:1593
[C++0x 2.14.7] C++ Pointer Literal.
Definition: Index.h:1884
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:2026
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:1561
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:3230
Used to indicate that the translation unit is incomplete.
Definition: Index.h:1146
CXVersion Deprecated
The version number in which this entity was deprecated (but is still available).
Definition: Index.h:2473
An Objective-C @selector expression.
Definition: Index.h:1921
A labelled statement in a function.
Definition: Index.h:2011
CINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor)
Retrieve the file that is included by the given inclusion directive cursor.
An implicit reference, e.g. a reference of an Objective-C method via the dot syntax.
Definition: Index.h:5424
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:713
CXCompletionString CompletionString
The code-completion string that describes how to insert this code-completion result into the editing ...
Definition: Index.h:4285
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:653
void * CXDiagnostic
A single diagnostic, containing the diagnostic's severity, location, text, source ranges...
Definition: Index.h:684
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:2214
A for statement.
Definition: Index.h:2046
An identifier (that is not a keyword).
Definition: Index.h:4103
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:5566
Objective-C's overall @try-@catch-@finally statement.
Definition: Index.h:2075
OpenMP task directive.
Definition: Index.h:2174
A C++ using directive.
Definition: Index.h:1605
Placeholder text that should be replaced by the user.
Definition: Index.h:4359
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:1816
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:4652
This is the linkage for entities with external linkage that live in C++ anonymous namespaces...
Definition: Index.h:2432
Represents a C11 generic selection.
Definition: Index.h:1836
An Objective-C @synthesize definition.
Definition: Index.h:1611
CXIdxLoc loc
Definition: Index.h:5436
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:3320
CINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor)
Returns the access control level for the referenced object.
unsigned numEntries
Definition: Index.h:1502
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:2202
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:4774
CINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit, CXToken)
Retrieve the source location of the given token.
#define CINDEX_LINKAGE
Definition: Platform.h:29
A C++ class method.
Definition: Index.h:1579
A language keyword.
Definition: Index.h:4098
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. CX_SC_Invalid was added for the case that t...
Definition: Index.h:3389
The type is an incomplete Type.
Definition: Index.h:3234
DEPRECATED: Enabled chained precompiled preambles in C++.
Definition: Index.h:1189
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:2111
OpenMP single directive.
Definition: Index.h:2162
struct CXPlatformAvailability CXPlatformAvailability
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:4673
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:5217
CXIdxAttrKind
Definition: Index.h:5293
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:4769
CXCallingConv
Describes the calling convention of a function type.
Definition: Index.h:2860
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:2133
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:2050
CINDEX_LINKAGE CXFile clang_Module_getTopLevelHeader(CXTranslationUnit, CXModule Module, unsigned Index)
Completions for values that resolve to an Objective-C selector should be included in the results...
Definition: Index.h:4678
Objective-C's collection statement.
Definition: Index.h:2099
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:1198
OpenMP taskgroup directive.
Definition: Index.h:2230
Implements the GNU __null extension, which is a name for a null pointer constant that has integral ty...
Definition: Index.h:1846
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:4733
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:3488
enum CXVisitorResult(* CXFieldVisitor)(CXCursor C, CXClientData client_data)
Visitor invoked for each field found by a traversal.
Definition: Index.h:5716
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:3474
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:2091
CXCompletionResult * Results
The code-completion results.
Definition: Index.h:4610
A left bracket ('[').
Definition: Index.h:4403
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'. This value will be negative if no minor version ...
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:1563
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:1595
Completions for Objective-C protocols should be included in the results.
Definition: Index.h:4738
An Objective-C instance method.
Definition: Index.h:1569
const CXIdxObjCProtocolRefListInfo * protocols
Definition: Index.h:5389
An rvalue ref-qualifier was provided (&&).
Definition: Index.h:3324
OpenMP parallel sections directive.
Definition: Index.h:2170
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:5182
Completions for enum tags should be included in the results.
Definition: Index.h:4704
Used to indicate that IndexerCallbacks::indexEntityReference should be invoked for only one reference...
Definition: Index.h:5595
int isImplicit
Whether the declaration exists in code or was created implicitly by the compiler, e...
Definition: Index.h:5350
Skip a function/method body that was already parsed during an indexing session associated with a CXIn...
Definition: Index.h:5619
const CXIdxObjCProtocolRefListInfo * protocols
Definition: Index.h:5397
A C++ constructor.
Definition: Index.h:1585
void * CXCompletionString
A semantic string that describes a code-completion result.
Definition: Index.h:4263
void * CXDiagnosticSet
A group of CXDiagnostics.
Definition: Index.h:689
CXIdxLoc loc
Definition: Index.h:5335
CXReparse_Flags
Flags that control the reparsing of translation units.
Definition: Index.h:1390
If displaying the source-location information of the diagnostic, also include the column number...
Definition: Index.h:828
Identifies an array of ranges.
Definition: Index.h:612
CXIdxLoc loc
Location where the file is imported. Applicable only for modules.
Definition: Index.h:5225
OpenMP parallel for directive.
Definition: Index.h:2166
[C99 6.5.2.1] Array Subscripting.
Definition: Index.h:1796
A statement whose specific kind is not exposed via this interface.
Definition: Index.h:1998
CINDEX_LINKAGE CXType clang_getCanonicalType(CXType T)
Return the canonical type for a CXType.
An Objective-C @property declaration.
Definition: Index.h:1565
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. The visitor function is called with t...
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:5409
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:4631
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 ...
Indicates that the translation unit to be saved was somehow invalid (e.g., NULL). ...
Definition: Index.h:1348
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:4722
CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU, CXToken *Tokens, unsigned NumTokens)
Free the given set of tokens.
CXCursor cursor
Definition: Index.h:5334
CXCodeComplete_Flags
Flags that can be passed to clang_codeCompleteAt() to modify its behavior.
Definition: Index.h:4626
const CXIdxObjCProtocolRefInfo *const * protocols
Definition: Index.h:5382
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:1205
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:5415
void * CXModule
Definition: Index.h:3868
Objective-C's autorelease pool statement.
Definition: Index.h:2095
Data for IndexerCallbacks::importedASTFile.
Definition: Index.h:5213
Windows Structured Exception Handling's finally statement.
Definition: Index.h:2123
#define CINDEX_DEPRECATED
Definition: Platform.h:38
CXNameRefFlags
Definition: Index.h:4046
An enumerator constant.
Definition: Index.h:1551
Implicit function/class template instantiations should be indexed. If this is not set...
Definition: Index.h:5607
unsigned numAttributes
Definition: Index.h:5314
unsigned count
The number of ranges in the ranges array.
Definition: Index.h:614
CINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken)
Determine the spelling of the given token.
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:4668
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:1934
A reference to a type declaration.
Definition: Index.h:1640
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:5096
Function returned successfully.
Definition: Index.h:5092
Completions for Objective-C class messages should be included in the results.
Definition: Index.h:4753
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:4694
Identifies a specific source location within a translation unit.
Definition: Index.h:368
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:1342
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:4727
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. This covers normal (non-extern) local variables.
Definition: Index.h:2427
CINDEX_LINKAGE unsigned clang_getCompletionNumAnnotations(CXCompletionString completion_string)
Retrieve the number of annotations associated with the given completion string.
CXResult
Definition: Index.h:5088
The context for completions is unexposed, as only Clang results should be included. (This is equivalent to having no context bits set.)
Definition: Index.h:4657
const CXIdxObjCContainerDeclInfo * containerInfo
Definition: Index.h:5387
CXCursorKind
Describes the kind of entity that a cursor refers to.
Definition: Index.h:1525
CINDEX_LINKAGE int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID)
Retrieve the unique ID for the given file.
CXCursor cursor
Reference cursor.
Definition: Index.h:5435
This represents the unary-expression's (except sizeof and alignof).
Definition: Index.h:1792
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:2103
CINDEX_LINKAGE unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C, unsigned reserved)
Given a cursor that represents a property declaration, return the associated property attributes...
This is the linkage for static variables and static functions.
Definition: Index.h:2429
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:2565
Text that specifies the result type of a given result.
Definition: Index.h:4435
Display the category number associated with this diagnostic, if any.
Definition: Index.h:856
Whether to include brief documentation within the set of code completions returned.
Definition: Index.h:4643
CXCursor cursor
Definition: Index.h:5302
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:1394
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:659
CXObjCDeclQualifierKind
'Qualifiers' written next to the return and parameter types in Objective-C method declarations...
Definition: Index.h:3792
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:2434
A GCC inline assembly statement extension.
Definition: Index.h:2070
const CXIdxEntityInfo * getter
Definition: Index.h:5402
int isImplicit
Non-zero if an inclusion directive was automatically turned into a module import. Applicable only for...
Definition: Index.h:5230
Terminates the cursor traversal.
Definition: Index.h:3478
Text that a user would be expected to type to get this code-completion result.
Definition: Index.h:4340
A colon (':').
Definition: Index.h:4439
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:382
CINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage)
This is the GNU Statement Expression extension: ({int X=4; X;})
Definition: Index.h:1832
void * CXRemapping
A remapping of original source files and their translated files.
Definition: Index.h:5022
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:1765
Completions for Objective-C selector names should be included in the results.
Definition: Index.h:4758
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:5388
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:847
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:4394
CXIdxLoc loc
Definition: Index.h:5372
An Objective-C @encode expression.
Definition: Index.h:1917
const char * filename
Filename as written in the #include/#import directive.
Definition: Index.h:5196
A C++ class.
Definition: Index.h:1542
Used to indicate that no special saving options are needed.
Definition: Index.h:1302
CXString Message
An optional message to provide to a user of this API, e.g., to suggest replacement APIs...
Definition: Index.h:2487
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:4415
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:4108
Completions for values that resolve to a C++ class type should be included in the results...
Definition: Index.h:4683
A group of statements like { stmt stmt }.
Definition: Index.h:2018
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:729
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:3483
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:1758
CXTokenKind
Describes a kind of token.
Definition: Index.h:4089
CINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent, CXCursorVisitor visitor, CXClientData client_data)
Visit the children of a particular cursor.
CINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind)
const CXIdxDeclInfo * declInfo
Definition: Index.h:5365
Completions for struct tags should be included in the results.
Definition: Index.h:4712
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:5307
CINDEX_LINKAGE enum CXCursorKind clang_codeCompleteGetContainerKind(CXCodeCompleteResults *Results, unsigned *IsIncomplete)
Returns the cursor kind for the container for the current code completion context. The container is only guaranteed to be set for contexts where a container exists (i.e. member accesses or Objective-C message sends); if there is not a container, this function will return CXCursor_InvalidCode.
An Objective-C string literal i.e. "foo".
Definition: Index.h:1913
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:2058
An Objective-C @implementation for a category.
Definition: Index.h:1575
OpenMP barrier directive.
Definition: Index.h:2190
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:4389
Identifies a half-open character range in the source code.
Definition: Index.h:379
A do statement.
Definition: Index.h:2042
CXLanguageKind
Describe the "language" of the entity referred to by a cursor.
Definition: Index.h:2544
enum CXTUResourceUsageKind kind
Definition: Index.h:1488
A comment.
Definition: Index.h:4113
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:1601
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:5200
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:1172
Used to indicate that no special translation-unit options are needed.
Definition: Index.h:1121
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:806
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:4699
CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit)
Retrieve the cursor that represents the given translation unit.
A C or C++ struct.
Definition: Index.h:1538
OpenMP section directive.
Definition: Index.h:2158
void * CXIdxClientFile
The client's data object that is associated with a CXFile.
Definition: Index.h:5158
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:648
CXIndexOptFlags
Definition: Index.h:5584
C++'s static_cast<> expression.
Definition: Index.h:1850
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:5180
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:3503
A new expression for memory allocation and constructor calls, e.g: "new CXXNewExpr(foo)".
Definition: Index.h:1900
Used to indicate that the translation unit will be serialized with clang_saveTranslationUnit.
Definition: Index.h:1181
A C++ destructor.
Definition: Index.h:1587
A left brace ('{').
Definition: Index.h:4411
Windows Structured Exception Handling's except statement.
Definition: Index.h:2119
const CXIdxEntityInfo * base
Definition: Index.h:5370
CXTypeKind
Describes the kind of type.
Definition: Index.h:2793
A return statement.
Definition: Index.h:2066
A right bracket (']').
Definition: Index.h:4407
const CXIdxEntityInfo * objcClass
Definition: Index.h:5323
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:1745
Used to indicate that no special indexing options are needed.
Definition: Index.h:5588
CXIdxDeclInfoFlags
Definition: Index.h:5328
Data for ppIncludedFile callback.
Definition: Index.h:5188
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 ...
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:4995
const CXIdxContainerInfo * container
Lexical container context of the reference.
Definition: Index.h:5456
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:1925
Kind
A C++ template type parameter.
Definition: Index.h:1591
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:5376
void * CXIdxClientContainer
The client's data object that is associated with a semantic container of entities.
Definition: Index.h:5169
CINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic)
Retrieve the text of the given diagnostic.
OpenMP teams directive.
Definition: Index.h:2226
C++'s const_cast<> expression.
Definition: Index.h:1862
The memory usage of a CXTranslationUnit, broken into categories.
Definition: Index.h:1497
OpenMP parallel directive.
Definition: Index.h:2142
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:1805
CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic)
Retrieve the category number for this diagnostic.
An indirect goto statement.
Definition: Index.h:2054
CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping)
Determine the number of remappings.
unsigned long amount
Definition: Index.h:1491
Describes a single preprocessing token.
Definition: Index.h:4119
An attribute whose specific kind is not exposed via this interface.
Definition: Index.h:2256
unsigned begin_int_data
Definition: Index.h:381
The function was terminated by a callback (e.g. it returned CXVisit_Break)
Definition: Index.h:5101
Represents an expression that computes the length of a parameter pack.
Definition: Index.h:1961
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:4295
OpenMP for directive.
Definition: Index.h:2150
A typedef.
Definition: Index.h:1577
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:677
Indicates that an unknown error occurred while attempting to deserialize diagnostics.
Definition: Index.h:723
A type whose specific kind is not exposed via this interface.
Definition: Index.h:2803
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:1549
const CXIdxEntityInfo * objcClass
Definition: Index.h:5394
OpenMP atomic directive.
Definition: Index.h:2210
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. If there is not a containe...
Indicates that no error occurred while saving a translation unit.
Definition: Index.h:1324
OpenMP SIMD directive.
Definition: Index.h:2146
CXObjCPropertyAttrKind
Property attributes for a CXCursor_ObjCPropertyDecl.
Definition: Index.h:3762
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:2464
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:1880
const CXIdxAttrInfo *const * attributes
Definition: Index.h:5313
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.
SmallVector< FormatToken *, 16 > Tokens
Definition: Format.cpp:1214
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:1650
int isRedeclaration
Definition: Index.h:5342
OpenMP cancel directive.
Definition: Index.h:2238
Represents a C++0x pack expansion that produces a sequence of expressions.
Definition: Index.h:1949
CINDEX_LINKAGE CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor, unsigned pieceIndex, unsigned options)
Retrieve a range for a piece that forms the cursors spelling name. Most of the times there is only on...
CXIdxObjCContainerKind
Definition: Index.h:5358
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:1607
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:5175
Completions for Objective-C instance messages should be included in the results.
Definition: Index.h:4748
Represents the "self" expression in an Objective-C method.
Definition: Index.h:1983
This value indicates that no linkage information is available for a provided CXCursor.
Definition: Index.h:2422
A C++ typeid expression (C++ [expr.typeid]).
Definition: Index.h:1876
A C++ namespace.
Definition: Index.h:1581
An expression whose specific kind is not exposed via this interface.
Definition: Index.h:1739
CXCursor cursor
Definition: Index.h:5318
static unsigned isEnabled(DiagnosticsEngine &D, unsigned diag)
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:5345
The ?: ternary operator.
Definition: Index.h:1809
A C++ class template.
Definition: Index.h:1599
A semicolon (';').
Definition: Index.h:4443
Windows Structured Exception Handling's try statement.
Definition: Index.h:2115
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:1133
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:4348
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:2482
An Objective-C instance variable.
Definition: Index.h:1567
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:2138
An expression that calls a function.
Definition: Index.h:1754
CXTemplateArgumentKind
Describes the kind of a template argument.
Definition: Index.h:2969
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:1858
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:5310
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. "delete[] pArray".
Definition: Index.h:1905
Used to indicate that the translation unit should be built with an implicit precompiled header for th...
Definition: Index.h:1162
CXCursor cursor
Definition: Index.h:5371
Objective-c Boolean Literal.
Definition: Index.h:1979
CXModule module
The imported module or NULL if the AST file is a PCH.
Definition: Index.h:5221
CXVisitorResult
Definition: Index.h:5078
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:5303
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:1557
A single result of code completion.
Definition: Index.h:4268
CXTUResourceUsageKind
Categorizes how memory is being used by a translation unit.
Definition: Index.h:1456
A C or C++ union.
Definition: Index.h:1540
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:1777
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:1824
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:4662
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:1116
CXIdxEntityLanguage lang
Definition: Index.h:5309
CINDEX_LINKAGE CXType clang_getElementType(CXType T)
Return the element type of an array, complex, or vector type.
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:4708
const CXIdxAttrInfo * attrInfo
Definition: Index.h:5322
The Field name is not valid for this record.
Definition: Index.h:3246
void * ptr_data
Definition: Index.h:4121
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:5163
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:5333
A right parenthesis (')'), used to finish a function call or signal the end of a function parameter l...
Definition: Index.h:4399
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. This can apply to: CXIdxEntity_Function CXIdxEntity_CXX...
Definition: Index.h:5286
CXTUResourceUsageEntry * entries
Definition: Index.h:1506
int isDefinition
Definition: Index.h:5343
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:665
OpenMP taskwait directive.
Definition: Index.h:2194
Suppress all compiler warnings when parsing for indexing.
Definition: Index.h:5612
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:4637
OpenMP taskyield directive.
Definition: Index.h:2186
A cursor representing some element in the abstract syntax tree for a translation unit.
Definition: Index.h:2317
An if statement.
Definition: Index.h:2030
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:717
CXIdxEntityRefKind kind
Definition: Index.h:5431
A reference to a member of a struct, union, or class that occurs in some non-expression context...
Definition: Index.h:1655
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:2289
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:2478
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:1536
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:1801
CINDEX_LINKAGE CXString clang_Module_getName(CXModule Module)
An Objective-C @dynamic definition.
Definition: Index.h:1613
CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module)
An '=' sign.
Definition: Index.h:4447
Indicates that an unknown error occurred while attempting to save the file.
Definition: Index.h:1333
C++'s dynamic_cast<> expression.
Definition: Index.h:1854
CXIdxObjCContainerKind kind
Definition: Index.h:5366
An Objective-C class method.
Definition: Index.h:1571
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:1320
int Major
The major version number, e.g., the '10' in '10.7.3'. A negative value indicates that there is no ver...
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:820
Represents an explicit C++ type conversion that uses "functional" notion (C++ [expr.type.conv]).
Definition: Index.h:1872
const CXIdxContainerInfo * lexicalContainer
Generally same as semanticContainer but can be different in cases like out-of-line C++ member functio...
Definition: Index.h:5341
A switch statement.
Definition: Index.h:2034
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:1544
OpenMP sections directive.
Definition: Index.h:2154
CINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind)
const CXIdxEntityInfo * referencedEntity
The entity that gets referenced.
Definition: Index.h:5440
CINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor)
Determine the semantic parent of the given cursor.
CXIdxAttrKind kind
Definition: Index.h:5301
const CXIdxAttrInfo *const * attributes
Definition: Index.h:5351
unsigned int_data
Definition: Index.h:370
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:735
Represents the "this" expression in C++.
Definition: Index.h:1888
Completions for C++ class names should be included in the results.
Definition: Index.h:4717
A right angle bracket ('>').
Definition: Index.h:4423
static bool isInstanceMethod(const Decl *D)
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 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.
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:5234
An Objective-C @implementation.
Definition: Index.h:1573
int isContainer
Definition: Index.h:5344
int isModuleImport
Non-zero if the directive was automatically turned into a module import.
Definition: Index.h:5207
A left angle bracket ('<').
Definition: Index.h:4419
CINDEX_LINKAGE int clang_getNumArgTypes(CXType T)
Retrieve the number of non-variadic parameters associated with a function type.
unsigned flags
Definition: Index.h:5354
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:5336
A code completion overload candidate.
Definition: Index.h:2296
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:4764
unsigned numAttributes
Definition: Index.h:5352
Objective-C's @finally statement.
Definition: Index.h:2083
Cursor that represents the translation unit itself.
Definition: Index.h:2248
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:2468
const CXIdxObjCContainerDeclInfo * containerInfo
Definition: Index.h:5393
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:2206
CXGlobalOptFlags
Definition: Index.h:220
const CXIdxEntityInfo * setter
Definition: Index.h:5403
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:2419
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:4606
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:303
This diagnostic indicates that the code is ill-formed.
Definition: Index.h:670
The entity is referenced directly in user's code.
Definition: Index.h:5419
A reference to a set of overloaded functions or function templates that has not yet been resolved to ...
Definition: Index.h:1709
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:4093
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:1751
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:4329
The type is not a constant size type.
Definition: Index.h:3242
CINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B)
Determine whether two CXTypes represent the same type.
OpenMP target directive.
Definition: Index.h:2222
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:5308
A function.
Definition: Index.h:1553
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. <int> in x.f<int>, in the range.
Definition: Index.h:4057
A parenthesized expression, e.g. "(1)".
Definition: Index.h:1787
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:2198
int xdata
Definition: Index.h:2319
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:1559
A linkage specification, e.g. 'extern "C"'.
Definition: Index.h:1583
CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path)
Retrieve a remapping.
A C++ conversion function.
Definition: Index.h:1589
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. This is now deprecated. Use clang_getDiagnosti...
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:5463
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:1671
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:3226
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:1773
OpenMP parallel for SIMD directive.
Definition: Index.h:2218
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.
A comma separator (',').
Definition: Index.h:4427
CXRefQualifierKind
Definition: Index.h:3318