1/*===-- clang-c/Index.h - Indexing Public C Interface -------------*- C -*-===*\
2|* *|
3|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
4|* Exceptions. *|
5|* See https://llvm.org/LICENSE.txt for license information. *|
6|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
7|* *|
8|*===----------------------------------------------------------------------===*|
9|* *|
10|* This header provides a public interface to a Clang library for extracting *|
11|* high-level symbol information from source files without exposing the full *|
12|* Clang C++ API. *|
13|* *|
14\*===----------------------------------------------------------------------===*/
15
16#ifndef LLVM_CLANG_C_INDEX_H
17#define LLVM_CLANG_C_INDEX_H
18
19#include "clang-c/BuildSystem.h"
20#include "clang-c/CXDiagnostic.h"
21#include "clang-c/CXErrorCode.h"
22#include "clang-c/CXFile.h"
23#include "clang-c/CXSourceLocation.h"
24#include "clang-c/CXString.h"
25#include "clang-c/ExternC.h"
26#include "clang-c/Platform.h"
27
28/**
29 * The version constants for the libclang API.
30 * CINDEX_VERSION_MINOR should increase when there are API additions.
31 * CINDEX_VERSION_MAJOR is intended for "major" source/ABI breaking changes.
32 *
33 * The policy about the libclang API was always to keep it source and ABI
34 * compatible, thus CINDEX_VERSION_MAJOR is expected to remain stable.
35 */
36#define CINDEX_VERSION_MAJOR 0
37#define CINDEX_VERSION_MINOR 64
38
39#define CINDEX_VERSION_ENCODE(major, minor) (((major) * 10000) + ((minor) * 1))
40
41#define CINDEX_VERSION \
42 CINDEX_VERSION_ENCODE(CINDEX_VERSION_MAJOR, CINDEX_VERSION_MINOR)
43
44#define CINDEX_VERSION_STRINGIZE_(major, minor) #major "." #minor
45#define CINDEX_VERSION_STRINGIZE(major, minor) \
46 CINDEX_VERSION_STRINGIZE_(major, minor)
47
48#define CINDEX_VERSION_STRING \
49 CINDEX_VERSION_STRINGIZE(CINDEX_VERSION_MAJOR, CINDEX_VERSION_MINOR)
50
51#ifndef __has_feature
52#define __has_feature(feature) 0
53#endif
54
55LLVM_CLANG_C_EXTERN_C_BEGIN
56
57/** \defgroup CINDEX libclang: C Interface to Clang
58 *
59 * The C Interface to Clang provides a relatively small API that exposes
60 * facilities for parsing source code into an abstract syntax tree (AST),
61 * loading already-parsed ASTs, traversing the AST, associating
62 * physical source locations with elements within the AST, and other
63 * facilities that support Clang-based development tools.
64 *
65 * This C interface to Clang will never provide all of the information
66 * representation stored in Clang's C++ AST, nor should it: the intent is to
67 * maintain an API that is relatively stable from one release to the next,
68 * providing only the basic functionality needed to support development tools.
69 *
70 * To avoid namespace pollution, data types are prefixed with "CX" and
71 * functions are prefixed with "clang_".
72 *
73 * @{
74 */
75
76/**
77 * An "index" that consists of a set of translation units that would
78 * typically be linked together into an executable or library.
79 */
80typedef void *CXIndex;
81
82/**
83 * An opaque type representing target information for a given translation
84 * unit.
85 */
86typedef struct CXTargetInfoImpl *CXTargetInfo;
87
88/**
89 * A single translation unit, which resides in an index.
90 */
91typedef struct CXTranslationUnitImpl *CXTranslationUnit;
92
93/**
94 * Opaque pointer representing client data that will be passed through
95 * to various callbacks and visitors.
96 */
97typedef void *CXClientData;
98
99/**
100 * Provides the contents of a file that has not yet been saved to disk.
101 *
102 * Each CXUnsavedFile instance provides the name of a file on the
103 * system along with the current contents of that file that have not
104 * yet been saved to disk.
105 */
106struct CXUnsavedFile {
107 /**
108 * The file whose contents have not yet been saved.
109 *
110 * This file must already exist in the file system.
111 */
112 const char *Filename;
113
114 /**
115 * A buffer containing the unsaved contents of this file.
116 */
117 const char *Contents;
118
119 /**
120 * The length of the unsaved contents of this buffer.
121 */
122 unsigned long Length;
123};
124
125/**
126 * Describes the availability of a particular entity, which indicates
127 * whether the use of this entity will result in a warning or error due to
128 * it being deprecated or unavailable.
129 */
130enum CXAvailabilityKind {
131 /**
132 * The entity is available.
133 */
134 CXAvailability_Available,
135 /**
136 * The entity is available, but has been deprecated (and its use is
137 * not recommended).
138 */
139 CXAvailability_Deprecated,
140 /**
141 * The entity is not available; any use of it will be an error.
142 */
143 CXAvailability_NotAvailable,
144 /**
145 * The entity is available, but not accessible; any use of it will be
146 * an error.
147 */
148 CXAvailability_NotAccessible
149};
150
151/**
152 * Describes a version number of the form major.minor.subminor.
153 */
154typedef struct CXVersion {
155 /**
156 * The major version number, e.g., the '10' in '10.7.3'. A negative
157 * value indicates that there is no version number at all.
158 */
159 int Major;
160 /**
161 * The minor version number, e.g., the '7' in '10.7.3'. This value
162 * will be negative if no minor version number was provided, e.g., for
163 * version '10'.
164 */
165 int Minor;
166 /**
167 * The subminor version number, e.g., the '3' in '10.7.3'. This value
168 * will be negative if no minor or subminor version number was provided,
169 * e.g., in version '10' or '10.7'.
170 */
171 int Subminor;
172} CXVersion;
173
174/**
175 * Describes the exception specification of a cursor.
176 *
177 * A negative value indicates that the cursor is not a function declaration.
178 */
179enum CXCursor_ExceptionSpecificationKind {
180 /**
181 * The cursor has no exception specification.
182 */
183 CXCursor_ExceptionSpecificationKind_None,
184
185 /**
186 * The cursor has exception specification throw()
187 */
188 CXCursor_ExceptionSpecificationKind_DynamicNone,
189
190 /**
191 * The cursor has exception specification throw(T1, T2)
192 */
193 CXCursor_ExceptionSpecificationKind_Dynamic,
194
195 /**
196 * The cursor has exception specification throw(...).
197 */
198 CXCursor_ExceptionSpecificationKind_MSAny,
199
200 /**
201 * The cursor has exception specification basic noexcept.
202 */
203 CXCursor_ExceptionSpecificationKind_BasicNoexcept,
204
205 /**
206 * The cursor has exception specification computed noexcept.
207 */
208 CXCursor_ExceptionSpecificationKind_ComputedNoexcept,
209
210 /**
211 * The exception specification has not yet been evaluated.
212 */
213 CXCursor_ExceptionSpecificationKind_Unevaluated,
214
215 /**
216 * The exception specification has not yet been instantiated.
217 */
218 CXCursor_ExceptionSpecificationKind_Uninstantiated,
219
220 /**
221 * The exception specification has not been parsed yet.
222 */
223 CXCursor_ExceptionSpecificationKind_Unparsed,
224
225 /**
226 * The cursor has a __declspec(nothrow) exception specification.
227 */
228 CXCursor_ExceptionSpecificationKind_NoThrow
229};
230
231/**
232 * Provides a shared context for creating translation units.
233 *
234 * It provides two options:
235 *
236 * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local"
237 * declarations (when loading any new translation units). A "local" declaration
238 * is one that belongs in the translation unit itself and not in a precompiled
239 * header that was used by the translation unit. If zero, all declarations
240 * will be enumerated.
241 *
242 * Here is an example:
243 *
244 * \code
245 * // excludeDeclsFromPCH = 1, displayDiagnostics=1
246 * Idx = clang_createIndex(1, 1);
247 *
248 * // IndexTest.pch was produced with the following command:
249 * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch"
250 * TU = clang_createTranslationUnit(Idx, "IndexTest.pch");
251 *
252 * // This will load all the symbols from 'IndexTest.pch'
253 * clang_visitChildren(clang_getTranslationUnitCursor(TU),
254 * TranslationUnitVisitor, 0);
255 * clang_disposeTranslationUnit(TU);
256 *
257 * // This will load all the symbols from 'IndexTest.c', excluding symbols
258 * // from 'IndexTest.pch'.
259 * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" };
260 * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args,
261 * 0, 0);
262 * clang_visitChildren(clang_getTranslationUnitCursor(TU),
263 * TranslationUnitVisitor, 0);
264 * clang_disposeTranslationUnit(TU);
265 * \endcode
266 *
267 * This process of creating the 'pch', loading it separately, and using it (via
268 * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks
269 * (which gives the indexer the same performance benefit as the compiler).
270 */
271CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
272 int displayDiagnostics);
273
274/**
275 * Destroy the given index.
276 *
277 * The index must not be destroyed until all of the translation units created
278 * within that index have been destroyed.
279 */
280CINDEX_LINKAGE void clang_disposeIndex(CXIndex index);
281
282typedef enum {
283 /**
284 * Use the default value of an option that may depend on the process
285 * environment.
286 */
287 CXChoice_Default = 0,
288 /**
289 * Enable the option.
290 */
291 CXChoice_Enabled = 1,
292 /**
293 * Disable the option.
294 */
295 CXChoice_Disabled = 2
296} CXChoice;
297
298typedef enum {
299 /**
300 * Used to indicate that no special CXIndex options are needed.
301 */
302 CXGlobalOpt_None = 0x0,
303
304 /**
305 * Used to indicate that threads that libclang creates for indexing
306 * purposes should use background priority.
307 *
308 * Affects #clang_indexSourceFile, #clang_indexTranslationUnit,
309 * #clang_parseTranslationUnit, #clang_saveTranslationUnit.
310 */
311 CXGlobalOpt_ThreadBackgroundPriorityForIndexing = 0x1,
312
313 /**
314 * Used to indicate that threads that libclang creates for editing
315 * purposes should use background priority.
316 *
317 * Affects #clang_reparseTranslationUnit, #clang_codeCompleteAt,
318 * #clang_annotateTokens
319 */
320 CXGlobalOpt_ThreadBackgroundPriorityForEditing = 0x2,
321
322 /**
323 * Used to indicate that all threads that libclang creates should use
324 * background priority.
325 */
326 CXGlobalOpt_ThreadBackgroundPriorityForAll =
327 CXGlobalOpt_ThreadBackgroundPriorityForIndexing |
328 CXGlobalOpt_ThreadBackgroundPriorityForEditing
329
330} CXGlobalOptFlags;
331
332/**
333 * Index initialization options.
334 *
335 * 0 is the default value of each member of this struct except for Size.
336 * Initialize the struct in one of the following three ways to avoid adapting
337 * code each time a new member is added to it:
338 * \code
339 * CXIndexOptions Opts;
340 * memset(&Opts, 0, sizeof(Opts));
341 * Opts.Size = sizeof(CXIndexOptions);
342 * \endcode
343 * or explicitly initialize the first data member and zero-initialize the rest:
344 * \code
345 * CXIndexOptions Opts = { sizeof(CXIndexOptions) };
346 * \endcode
347 * or to prevent the -Wmissing-field-initializers warning for the above version:
348 * \code
349 * CXIndexOptions Opts{};
350 * Opts.Size = sizeof(CXIndexOptions);
351 * \endcode
352 */
353typedef struct CXIndexOptions {
354 /**
355 * The size of struct CXIndexOptions used for option versioning.
356 *
357 * Always initialize this member to sizeof(CXIndexOptions), or assign
358 * sizeof(CXIndexOptions) to it right after creating a CXIndexOptions object.
359 */
360 unsigned Size;
361 /**
362 * A CXChoice enumerator that specifies the indexing priority policy.
363 * \sa CXGlobalOpt_ThreadBackgroundPriorityForIndexing
364 */
365 unsigned char ThreadBackgroundPriorityForIndexing;
366 /**
367 * A CXChoice enumerator that specifies the editing priority policy.
368 * \sa CXGlobalOpt_ThreadBackgroundPriorityForEditing
369 */
370 unsigned char ThreadBackgroundPriorityForEditing;
371 /**
372 * \see clang_createIndex()
373 */
374 unsigned ExcludeDeclarationsFromPCH : 1;
375 /**
376 * \see clang_createIndex()
377 */
378 unsigned DisplayDiagnostics : 1;
379 /**
380 * Store PCH in memory. If zero, PCH are stored in temporary files.
381 */
382 unsigned StorePreamblesInMemory : 1;
383 unsigned /*Reserved*/ : 13;
384
385 /**
386 * The path to a directory, in which to store temporary PCH files. If null or
387 * empty, the default system temporary directory is used. These PCH files are
388 * deleted on clean exit but stay on disk if the program crashes or is killed.
389 *
390 * This option is ignored if \a StorePreamblesInMemory is non-zero.
391 *
392 * Libclang does not create the directory at the specified path in the file
393 * system. Therefore it must exist, or storing PCH files will fail.
394 */
395 const char *PreambleStoragePath;
396 /**
397 * Specifies a path which will contain log files for certain libclang
398 * invocations. A null value implies that libclang invocations are not logged.
399 */
400 const char *InvocationEmissionPath;
401} CXIndexOptions;
402
403/**
404 * Provides a shared context for creating translation units.
405 *
406 * Call this function instead of clang_createIndex() if you need to configure
407 * the additional options in CXIndexOptions.
408 *
409 * \returns The created index or null in case of error, such as an unsupported
410 * value of options->Size.
411 *
412 * For example:
413 * \code
414 * CXIndex createIndex(const char *ApplicationTemporaryPath) {
415 * const int ExcludeDeclarationsFromPCH = 1;
416 * const int DisplayDiagnostics = 1;
417 * CXIndex Idx;
418 * #if CINDEX_VERSION_MINOR >= 64
419 * CXIndexOptions Opts;
420 * memset(&Opts, 0, sizeof(Opts));
421 * Opts.Size = sizeof(CXIndexOptions);
422 * Opts.ThreadBackgroundPriorityForIndexing = 1;
423 * Opts.ExcludeDeclarationsFromPCH = ExcludeDeclarationsFromPCH;
424 * Opts.DisplayDiagnostics = DisplayDiagnostics;
425 * Opts.PreambleStoragePath = ApplicationTemporaryPath;
426 * Idx = clang_createIndexWithOptions(&Opts);
427 * if (Idx)
428 * return Idx;
429 * fprintf(stderr,
430 * "clang_createIndexWithOptions() failed. "
431 * "CINDEX_VERSION_MINOR = %d, sizeof(CXIndexOptions) = %u\n",
432 * CINDEX_VERSION_MINOR, Opts.Size);
433 * #else
434 * (void)ApplicationTemporaryPath;
435 * #endif
436 * Idx = clang_createIndex(ExcludeDeclarationsFromPCH, DisplayDiagnostics);
437 * clang_CXIndex_setGlobalOptions(
438 * Idx, clang_CXIndex_getGlobalOptions(Idx) |
439 * CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
440 * return Idx;
441 * }
442 * \endcode
443 *
444 * \sa clang_createIndex()
445 */
446CINDEX_LINKAGE CXIndex
447clang_createIndexWithOptions(const CXIndexOptions *options);
448
449/**
450 * Sets general options associated with a CXIndex.
451 *
452 * This function is DEPRECATED. Set
453 * CXIndexOptions::ThreadBackgroundPriorityForIndexing and/or
454 * CXIndexOptions::ThreadBackgroundPriorityForEditing and call
455 * clang_createIndexWithOptions() instead.
456 *
457 * For example:
458 * \code
459 * CXIndex idx = ...;
460 * clang_CXIndex_setGlobalOptions(idx,
461 * clang_CXIndex_getGlobalOptions(idx) |
462 * CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
463 * \endcode
464 *
465 * \param options A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags.
466 */
467CINDEX_LINKAGE void clang_CXIndex_setGlobalOptions(CXIndex, unsigned options);
468
469/**
470 * Gets the general options associated with a CXIndex.
471 *
472 * This function allows to obtain the final option values used by libclang after
473 * specifying the option policies via CXChoice enumerators.
474 *
475 * \returns A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags that
476 * are associated with the given CXIndex object.
477 */
478CINDEX_LINKAGE unsigned clang_CXIndex_getGlobalOptions(CXIndex);
479
480/**
481 * Sets the invocation emission path option in a CXIndex.
482 *
483 * This function is DEPRECATED. Set CXIndexOptions::InvocationEmissionPath and
484 * call clang_createIndexWithOptions() instead.
485 *
486 * The invocation emission path specifies a path which will contain log
487 * files for certain libclang invocations. A null value (default) implies that
488 * libclang invocations are not logged..
489 */
490CINDEX_LINKAGE void
491clang_CXIndex_setInvocationEmissionPathOption(CXIndex, const char *Path);
492
493/**
494 * Determine whether the given header is guarded against
495 * multiple inclusions, either with the conventional
496 * \#ifndef/\#define/\#endif macro guards or with \#pragma once.
497 */
498CINDEX_LINKAGE unsigned clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu,
499 CXFile file);
500
501/**
502 * Retrieve a file handle within the given translation unit.
503 *
504 * \param tu the translation unit
505 *
506 * \param file_name the name of the file.
507 *
508 * \returns the file handle for the named file in the translation unit \p tu,
509 * or a NULL file handle if the file was not a part of this translation unit.
510 */
511CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu,
512 const char *file_name);
513
514/**
515 * Retrieve the buffer associated with the given file.
516 *
517 * \param tu the translation unit
518 *
519 * \param file the file for which to retrieve the buffer.
520 *
521 * \param size [out] if non-NULL, will be set to the size of the buffer.
522 *
523 * \returns a pointer to the buffer in memory that holds the contents of
524 * \p file, or a NULL pointer when the file is not loaded.
525 */
526CINDEX_LINKAGE const char *clang_getFileContents(CXTranslationUnit tu,
527 CXFile file, size_t *size);
528
529/**
530 * Retrieves the source location associated with a given file/line/column
531 * in a particular translation unit.
532 */
533CINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu,
534 CXFile file, unsigned line,
535 unsigned column);
536/**
537 * Retrieves the source location associated with a given character offset
538 * in a particular translation unit.
539 */
540CINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
541 CXFile file,
542 unsigned offset);
543
544/**
545 * Retrieve all ranges that were skipped by the preprocessor.
546 *
547 * The preprocessor will skip lines when they are surrounded by an
548 * if/ifdef/ifndef directive whose condition does not evaluate to true.
549 */
550CINDEX_LINKAGE CXSourceRangeList *clang_getSkippedRanges(CXTranslationUnit tu,
551 CXFile file);
552
553/**
554 * Retrieve all ranges from all files that were skipped by the
555 * preprocessor.
556 *
557 * The preprocessor will skip lines when they are surrounded by an
558 * if/ifdef/ifndef directive whose condition does not evaluate to true.
559 */
560CINDEX_LINKAGE CXSourceRangeList *
561clang_getAllSkippedRanges(CXTranslationUnit tu);
562
563/**
564 * Determine the number of diagnostics produced for the given
565 * translation unit.
566 */
567CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit);
568
569/**
570 * Retrieve a diagnostic associated with the given translation unit.
571 *
572 * \param Unit the translation unit to query.
573 * \param Index the zero-based diagnostic number to retrieve.
574 *
575 * \returns the requested diagnostic. This diagnostic must be freed
576 * via a call to \c clang_disposeDiagnostic().
577 */
578CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit,
579 unsigned Index);
580
581/**
582 * Retrieve the complete set of diagnostics associated with a
583 * translation unit.
584 *
585 * \param Unit the translation unit to query.
586 */
587CINDEX_LINKAGE CXDiagnosticSet
588clang_getDiagnosticSetFromTU(CXTranslationUnit Unit);
589
590/**
591 * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation
592 *
593 * The routines in this group provide the ability to create and destroy
594 * translation units from files, either by parsing the contents of the files or
595 * by reading in a serialized representation of a translation unit.
596 *
597 * @{
598 */
599
600/**
601 * Get the original translation unit source file name.
602 */
603CINDEX_LINKAGE CXString
604clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
605
606/**
607 * Return the CXTranslationUnit for a given source file and the provided
608 * command line arguments one would pass to the compiler.
609 *
610 * Note: The 'source_filename' argument is optional. If the caller provides a
611 * NULL pointer, the name of the source file is expected to reside in the
612 * specified command line arguments.
613 *
614 * Note: When encountered in 'clang_command_line_args', the following options
615 * are ignored:
616 *
617 * '-c'
618 * '-emit-ast'
619 * '-fsyntax-only'
620 * '-o \<output file>' (both '-o' and '\<output file>' are ignored)
621 *
622 * \param CIdx The index object with which the translation unit will be
623 * associated.
624 *
625 * \param source_filename The name of the source file to load, or NULL if the
626 * source file is included in \p clang_command_line_args.
627 *
628 * \param num_clang_command_line_args The number of command-line arguments in
629 * \p clang_command_line_args.
630 *
631 * \param clang_command_line_args The command-line arguments that would be
632 * passed to the \c clang executable if it were being invoked out-of-process.
633 * These command-line options will be parsed and will affect how the translation
634 * unit is parsed. Note that the following options are ignored: '-c',
635 * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'.
636 *
637 * \param num_unsaved_files the number of unsaved file entries in \p
638 * unsaved_files.
639 *
640 * \param unsaved_files the files that have not yet been saved to disk
641 * but may be required for code completion, including the contents of
642 * those files. The contents and name of these files (as specified by
643 * CXUnsavedFile) are copied when necessary, so the client only needs to
644 * guarantee their validity until the call to this function returns.
645 */
646CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile(
647 CXIndex CIdx, const char *source_filename, int num_clang_command_line_args,
648 const char *const *clang_command_line_args, unsigned num_unsaved_files,
649 struct CXUnsavedFile *unsaved_files);
650
651/**
652 * Same as \c clang_createTranslationUnit2, but returns
653 * the \c CXTranslationUnit instead of an error code. In case of an error this
654 * routine returns a \c NULL \c CXTranslationUnit, without further detailed
655 * error codes.
656 */
657CINDEX_LINKAGE CXTranslationUnit
658clang_createTranslationUnit(CXIndex CIdx, const char *ast_filename);
659
660/**
661 * Create a translation unit from an AST file (\c -emit-ast).
662 *
663 * \param[out] out_TU A non-NULL pointer to store the created
664 * \c CXTranslationUnit.
665 *
666 * \returns Zero on success, otherwise returns an error code.
667 */
668CINDEX_LINKAGE enum CXErrorCode
669clang_createTranslationUnit2(CXIndex CIdx, const char *ast_filename,
670 CXTranslationUnit *out_TU);
671
672/**
673 * Flags that control the creation of translation units.
674 *
675 * The enumerators in this enumeration type are meant to be bitwise
676 * ORed together to specify which options should be used when
677 * constructing the translation unit.
678 */
679enum CXTranslationUnit_Flags {
680 /**
681 * Used to indicate that no special translation-unit options are
682 * needed.
683 */
684 CXTranslationUnit_None = 0x0,
685
686 /**
687 * Used to indicate that the parser should construct a "detailed"
688 * preprocessing record, including all macro definitions and instantiations.
689 *
690 * Constructing a detailed preprocessing record requires more memory
691 * and time to parse, since the information contained in the record
692 * is usually not retained. However, it can be useful for
693 * applications that require more detailed information about the
694 * behavior of the preprocessor.
695 */
696 CXTranslationUnit_DetailedPreprocessingRecord = 0x01,
697
698 /**
699 * Used to indicate that the translation unit is incomplete.
700 *
701 * When a translation unit is considered "incomplete", semantic
702 * analysis that is typically performed at the end of the
703 * translation unit will be suppressed. For example, this suppresses
704 * the completion of tentative declarations in C and of
705 * instantiation of implicitly-instantiation function templates in
706 * C++. This option is typically used when parsing a header with the
707 * intent of producing a precompiled header.
708 */
709 CXTranslationUnit_Incomplete = 0x02,
710
711 /**
712 * Used to indicate that the translation unit should be built with an
713 * implicit precompiled header for the preamble.
714 *
715 * An implicit precompiled header is used as an optimization when a
716 * particular translation unit is likely to be reparsed many times
717 * when the sources aren't changing that often. In this case, an
718 * implicit precompiled header will be built containing all of the
719 * initial includes at the top of the main file (what we refer to as
720 * the "preamble" of the file). In subsequent parses, if the
721 * preamble or the files in it have not changed, \c
722 * clang_reparseTranslationUnit() will re-use the implicit
723 * precompiled header to improve parsing performance.
724 */
725 CXTranslationUnit_PrecompiledPreamble = 0x04,
726
727 /**
728 * Used to indicate that the translation unit should cache some
729 * code-completion results with each reparse of the source file.
730 *
731 * Caching of code-completion results is a performance optimization that
732 * introduces some overhead to reparsing but improves the performance of
733 * code-completion operations.
734 */
735 CXTranslationUnit_CacheCompletionResults = 0x08,
736
737 /**
738 * Used to indicate that the translation unit will be serialized with
739 * \c clang_saveTranslationUnit.
740 *
741 * This option is typically used when parsing a header with the intent of
742 * producing a precompiled header.
743 */
744 CXTranslationUnit_ForSerialization = 0x10,
745
746 /**
747 * DEPRECATED: Enabled chained precompiled preambles in C++.
748 *
749 * Note: this is a *temporary* option that is available only while
750 * we are testing C++ precompiled preamble support. It is deprecated.
751 */
752 CXTranslationUnit_CXXChainedPCH = 0x20,
753
754 /**
755 * Used to indicate that function/method bodies should be skipped while
756 * parsing.
757 *
758 * This option can be used to search for declarations/definitions while
759 * ignoring the usages.
760 */
761 CXTranslationUnit_SkipFunctionBodies = 0x40,
762
763 /**
764 * Used to indicate that brief documentation comments should be
765 * included into the set of code completions returned from this translation
766 * unit.
767 */
768 CXTranslationUnit_IncludeBriefCommentsInCodeCompletion = 0x80,
769
770 /**
771 * Used to indicate that the precompiled preamble should be created on
772 * the first parse. Otherwise it will be created on the first reparse. This
773 * trades runtime on the first parse (serializing the preamble takes time) for
774 * reduced runtime on the second parse (can now reuse the preamble).
775 */
776 CXTranslationUnit_CreatePreambleOnFirstParse = 0x100,
777
778 /**
779 * Do not stop processing when fatal errors are encountered.
780 *
781 * When fatal errors are encountered while parsing a translation unit,
782 * semantic analysis is typically stopped early when compiling code. A common
783 * source for fatal errors are unresolvable include files. For the
784 * purposes of an IDE, this is undesirable behavior and as much information
785 * as possible should be reported. Use this flag to enable this behavior.
786 */
787 CXTranslationUnit_KeepGoing = 0x200,
788
789 /**
790 * Sets the preprocessor in a mode for parsing a single file only.
791 */
792 CXTranslationUnit_SingleFileParse = 0x400,
793
794 /**
795 * Used in combination with CXTranslationUnit_SkipFunctionBodies to
796 * constrain the skipping of function bodies to the preamble.
797 *
798 * The function bodies of the main file are not skipped.
799 */
800 CXTranslationUnit_LimitSkipFunctionBodiesToPreamble = 0x800,
801
802 /**
803 * Used to indicate that attributed types should be included in CXType.
804 */
805 CXTranslationUnit_IncludeAttributedTypes = 0x1000,
806
807 /**
808 * Used to indicate that implicit attributes should be visited.
809 */
810 CXTranslationUnit_VisitImplicitAttributes = 0x2000,
811
812 /**
813 * Used to indicate that non-errors from included files should be ignored.
814 *
815 * If set, clang_getDiagnosticSetFromTU() will not report e.g. warnings from
816 * included files anymore. This speeds up clang_getDiagnosticSetFromTU() for
817 * the case where these warnings are not of interest, as for an IDE for
818 * example, which typically shows only the diagnostics in the main file.
819 */
820 CXTranslationUnit_IgnoreNonErrorsFromIncludedFiles = 0x4000,
821
822 /**
823 * Tells the preprocessor not to skip excluded conditional blocks.
824 */
825 CXTranslationUnit_RetainExcludedConditionalBlocks = 0x8000
826};
827
828/**
829 * Returns the set of flags that is suitable for parsing a translation
830 * unit that is being edited.
831 *
832 * The set of flags returned provide options for \c clang_parseTranslationUnit()
833 * to indicate that the translation unit is likely to be reparsed many times,
834 * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly
835 * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag
836 * set contains an unspecified set of optimizations (e.g., the precompiled
837 * preamble) geared toward improving the performance of these routines. The
838 * set of optimizations enabled may change from one version to the next.
839 */
840CINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void);
841
842/**
843 * Same as \c clang_parseTranslationUnit2, but returns
844 * the \c CXTranslationUnit instead of an error code. In case of an error this
845 * routine returns a \c NULL \c CXTranslationUnit, without further detailed
846 * error codes.
847 */
848CINDEX_LINKAGE CXTranslationUnit clang_parseTranslationUnit(
849 CXIndex CIdx, const char *source_filename,
850 const char *const *command_line_args, int num_command_line_args,
851 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
852 unsigned options);
853
854/**
855 * Parse the given source file and the translation unit corresponding
856 * to that file.
857 *
858 * This routine is the main entry point for the Clang C API, providing the
859 * ability to parse a source file into a translation unit that can then be
860 * queried by other functions in the API. This routine accepts a set of
861 * command-line arguments so that the compilation can be configured in the same
862 * way that the compiler is configured on the command line.
863 *
864 * \param CIdx The index object with which the translation unit will be
865 * associated.
866 *
867 * \param source_filename The name of the source file to load, or NULL if the
868 * source file is included in \c command_line_args.
869 *
870 * \param command_line_args The command-line arguments that would be
871 * passed to the \c clang executable if it were being invoked out-of-process.
872 * These command-line options will be parsed and will affect how the translation
873 * unit is parsed. Note that the following options are ignored: '-c',
874 * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'.
875 *
876 * \param num_command_line_args The number of command-line arguments in
877 * \c command_line_args.
878 *
879 * \param unsaved_files the files that have not yet been saved to disk
880 * but may be required for parsing, including the contents of
881 * those files. The contents and name of these files (as specified by
882 * CXUnsavedFile) are copied when necessary, so the client only needs to
883 * guarantee their validity until the call to this function returns.
884 *
885 * \param num_unsaved_files the number of unsaved file entries in \p
886 * unsaved_files.
887 *
888 * \param options A bitmask of options that affects how the translation unit
889 * is managed but not its compilation. This should be a bitwise OR of the
890 * CXTranslationUnit_XXX flags.
891 *
892 * \param[out] out_TU A non-NULL pointer to store the created
893 * \c CXTranslationUnit, describing the parsed code and containing any
894 * diagnostics produced by the compiler.
895 *
896 * \returns Zero on success, otherwise returns an error code.
897 */
898CINDEX_LINKAGE enum CXErrorCode clang_parseTranslationUnit2(
899 CXIndex CIdx, const char *source_filename,
900 const char *const *command_line_args, int num_command_line_args,
901 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
902 unsigned options, CXTranslationUnit *out_TU);
903
904/**
905 * Same as clang_parseTranslationUnit2 but requires a full command line
906 * for \c command_line_args including argv[0]. This is useful if the standard
907 * library paths are relative to the binary.
908 */
909CINDEX_LINKAGE enum CXErrorCode clang_parseTranslationUnit2FullArgv(
910 CXIndex CIdx, const char *source_filename,
911 const char *const *command_line_args, int num_command_line_args,
912 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
913 unsigned options, CXTranslationUnit *out_TU);
914
915/**
916 * Flags that control how translation units are saved.
917 *
918 * The enumerators in this enumeration type are meant to be bitwise
919 * ORed together to specify which options should be used when
920 * saving the translation unit.
921 */
922enum CXSaveTranslationUnit_Flags {
923 /**
924 * Used to indicate that no special saving options are needed.
925 */
926 CXSaveTranslationUnit_None = 0x0
927};
928
929/**
930 * Returns the set of flags that is suitable for saving a translation
931 * unit.
932 *
933 * The set of flags returned provide options for
934 * \c clang_saveTranslationUnit() by default. The returned flag
935 * set contains an unspecified set of options that save translation units with
936 * the most commonly-requested data.
937 */
938CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU);
939
940/**
941 * Describes the kind of error that occurred (if any) in a call to
942 * \c clang_saveTranslationUnit().
943 */
944enum CXSaveError {
945 /**
946 * Indicates that no error occurred while saving a translation unit.
947 */
948 CXSaveError_None = 0,
949
950 /**
951 * Indicates that an unknown error occurred while attempting to save
952 * the file.
953 *
954 * This error typically indicates that file I/O failed when attempting to
955 * write the file.
956 */
957 CXSaveError_Unknown = 1,
958
959 /**
960 * Indicates that errors during translation prevented this attempt
961 * to save the translation unit.
962 *
963 * Errors that prevent the translation unit from being saved can be
964 * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic().
965 */
966 CXSaveError_TranslationErrors = 2,
967
968 /**
969 * Indicates that the translation unit to be saved was somehow
970 * invalid (e.g., NULL).
971 */
972 CXSaveError_InvalidTU = 3
973};
974
975/**
976 * Saves a translation unit into a serialized representation of
977 * that translation unit on disk.
978 *
979 * Any translation unit that was parsed without error can be saved
980 * into a file. The translation unit can then be deserialized into a
981 * new \c CXTranslationUnit with \c clang_createTranslationUnit() or,
982 * if it is an incomplete translation unit that corresponds to a
983 * header, used as a precompiled header when parsing other translation
984 * units.
985 *
986 * \param TU The translation unit to save.
987 *
988 * \param FileName The file to which the translation unit will be saved.
989 *
990 * \param options A bitmask of options that affects how the translation unit
991 * is saved. This should be a bitwise OR of the
992 * CXSaveTranslationUnit_XXX flags.
993 *
994 * \returns A value that will match one of the enumerators of the CXSaveError
995 * enumeration. Zero (CXSaveError_None) indicates that the translation unit was
996 * saved successfully, while a non-zero value indicates that a problem occurred.
997 */
998CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU,
999 const char *FileName,
1000 unsigned options);
1001
1002/**
1003 * Suspend a translation unit in order to free memory associated with it.
1004 *
1005 * A suspended translation unit uses significantly less memory but on the other
1006 * side does not support any other calls than \c clang_reparseTranslationUnit
1007 * to resume it or \c clang_disposeTranslationUnit to dispose it completely.
1008 */
1009CINDEX_LINKAGE unsigned clang_suspendTranslationUnit(CXTranslationUnit);
1010
1011/**
1012 * Destroy the specified CXTranslationUnit object.
1013 */
1014CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit);
1015
1016/**
1017 * Flags that control the reparsing of translation units.
1018 *
1019 * The enumerators in this enumeration type are meant to be bitwise
1020 * ORed together to specify which options should be used when
1021 * reparsing the translation unit.
1022 */
1023enum CXReparse_Flags {
1024 /**
1025 * Used to indicate that no special reparsing options are needed.
1026 */
1027 CXReparse_None = 0x0
1028};
1029
1030/**
1031 * Returns the set of flags that is suitable for reparsing a translation
1032 * unit.
1033 *
1034 * The set of flags returned provide options for
1035 * \c clang_reparseTranslationUnit() by default. The returned flag
1036 * set contains an unspecified set of optimizations geared toward common uses
1037 * of reparsing. The set of optimizations enabled may change from one version
1038 * to the next.
1039 */
1040CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU);
1041
1042/**
1043 * Reparse the source files that produced this translation unit.
1044 *
1045 * This routine can be used to re-parse the source files that originally
1046 * created the given translation unit, for example because those source files
1047 * have changed (either on disk or as passed via \p unsaved_files). The
1048 * source code will be reparsed with the same command-line options as it
1049 * was originally parsed.
1050 *
1051 * Reparsing a translation unit invalidates all cursors and source locations
1052 * that refer into that translation unit. This makes reparsing a translation
1053 * unit semantically equivalent to destroying the translation unit and then
1054 * creating a new translation unit with the same command-line arguments.
1055 * However, it may be more efficient to reparse a translation
1056 * unit using this routine.
1057 *
1058 * \param TU The translation unit whose contents will be re-parsed. The
1059 * translation unit must originally have been built with
1060 * \c clang_createTranslationUnitFromSourceFile().
1061 *
1062 * \param num_unsaved_files The number of unsaved file entries in \p
1063 * unsaved_files.
1064 *
1065 * \param unsaved_files The files that have not yet been saved to disk
1066 * but may be required for parsing, including the contents of
1067 * those files. The contents and name of these files (as specified by
1068 * CXUnsavedFile) are copied when necessary, so the client only needs to
1069 * guarantee their validity until the call to this function returns.
1070 *
1071 * \param options A bitset of options composed of the flags in CXReparse_Flags.
1072 * The function \c clang_defaultReparseOptions() produces a default set of
1073 * options recommended for most uses, based on the translation unit.
1074 *
1075 * \returns 0 if the sources could be reparsed. A non-zero error code will be
1076 * returned if reparsing was impossible, such that the translation unit is
1077 * invalid. In such cases, the only valid call for \c TU is
1078 * \c clang_disposeTranslationUnit(TU). The error codes returned by this
1079 * routine are described by the \c CXErrorCode enum.
1080 */
1081CINDEX_LINKAGE int
1082clang_reparseTranslationUnit(CXTranslationUnit TU, unsigned num_unsaved_files,
1083 struct CXUnsavedFile *unsaved_files,
1084 unsigned options);
1085
1086/**
1087 * Categorizes how memory is being used by a translation unit.
1088 */
1089enum CXTUResourceUsageKind {
1090 CXTUResourceUsage_AST = 1,
1091 CXTUResourceUsage_Identifiers = 2,
1092 CXTUResourceUsage_Selectors = 3,
1093 CXTUResourceUsage_GlobalCompletionResults = 4,
1094 CXTUResourceUsage_SourceManagerContentCache = 5,
1095 CXTUResourceUsage_AST_SideTables = 6,
1096 CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7,
1097 CXTUResourceUsage_SourceManager_Membuffer_MMap = 8,
1098 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9,
1099 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10,
1100 CXTUResourceUsage_Preprocessor = 11,
1101 CXTUResourceUsage_PreprocessingRecord = 12,
1102 CXTUResourceUsage_SourceManager_DataStructures = 13,
1103 CXTUResourceUsage_Preprocessor_HeaderSearch = 14,
1104 CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST,
1105 CXTUResourceUsage_MEMORY_IN_BYTES_END =
1106 CXTUResourceUsage_Preprocessor_HeaderSearch,
1107
1108 CXTUResourceUsage_First = CXTUResourceUsage_AST,
1109 CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch
1110};
1111
1112/**
1113 * Returns the human-readable null-terminated C string that represents
1114 * the name of the memory category. This string should never be freed.
1115 */
1116CINDEX_LINKAGE
1117const char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind);
1118
1119typedef struct CXTUResourceUsageEntry {
1120 /* The memory usage category. */
1121 enum CXTUResourceUsageKind kind;
1122 /* Amount of resources used.
1123 The units will depend on the resource kind. */
1124 unsigned long amount;
1125} CXTUResourceUsageEntry;
1126
1127/**
1128 * The memory usage of a CXTranslationUnit, broken into categories.
1129 */
1130typedef struct CXTUResourceUsage {
1131 /* Private data member, used for queries. */
1132 void *data;
1133
1134 /* The number of entries in the 'entries' array. */
1135 unsigned numEntries;
1136
1137 /* An array of key-value pairs, representing the breakdown of memory
1138 usage. */
1139 CXTUResourceUsageEntry *entries;
1140
1141} CXTUResourceUsage;
1142
1143/**
1144 * Return the memory usage of a translation unit. This object
1145 * should be released with clang_disposeCXTUResourceUsage().
1146 */
1147CINDEX_LINKAGE CXTUResourceUsage
1148clang_getCXTUResourceUsage(CXTranslationUnit TU);
1149
1150CINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage);
1151
1152/**
1153 * Get target information for this translation unit.
1154 *
1155 * The CXTargetInfo object cannot outlive the CXTranslationUnit object.
1156 */
1157CINDEX_LINKAGE CXTargetInfo
1158clang_getTranslationUnitTargetInfo(CXTranslationUnit CTUnit);
1159
1160/**
1161 * Destroy the CXTargetInfo object.
1162 */
1163CINDEX_LINKAGE void clang_TargetInfo_dispose(CXTargetInfo Info);
1164
1165/**
1166 * Get the normalized target triple as a string.
1167 *
1168 * Returns the empty string in case of any error.
1169 */
1170CINDEX_LINKAGE CXString clang_TargetInfo_getTriple(CXTargetInfo Info);
1171
1172/**
1173 * Get the pointer width of the target in bits.
1174 *
1175 * Returns -1 in case of error.
1176 */
1177CINDEX_LINKAGE int clang_TargetInfo_getPointerWidth(CXTargetInfo Info);
1178
1179/**
1180 * @}
1181 */
1182
1183/**
1184 * Describes the kind of entity that a cursor refers to.
1185 */
1186enum CXCursorKind {
1187 /* Declarations */
1188 /**
1189 * A declaration whose specific kind is not exposed via this
1190 * interface.
1191 *
1192 * Unexposed declarations have the same operations as any other kind
1193 * of declaration; one can extract their location information,
1194 * spelling, find their definitions, etc. However, the specific kind
1195 * of the declaration is not reported.
1196 */
1197 CXCursor_UnexposedDecl = 1,
1198 /** A C or C++ struct. */
1199 CXCursor_StructDecl = 2,
1200 /** A C or C++ union. */
1201 CXCursor_UnionDecl = 3,
1202 /** A C++ class. */
1203 CXCursor_ClassDecl = 4,
1204 /** An enumeration. */
1205 CXCursor_EnumDecl = 5,
1206 /**
1207 * A field (in C) or non-static data member (in C++) in a
1208 * struct, union, or C++ class.
1209 */
1210 CXCursor_FieldDecl = 6,
1211 /** An enumerator constant. */
1212 CXCursor_EnumConstantDecl = 7,
1213 /** A function. */
1214 CXCursor_FunctionDecl = 8,
1215 /** A variable. */
1216 CXCursor_VarDecl = 9,
1217 /** A function or method parameter. */
1218 CXCursor_ParmDecl = 10,
1219 /** An Objective-C \@interface. */
1220 CXCursor_ObjCInterfaceDecl = 11,
1221 /** An Objective-C \@interface for a category. */
1222 CXCursor_ObjCCategoryDecl = 12,
1223 /** An Objective-C \@protocol declaration. */
1224 CXCursor_ObjCProtocolDecl = 13,
1225 /** An Objective-C \@property declaration. */
1226 CXCursor_ObjCPropertyDecl = 14,
1227 /** An Objective-C instance variable. */
1228 CXCursor_ObjCIvarDecl = 15,
1229 /** An Objective-C instance method. */
1230 CXCursor_ObjCInstanceMethodDecl = 16,
1231 /** An Objective-C class method. */
1232 CXCursor_ObjCClassMethodDecl = 17,
1233 /** An Objective-C \@implementation. */
1234 CXCursor_ObjCImplementationDecl = 18,
1235 /** An Objective-C \@implementation for a category. */
1236 CXCursor_ObjCCategoryImplDecl = 19,
1237 /** A typedef. */
1238 CXCursor_TypedefDecl = 20,
1239 /** A C++ class method. */
1240 CXCursor_CXXMethod = 21,
1241 /** A C++ namespace. */
1242 CXCursor_Namespace = 22,
1243 /** A linkage specification, e.g. 'extern "C"'. */
1244 CXCursor_LinkageSpec = 23,
1245 /** A C++ constructor. */
1246 CXCursor_Constructor = 24,
1247 /** A C++ destructor. */
1248 CXCursor_Destructor = 25,
1249 /** A C++ conversion function. */
1250 CXCursor_ConversionFunction = 26,
1251 /** A C++ template type parameter. */
1252 CXCursor_TemplateTypeParameter = 27,
1253 /** A C++ non-type template parameter. */
1254 CXCursor_NonTypeTemplateParameter = 28,
1255 /** A C++ template template parameter. */
1256 CXCursor_TemplateTemplateParameter = 29,
1257 /** A C++ function template. */
1258 CXCursor_FunctionTemplate = 30,
1259 /** A C++ class template. */
1260 CXCursor_ClassTemplate = 31,
1261 /** A C++ class template partial specialization. */
1262 CXCursor_ClassTemplatePartialSpecialization = 32,
1263 /** A C++ namespace alias declaration. */
1264 CXCursor_NamespaceAlias = 33,
1265 /** A C++ using directive. */
1266 CXCursor_UsingDirective = 34,
1267 /** A C++ using declaration. */
1268 CXCursor_UsingDeclaration = 35,
1269 /** A C++ alias declaration */
1270 CXCursor_TypeAliasDecl = 36,
1271 /** An Objective-C \@synthesize definition. */
1272 CXCursor_ObjCSynthesizeDecl = 37,
1273 /** An Objective-C \@dynamic definition. */
1274 CXCursor_ObjCDynamicDecl = 38,
1275 /** An access specifier. */
1276 CXCursor_CXXAccessSpecifier = 39,
1277
1278 CXCursor_FirstDecl = CXCursor_UnexposedDecl,
1279 CXCursor_LastDecl = CXCursor_CXXAccessSpecifier,
1280
1281 /* References */
1282 CXCursor_FirstRef = 40, /* Decl references */
1283 CXCursor_ObjCSuperClassRef = 40,
1284 CXCursor_ObjCProtocolRef = 41,
1285 CXCursor_ObjCClassRef = 42,
1286 /**
1287 * A reference to a type declaration.
1288 *
1289 * A type reference occurs anywhere where a type is named but not
1290 * declared. For example, given:
1291 *
1292 * \code
1293 * typedef unsigned size_type;
1294 * size_type size;
1295 * \endcode
1296 *
1297 * The typedef is a declaration of size_type (CXCursor_TypedefDecl),
1298 * while the type of the variable "size" is referenced. The cursor
1299 * referenced by the type of size is the typedef for size_type.
1300 */
1301 CXCursor_TypeRef = 43,
1302 CXCursor_CXXBaseSpecifier = 44,
1303 /**
1304 * A reference to a class template, function template, template
1305 * template parameter, or class template partial specialization.
1306 */
1307 CXCursor_TemplateRef = 45,
1308 /**
1309 * A reference to a namespace or namespace alias.
1310 */
1311 CXCursor_NamespaceRef = 46,
1312 /**
1313 * A reference to a member of a struct, union, or class that occurs in
1314 * some non-expression context, e.g., a designated initializer.
1315 */
1316 CXCursor_MemberRef = 47,
1317 /**
1318 * A reference to a labeled statement.
1319 *
1320 * This cursor kind is used to describe the jump to "start_over" in the
1321 * goto statement in the following example:
1322 *
1323 * \code
1324 * start_over:
1325 * ++counter;
1326 *
1327 * goto start_over;
1328 * \endcode
1329 *
1330 * A label reference cursor refers to a label statement.
1331 */
1332 CXCursor_LabelRef = 48,
1333
1334 /**
1335 * A reference to a set of overloaded functions or function templates
1336 * that has not yet been resolved to a specific function or function template.
1337 *
1338 * An overloaded declaration reference cursor occurs in C++ templates where
1339 * a dependent name refers to a function. For example:
1340 *
1341 * \code
1342 * template<typename T> void swap(T&, T&);
1343 *
1344 * struct X { ... };
1345 * void swap(X&, X&);
1346 *
1347 * template<typename T>
1348 * void reverse(T* first, T* last) {
1349 * while (first < last - 1) {
1350 * swap(*first, *--last);
1351 * ++first;
1352 * }
1353 * }
1354 *
1355 * struct Y { };
1356 * void swap(Y&, Y&);
1357 * \endcode
1358 *
1359 * Here, the identifier "swap" is associated with an overloaded declaration
1360 * reference. In the template definition, "swap" refers to either of the two
1361 * "swap" functions declared above, so both results will be available. At
1362 * instantiation time, "swap" may also refer to other functions found via
1363 * argument-dependent lookup (e.g., the "swap" function at the end of the
1364 * example).
1365 *
1366 * The functions \c clang_getNumOverloadedDecls() and
1367 * \c clang_getOverloadedDecl() can be used to retrieve the definitions
1368 * referenced by this cursor.
1369 */
1370 CXCursor_OverloadedDeclRef = 49,
1371
1372 /**
1373 * A reference to a variable that occurs in some non-expression
1374 * context, e.g., a C++ lambda capture list.
1375 */
1376 CXCursor_VariableRef = 50,
1377
1378 CXCursor_LastRef = CXCursor_VariableRef,
1379
1380 /* Error conditions */
1381 CXCursor_FirstInvalid = 70,
1382 CXCursor_InvalidFile = 70,
1383 CXCursor_NoDeclFound = 71,
1384 CXCursor_NotImplemented = 72,
1385 CXCursor_InvalidCode = 73,
1386 CXCursor_LastInvalid = CXCursor_InvalidCode,
1387
1388 /* Expressions */
1389 CXCursor_FirstExpr = 100,
1390
1391 /**
1392 * An expression whose specific kind is not exposed via this
1393 * interface.
1394 *
1395 * Unexposed expressions have the same operations as any other kind
1396 * of expression; one can extract their location information,
1397 * spelling, children, etc. However, the specific kind of the
1398 * expression is not reported.
1399 */
1400 CXCursor_UnexposedExpr = 100,
1401
1402 /**
1403 * An expression that refers to some value declaration, such
1404 * as a function, variable, or enumerator.
1405 */
1406 CXCursor_DeclRefExpr = 101,
1407
1408 /**
1409 * An expression that refers to a member of a struct, union,
1410 * class, Objective-C class, etc.
1411 */
1412 CXCursor_MemberRefExpr = 102,
1413
1414 /** An expression that calls a function. */
1415 CXCursor_CallExpr = 103,
1416
1417 /** An expression that sends a message to an Objective-C
1418 object or class. */
1419 CXCursor_ObjCMessageExpr = 104,
1420
1421 /** An expression that represents a block literal. */
1422 CXCursor_BlockExpr = 105,
1423
1424 /** An integer literal.
1425 */
1426 CXCursor_IntegerLiteral = 106,
1427
1428 /** A floating point number literal.
1429 */
1430 CXCursor_FloatingLiteral = 107,
1431
1432 /** An imaginary number literal.
1433 */
1434 CXCursor_ImaginaryLiteral = 108,
1435
1436 /** A string literal.
1437 */
1438 CXCursor_StringLiteral = 109,
1439
1440 /** A character literal.
1441 */
1442 CXCursor_CharacterLiteral = 110,
1443
1444 /** A parenthesized expression, e.g. "(1)".
1445 *
1446 * This AST node is only formed if full location information is requested.
1447 */
1448 CXCursor_ParenExpr = 111,
1449
1450 /** This represents the unary-expression's (except sizeof and
1451 * alignof).
1452 */
1453 CXCursor_UnaryOperator = 112,
1454
1455 /** [C99 6.5.2.1] Array Subscripting.
1456 */
1457 CXCursor_ArraySubscriptExpr = 113,
1458
1459 /** A builtin binary operation expression such as "x + y" or
1460 * "x <= y".
1461 */
1462 CXCursor_BinaryOperator = 114,
1463
1464 /** Compound assignment such as "+=".
1465 */
1466 CXCursor_CompoundAssignOperator = 115,
1467
1468 /** The ?: ternary operator.
1469 */
1470 CXCursor_ConditionalOperator = 116,
1471
1472 /** An explicit cast in C (C99 6.5.4) or a C-style cast in C++
1473 * (C++ [expr.cast]), which uses the syntax (Type)expr.
1474 *
1475 * For example: (int)f.
1476 */
1477 CXCursor_CStyleCastExpr = 117,
1478
1479 /** [C99 6.5.2.5]
1480 */
1481 CXCursor_CompoundLiteralExpr = 118,
1482
1483 /** Describes an C or C++ initializer list.
1484 */
1485 CXCursor_InitListExpr = 119,
1486
1487 /** The GNU address of label extension, representing &&label.
1488 */
1489 CXCursor_AddrLabelExpr = 120,
1490
1491 /** This is the GNU Statement Expression extension: ({int X=4; X;})
1492 */
1493 CXCursor_StmtExpr = 121,
1494
1495 /** Represents a C11 generic selection.
1496 */
1497 CXCursor_GenericSelectionExpr = 122,
1498
1499 /** Implements the GNU __null extension, which is a name for a null
1500 * pointer constant that has integral type (e.g., int or long) and is the same
1501 * size and alignment as a pointer.
1502 *
1503 * The __null extension is typically only used by system headers, which define
1504 * NULL as __null in C++ rather than using 0 (which is an integer that may not
1505 * match the size of a pointer).
1506 */
1507 CXCursor_GNUNullExpr = 123,
1508
1509 /** C++'s static_cast<> expression.
1510 */
1511 CXCursor_CXXStaticCastExpr = 124,
1512
1513 /** C++'s dynamic_cast<> expression.
1514 */
1515 CXCursor_CXXDynamicCastExpr = 125,
1516
1517 /** C++'s reinterpret_cast<> expression.
1518 */
1519 CXCursor_CXXReinterpretCastExpr = 126,
1520
1521 /** C++'s const_cast<> expression.
1522 */
1523 CXCursor_CXXConstCastExpr = 127,
1524
1525 /** Represents an explicit C++ type conversion that uses "functional"
1526 * notion (C++ [expr.type.conv]).
1527 *
1528 * Example:
1529 * \code
1530 * x = int(0.5);
1531 * \endcode
1532 */
1533 CXCursor_CXXFunctionalCastExpr = 128,
1534
1535 /** A C++ typeid expression (C++ [expr.typeid]).
1536 */
1537 CXCursor_CXXTypeidExpr = 129,
1538
1539 /** [C++ 2.13.5] C++ Boolean Literal.
1540 */
1541 CXCursor_CXXBoolLiteralExpr = 130,
1542
1543 /** [C++0x 2.14.7] C++ Pointer Literal.
1544 */
1545 CXCursor_CXXNullPtrLiteralExpr = 131,
1546
1547 /** Represents the "this" expression in C++
1548 */
1549 CXCursor_CXXThisExpr = 132,
1550
1551 /** [C++ 15] C++ Throw Expression.
1552 *
1553 * This handles 'throw' and 'throw' assignment-expression. When
1554 * assignment-expression isn't present, Op will be null.
1555 */
1556 CXCursor_CXXThrowExpr = 133,
1557
1558 /** A new expression for memory allocation and constructor calls, e.g:
1559 * "new CXXNewExpr(foo)".
1560 */
1561 CXCursor_CXXNewExpr = 134,
1562
1563 /** A delete expression for memory deallocation and destructor calls,
1564 * e.g. "delete[] pArray".
1565 */
1566 CXCursor_CXXDeleteExpr = 135,
1567
1568 /** A unary expression. (noexcept, sizeof, or other traits)
1569 */
1570 CXCursor_UnaryExpr = 136,
1571
1572 /** An Objective-C string literal i.e. @"foo".
1573 */
1574 CXCursor_ObjCStringLiteral = 137,
1575
1576 /** An Objective-C \@encode expression.
1577 */
1578 CXCursor_ObjCEncodeExpr = 138,
1579
1580 /** An Objective-C \@selector expression.
1581 */
1582 CXCursor_ObjCSelectorExpr = 139,
1583
1584 /** An Objective-C \@protocol expression.
1585 */
1586 CXCursor_ObjCProtocolExpr = 140,
1587
1588 /** An Objective-C "bridged" cast expression, which casts between
1589 * Objective-C pointers and C pointers, transferring ownership in the process.
1590 *
1591 * \code
1592 * NSString *str = (__bridge_transfer NSString *)CFCreateString();
1593 * \endcode
1594 */
1595 CXCursor_ObjCBridgedCastExpr = 141,
1596
1597 /** Represents a C++0x pack expansion that produces a sequence of
1598 * expressions.
1599 *
1600 * A pack expansion expression contains a pattern (which itself is an
1601 * expression) followed by an ellipsis. For example:
1602 *
1603 * \code
1604 * template<typename F, typename ...Types>
1605 * void forward(F f, Types &&...args) {
1606 * f(static_cast<Types&&>(args)...);
1607 * }
1608 * \endcode
1609 */
1610 CXCursor_PackExpansionExpr = 142,
1611
1612 /** Represents an expression that computes the length of a parameter
1613 * pack.
1614 *
1615 * \code
1616 * template<typename ...Types>
1617 * struct count {
1618 * static const unsigned value = sizeof...(Types);
1619 * };
1620 * \endcode
1621 */
1622 CXCursor_SizeOfPackExpr = 143,
1623
1624 /* Represents a C++ lambda expression that produces a local function
1625 * object.
1626 *
1627 * \code
1628 * void abssort(float *x, unsigned N) {
1629 * std::sort(x, x + N,
1630 * [](float a, float b) {
1631 * return std::abs(a) < std::abs(b);
1632 * });
1633 * }
1634 * \endcode
1635 */
1636 CXCursor_LambdaExpr = 144,
1637
1638 /** Objective-c Boolean Literal.
1639 */
1640 CXCursor_ObjCBoolLiteralExpr = 145,
1641
1642 /** Represents the "self" expression in an Objective-C method.
1643 */
1644 CXCursor_ObjCSelfExpr = 146,
1645
1646 /** OpenMP 5.0 [2.1.5, Array Section].
1647 * OpenACC 3.3 [2.7.1, Data Specification for Data Clauses (Sub Arrays)]
1648 */
1649 CXCursor_ArraySectionExpr = 147,
1650
1651 /** Represents an @available(...) check.
1652 */
1653 CXCursor_ObjCAvailabilityCheckExpr = 148,
1654
1655 /**
1656 * Fixed point literal
1657 */
1658 CXCursor_FixedPointLiteral = 149,
1659
1660 /** OpenMP 5.0 [2.1.4, Array Shaping].
1661 */
1662 CXCursor_OMPArrayShapingExpr = 150,
1663
1664 /**
1665 * OpenMP 5.0 [2.1.6 Iterators]
1666 */
1667 CXCursor_OMPIteratorExpr = 151,
1668
1669 /** OpenCL's addrspace_cast<> expression.
1670 */
1671 CXCursor_CXXAddrspaceCastExpr = 152,
1672
1673 /**
1674 * Expression that references a C++20 concept.
1675 */
1676 CXCursor_ConceptSpecializationExpr = 153,
1677
1678 /**
1679 * Expression that references a C++20 requires expression.
1680 */
1681 CXCursor_RequiresExpr = 154,
1682
1683 /**
1684 * Expression that references a C++20 parenthesized list aggregate
1685 * initializer.
1686 */
1687 CXCursor_CXXParenListInitExpr = 155,
1688
1689 /**
1690 * Represents a C++26 pack indexing expression.
1691 */
1692 CXCursor_PackIndexingExpr = 156,
1693
1694 CXCursor_LastExpr = CXCursor_PackIndexingExpr,
1695
1696 /* Statements */
1697 CXCursor_FirstStmt = 200,
1698 /**
1699 * A statement whose specific kind is not exposed via this
1700 * interface.
1701 *
1702 * Unexposed statements have the same operations as any other kind of
1703 * statement; one can extract their location information, spelling,
1704 * children, etc. However, the specific kind of the statement is not
1705 * reported.
1706 */
1707 CXCursor_UnexposedStmt = 200,
1708
1709 /** A labelled statement in a function.
1710 *
1711 * This cursor kind is used to describe the "start_over:" label statement in
1712 * the following example:
1713 *
1714 * \code
1715 * start_over:
1716 * ++counter;
1717 * \endcode
1718 *
1719 */
1720 CXCursor_LabelStmt = 201,
1721
1722 /** A group of statements like { stmt stmt }.
1723 *
1724 * This cursor kind is used to describe compound statements, e.g. function
1725 * bodies.
1726 */
1727 CXCursor_CompoundStmt = 202,
1728
1729 /** A case statement.
1730 */
1731 CXCursor_CaseStmt = 203,
1732
1733 /** A default statement.
1734 */
1735 CXCursor_DefaultStmt = 204,
1736
1737 /** An if statement
1738 */
1739 CXCursor_IfStmt = 205,
1740
1741 /** A switch statement.
1742 */
1743 CXCursor_SwitchStmt = 206,
1744
1745 /** A while statement.
1746 */
1747 CXCursor_WhileStmt = 207,
1748
1749 /** A do statement.
1750 */
1751 CXCursor_DoStmt = 208,
1752
1753 /** A for statement.
1754 */
1755 CXCursor_ForStmt = 209,
1756
1757 /** A goto statement.
1758 */
1759 CXCursor_GotoStmt = 210,
1760
1761 /** An indirect goto statement.
1762 */
1763 CXCursor_IndirectGotoStmt = 211,
1764
1765 /** A continue statement.
1766 */
1767 CXCursor_ContinueStmt = 212,
1768
1769 /** A break statement.
1770 */
1771 CXCursor_BreakStmt = 213,
1772
1773 /** A return statement.
1774 */
1775 CXCursor_ReturnStmt = 214,
1776
1777 /** A GCC inline assembly statement extension.
1778 */
1779 CXCursor_GCCAsmStmt = 215,
1780 CXCursor_AsmStmt = CXCursor_GCCAsmStmt,
1781
1782 /** Objective-C's overall \@try-\@catch-\@finally statement.
1783 */
1784 CXCursor_ObjCAtTryStmt = 216,
1785
1786 /** Objective-C's \@catch statement.
1787 */
1788 CXCursor_ObjCAtCatchStmt = 217,
1789
1790 /** Objective-C's \@finally statement.
1791 */
1792 CXCursor_ObjCAtFinallyStmt = 218,
1793
1794 /** Objective-C's \@throw statement.
1795 */
1796 CXCursor_ObjCAtThrowStmt = 219,
1797
1798 /** Objective-C's \@synchronized statement.
1799 */
1800 CXCursor_ObjCAtSynchronizedStmt = 220,
1801
1802 /** Objective-C's autorelease pool statement.
1803 */
1804 CXCursor_ObjCAutoreleasePoolStmt = 221,
1805
1806 /** Objective-C's collection statement.
1807 */
1808 CXCursor_ObjCForCollectionStmt = 222,
1809
1810 /** C++'s catch statement.
1811 */
1812 CXCursor_CXXCatchStmt = 223,
1813
1814 /** C++'s try statement.
1815 */
1816 CXCursor_CXXTryStmt = 224,
1817
1818 /** C++'s for (* : *) statement.
1819 */
1820 CXCursor_CXXForRangeStmt = 225,
1821
1822 /** Windows Structured Exception Handling's try statement.
1823 */
1824 CXCursor_SEHTryStmt = 226,
1825
1826 /** Windows Structured Exception Handling's except statement.
1827 */
1828 CXCursor_SEHExceptStmt = 227,
1829
1830 /** Windows Structured Exception Handling's finally statement.
1831 */
1832 CXCursor_SEHFinallyStmt = 228,
1833
1834 /** A MS inline assembly statement extension.
1835 */
1836 CXCursor_MSAsmStmt = 229,
1837
1838 /** The null statement ";": C99 6.8.3p3.
1839 *
1840 * This cursor kind is used to describe the null statement.
1841 */
1842 CXCursor_NullStmt = 230,
1843
1844 /** Adaptor class for mixing declarations with statements and
1845 * expressions.
1846 */
1847 CXCursor_DeclStmt = 231,
1848
1849 /** OpenMP parallel directive.
1850 */
1851 CXCursor_OMPParallelDirective = 232,
1852
1853 /** OpenMP SIMD directive.
1854 */
1855 CXCursor_OMPSimdDirective = 233,
1856
1857 /** OpenMP for directive.
1858 */
1859 CXCursor_OMPForDirective = 234,
1860
1861 /** OpenMP sections directive.
1862 */
1863 CXCursor_OMPSectionsDirective = 235,
1864
1865 /** OpenMP section directive.
1866 */
1867 CXCursor_OMPSectionDirective = 236,
1868
1869 /** OpenMP single directive.
1870 */
1871 CXCursor_OMPSingleDirective = 237,
1872
1873 /** OpenMP parallel for directive.
1874 */
1875 CXCursor_OMPParallelForDirective = 238,
1876
1877 /** OpenMP parallel sections directive.
1878 */
1879 CXCursor_OMPParallelSectionsDirective = 239,
1880
1881 /** OpenMP task directive.
1882 */
1883 CXCursor_OMPTaskDirective = 240,
1884
1885 /** OpenMP master directive.
1886 */
1887 CXCursor_OMPMasterDirective = 241,
1888
1889 /** OpenMP critical directive.
1890 */
1891 CXCursor_OMPCriticalDirective = 242,
1892
1893 /** OpenMP taskyield directive.
1894 */
1895 CXCursor_OMPTaskyieldDirective = 243,
1896
1897 /** OpenMP barrier directive.
1898 */
1899 CXCursor_OMPBarrierDirective = 244,
1900
1901 /** OpenMP taskwait directive.
1902 */
1903 CXCursor_OMPTaskwaitDirective = 245,
1904
1905 /** OpenMP flush directive.
1906 */
1907 CXCursor_OMPFlushDirective = 246,
1908
1909 /** Windows Structured Exception Handling's leave statement.
1910 */
1911 CXCursor_SEHLeaveStmt = 247,
1912
1913 /** OpenMP ordered-standalone directive.
1914 */
1915 CXCursor_OMPOrderedStandaloneDirective = 248,
1916
1917 /** OpenMP atomic directive.
1918 */
1919 CXCursor_OMPAtomicDirective = 249,
1920
1921 /** OpenMP for SIMD directive.
1922 */
1923 CXCursor_OMPForSimdDirective = 250,
1924
1925 /** OpenMP parallel for SIMD directive.
1926 */
1927 CXCursor_OMPParallelForSimdDirective = 251,
1928
1929 /** OpenMP target directive.
1930 */
1931 CXCursor_OMPTargetDirective = 252,
1932
1933 /** OpenMP teams directive.
1934 */
1935 CXCursor_OMPTeamsDirective = 253,
1936
1937 /** OpenMP taskgroup directive.
1938 */
1939 CXCursor_OMPTaskgroupDirective = 254,
1940
1941 /** OpenMP cancellation point directive.
1942 */
1943 CXCursor_OMPCancellationPointDirective = 255,
1944
1945 /** OpenMP cancel directive.
1946 */
1947 CXCursor_OMPCancelDirective = 256,
1948
1949 /** OpenMP target data directive.
1950 */
1951 CXCursor_OMPTargetDataDirective = 257,
1952
1953 /** OpenMP taskloop directive.
1954 */
1955 CXCursor_OMPTaskLoopDirective = 258,
1956
1957 /** OpenMP taskloop simd directive.
1958 */
1959 CXCursor_OMPTaskLoopSimdDirective = 259,
1960
1961 /** OpenMP distribute directive.
1962 */
1963 CXCursor_OMPDistributeDirective = 260,
1964
1965 /** OpenMP target enter data directive.
1966 */
1967 CXCursor_OMPTargetEnterDataDirective = 261,
1968
1969 /** OpenMP target exit data directive.
1970 */
1971 CXCursor_OMPTargetExitDataDirective = 262,
1972
1973 /** OpenMP target parallel directive.
1974 */
1975 CXCursor_OMPTargetParallelDirective = 263,
1976
1977 /** OpenMP target parallel for directive.
1978 */
1979 CXCursor_OMPTargetParallelForDirective = 264,
1980
1981 /** OpenMP target update directive.
1982 */
1983 CXCursor_OMPTargetUpdateDirective = 265,
1984
1985 /** OpenMP distribute parallel for directive.
1986 */
1987 CXCursor_OMPDistributeParallelForDirective = 266,
1988
1989 /** OpenMP distribute parallel for simd directive.
1990 */
1991 CXCursor_OMPDistributeParallelForSimdDirective = 267,
1992
1993 /** OpenMP distribute simd directive.
1994 */
1995 CXCursor_OMPDistributeSimdDirective = 268,
1996
1997 /** OpenMP target parallel for simd directive.
1998 */
1999 CXCursor_OMPTargetParallelForSimdDirective = 269,
2000
2001 /** OpenMP target simd directive.
2002 */
2003 CXCursor_OMPTargetSimdDirective = 270,
2004
2005 /** OpenMP teams distribute directive.
2006 */
2007 CXCursor_OMPTeamsDistributeDirective = 271,
2008
2009 /** OpenMP teams distribute simd directive.
2010 */
2011 CXCursor_OMPTeamsDistributeSimdDirective = 272,
2012
2013 /** OpenMP teams distribute parallel for simd directive.
2014 */
2015 CXCursor_OMPTeamsDistributeParallelForSimdDirective = 273,
2016
2017 /** OpenMP teams distribute parallel for directive.
2018 */
2019 CXCursor_OMPTeamsDistributeParallelForDirective = 274,
2020
2021 /** OpenMP target teams directive.
2022 */
2023 CXCursor_OMPTargetTeamsDirective = 275,
2024
2025 /** OpenMP target teams distribute directive.
2026 */
2027 CXCursor_OMPTargetTeamsDistributeDirective = 276,
2028
2029 /** OpenMP target teams distribute parallel for directive.
2030 */
2031 CXCursor_OMPTargetTeamsDistributeParallelForDirective = 277,
2032
2033 /** OpenMP target teams distribute parallel for simd directive.
2034 */
2035 CXCursor_OMPTargetTeamsDistributeParallelForSimdDirective = 278,
2036
2037 /** OpenMP target teams distribute simd directive.
2038 */
2039 CXCursor_OMPTargetTeamsDistributeSimdDirective = 279,
2040
2041 /** C++2a std::bit_cast expression.
2042 */
2043 CXCursor_BuiltinBitCastExpr = 280,
2044
2045 /** OpenMP master taskloop directive.
2046 */
2047 CXCursor_OMPMasterTaskLoopDirective = 281,
2048
2049 /** OpenMP parallel master taskloop directive.
2050 */
2051 CXCursor_OMPParallelMasterTaskLoopDirective = 282,
2052
2053 /** OpenMP master taskloop simd directive.
2054 */
2055 CXCursor_OMPMasterTaskLoopSimdDirective = 283,
2056
2057 /** OpenMP parallel master taskloop simd directive.
2058 */
2059 CXCursor_OMPParallelMasterTaskLoopSimdDirective = 284,
2060
2061 /** OpenMP parallel master directive.
2062 */
2063 CXCursor_OMPParallelMasterDirective = 285,
2064
2065 /** OpenMP depobj directive.
2066 */
2067 CXCursor_OMPDepobjDirective = 286,
2068
2069 /** OpenMP scan directive.
2070 */
2071 CXCursor_OMPScanDirective = 287,
2072
2073 /** OpenMP tile directive.
2074 */
2075 CXCursor_OMPTileDirective = 288,
2076
2077 /** OpenMP canonical loop.
2078 */
2079 CXCursor_OMPCanonicalLoop = 289,
2080
2081 /** OpenMP interop directive.
2082 */
2083 CXCursor_OMPInteropDirective = 290,
2084
2085 /** OpenMP dispatch directive.
2086 */
2087 CXCursor_OMPDispatchDirective = 291,
2088
2089 /** OpenMP masked directive.
2090 */
2091 CXCursor_OMPMaskedDirective = 292,
2092
2093 /** OpenMP unroll directive.
2094 */
2095 CXCursor_OMPUnrollDirective = 293,
2096
2097 /** OpenMP metadirective directive.
2098 */
2099 CXCursor_OMPMetaDirective = 294,
2100
2101 /** OpenMP loop directive.
2102 */
2103 CXCursor_OMPGenericLoopDirective = 295,
2104
2105 /** OpenMP teams loop directive.
2106 */
2107 CXCursor_OMPTeamsGenericLoopDirective = 296,
2108
2109 /** OpenMP target teams loop directive.
2110 */
2111 CXCursor_OMPTargetTeamsGenericLoopDirective = 297,
2112
2113 /** OpenMP parallel loop directive.
2114 */
2115 CXCursor_OMPParallelGenericLoopDirective = 298,
2116
2117 /** OpenMP target parallel loop directive.
2118 */
2119 CXCursor_OMPTargetParallelGenericLoopDirective = 299,
2120
2121 /** OpenMP parallel masked directive.
2122 */
2123 CXCursor_OMPParallelMaskedDirective = 300,
2124
2125 /** OpenMP masked taskloop directive.
2126 */
2127 CXCursor_OMPMaskedTaskLoopDirective = 301,
2128
2129 /** OpenMP masked taskloop simd directive.
2130 */
2131 CXCursor_OMPMaskedTaskLoopSimdDirective = 302,
2132
2133 /** OpenMP parallel masked taskloop directive.
2134 */
2135 CXCursor_OMPParallelMaskedTaskLoopDirective = 303,
2136
2137 /** OpenMP parallel masked taskloop simd directive.
2138 */
2139 CXCursor_OMPParallelMaskedTaskLoopSimdDirective = 304,
2140
2141 /** OpenMP error directive.
2142 */
2143 CXCursor_OMPErrorDirective = 305,
2144
2145 /** OpenMP scope directive.
2146 */
2147 CXCursor_OMPScopeDirective = 306,
2148
2149 /** OpenMP reverse directive.
2150 */
2151 CXCursor_OMPReverseDirective = 307,
2152
2153 /** OpenMP interchange directive.
2154 */
2155 CXCursor_OMPInterchangeDirective = 308,
2156
2157 /** OpenMP assume directive.
2158 */
2159 CXCursor_OMPAssumeDirective = 309,
2160
2161 /** OpenMP assume directive.
2162 */
2163 CXCursor_OMPStripeDirective = 310,
2164
2165 /** OpenMP fuse directive
2166 */
2167 CXCursor_OMPFuseDirective = 311,
2168
2169 /** OpenMP split directive.
2170 */
2171 CXCursor_OMPSplitDirective = 312,
2172
2173 /** OpenMP ordered-blockassoc directive.
2174 */
2175 CXCursor_OMPOrderedBlockAssocDirective = 313,
2176
2177 /** OpenMP flatten directive.
2178 */
2179 CXCursor_OMPFlattenDirective = 314,
2180
2181 /** OpenMP target loop directive.
2182 */
2183 CXCursor_OMPTargetGenericLoopDirective = 315,
2184
2185 /** OpenACC Compute Construct.
2186 */
2187 CXCursor_OpenACCComputeConstruct = 320,
2188
2189 /** OpenACC Loop Construct.
2190 */
2191 CXCursor_OpenACCLoopConstruct = 321,
2192
2193 /** OpenACC Combined Constructs.
2194 */
2195 CXCursor_OpenACCCombinedConstruct = 322,
2196
2197 /** OpenACC data Construct.
2198 */
2199 CXCursor_OpenACCDataConstruct = 323,
2200
2201 /** OpenACC enter data Construct.
2202 */
2203 CXCursor_OpenACCEnterDataConstruct = 324,
2204
2205 /** OpenACC exit data Construct.
2206 */
2207 CXCursor_OpenACCExitDataConstruct = 325,
2208
2209 /** OpenACC host_data Construct.
2210 */
2211 CXCursor_OpenACCHostDataConstruct = 326,
2212
2213 /** OpenACC wait Construct.
2214 */
2215 CXCursor_OpenACCWaitConstruct = 327,
2216
2217 /** OpenACC init Construct.
2218 */
2219 CXCursor_OpenACCInitConstruct = 328,
2220
2221 /** OpenACC shutdown Construct.
2222 */
2223 CXCursor_OpenACCShutdownConstruct = 329,
2224
2225 /** OpenACC set Construct.
2226 */
2227 CXCursor_OpenACCSetConstruct = 330,
2228
2229 /** OpenACC update Construct.
2230 */
2231 CXCursor_OpenACCUpdateConstruct = 331,
2232
2233 /** OpenACC atomic Construct.
2234 */
2235 CXCursor_OpenACCAtomicConstruct = 332,
2236
2237 /** OpenACC cache Construct.
2238 */
2239 CXCursor_OpenACCCacheConstruct = 333,
2240
2241 CXCursor_LastStmt = CXCursor_OpenACCCacheConstruct,
2242
2243 /**
2244 * Cursor that represents the translation unit itself.
2245 *
2246 * The translation unit cursor exists primarily to act as the root
2247 * cursor for traversing the contents of a translation unit.
2248 */
2249 CXCursor_TranslationUnit = 350,
2250
2251 /* Attributes */
2252 CXCursor_FirstAttr = 400,
2253 /**
2254 * An attribute whose specific kind is not exposed via this
2255 * interface.
2256 */
2257 CXCursor_UnexposedAttr = 400,
2258
2259 CXCursor_IBActionAttr = 401,
2260 CXCursor_IBOutletAttr = 402,
2261 CXCursor_IBOutletCollectionAttr = 403,
2262 CXCursor_CXXFinalAttr = 404,
2263 CXCursor_CXXOverrideAttr = 405,
2264 CXCursor_AnnotateAttr = 406,
2265 CXCursor_AsmLabelAttr = 407,
2266 CXCursor_PackedAttr = 408,
2267 CXCursor_PureAttr = 409,
2268 CXCursor_ConstAttr = 410,
2269 CXCursor_NoDuplicateAttr = 411,
2270 CXCursor_CUDAConstantAttr = 412,
2271 CXCursor_CUDADeviceAttr = 413,
2272 CXCursor_CUDAGlobalAttr = 414,
2273 CXCursor_CUDAHostAttr = 415,
2274 CXCursor_CUDASharedAttr = 416,
2275 CXCursor_VisibilityAttr = 417,
2276 CXCursor_DLLExport = 418,
2277 CXCursor_DLLImport = 419,
2278 CXCursor_NSReturnsRetained = 420,
2279 CXCursor_NSReturnsNotRetained = 421,
2280 CXCursor_NSReturnsAutoreleased = 422,
2281 CXCursor_NSConsumesSelf = 423,
2282 CXCursor_NSConsumed = 424,
2283 CXCursor_ObjCException = 425,
2284 CXCursor_ObjCNSObject = 426,
2285 CXCursor_ObjCIndependentClass = 427,
2286 CXCursor_ObjCPreciseLifetime = 428,
2287 CXCursor_ObjCReturnsInnerPointer = 429,
2288 CXCursor_ObjCRequiresSuper = 430,
2289 CXCursor_ObjCRootClass = 431,
2290 CXCursor_ObjCSubclassingRestricted = 432,
2291 CXCursor_ObjCExplicitProtocolImpl = 433,
2292 CXCursor_ObjCDesignatedInitializer = 434,
2293 CXCursor_ObjCRuntimeVisible = 435,
2294 CXCursor_ObjCBoxable = 436,
2295 CXCursor_FlagEnum = 437,
2296 CXCursor_ConvergentAttr = 438,
2297 CXCursor_WarnUnusedAttr = 439,
2298 CXCursor_WarnUnusedResultAttr = 440,
2299 CXCursor_AlignedAttr = 441,
2300 CXCursor_LastAttr = CXCursor_AlignedAttr,
2301
2302 /* Preprocessing */
2303 CXCursor_PreprocessingDirective = 500,
2304 CXCursor_MacroDefinition = 501,
2305 CXCursor_MacroExpansion = 502,
2306 CXCursor_MacroInstantiation = CXCursor_MacroExpansion,
2307 CXCursor_InclusionDirective = 503,
2308 CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective,
2309 CXCursor_LastPreprocessing = CXCursor_InclusionDirective,
2310
2311 /* Extra Declarations */
2312 /**
2313 * A module import declaration.
2314 */
2315 CXCursor_ModuleImportDecl = 600,
2316 CXCursor_TypeAliasTemplateDecl = 601,
2317 /**
2318 * A static_assert or _Static_assert node
2319 */
2320 CXCursor_StaticAssert = 602,
2321 /**
2322 * a friend declaration.
2323 */
2324 CXCursor_FriendDecl = 603,
2325 /**
2326 * a concept declaration.
2327 */
2328 CXCursor_ConceptDecl = 604,
2329
2330 CXCursor_FirstExtraDecl = CXCursor_ModuleImportDecl,
2331 CXCursor_LastExtraDecl = CXCursor_ConceptDecl,
2332
2333 /**
2334 * A code completion overload candidate.
2335 */
2336 CXCursor_OverloadCandidate = 700
2337};
2338
2339/**
2340 * A cursor representing some element in the abstract syntax tree for
2341 * a translation unit.
2342 *
2343 * The cursor abstraction unifies the different kinds of entities in a
2344 * program--declaration, statements, expressions, references to declarations,
2345 * etc.--under a single "cursor" abstraction with a common set of operations.
2346 * Common operation for a cursor include: getting the physical location in
2347 * a source file where the cursor points, getting the name associated with a
2348 * cursor, and retrieving cursors for any child nodes of a particular cursor.
2349 *
2350 * Cursors can be produced in two specific ways.
2351 * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
2352 * from which one can use clang_visitChildren() to explore the rest of the
2353 * translation unit. clang_getCursor() maps from a physical source location
2354 * to the entity that resides at that location, allowing one to map from the
2355 * source code into the AST.
2356 */
2357typedef struct {
2358 enum CXCursorKind kind;
2359 int xdata;
2360 const void *data[3];
2361} CXCursor;
2362
2363/**
2364 * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
2365 *
2366 * @{
2367 */
2368
2369/**
2370 * Retrieve the NULL cursor, which represents no entity.
2371 */
2372CINDEX_LINKAGE CXCursor clang_getNullCursor(void);
2373
2374/**
2375 * Retrieve the cursor that represents the given translation unit.
2376 *
2377 * The translation unit cursor can be used to start traversing the
2378 * various declarations within the given translation unit.
2379 */
2380CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit);
2381
2382/**
2383 * Determine whether two cursors are equivalent.
2384 */
2385CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor);
2386
2387/**
2388 * Returns non-zero if \p cursor is null.
2389 */
2390CINDEX_LINKAGE int clang_Cursor_isNull(CXCursor cursor);
2391
2392/**
2393 * Compute a hash value for the given cursor.
2394 */
2395CINDEX_LINKAGE unsigned clang_hashCursor(CXCursor);
2396
2397/**
2398 * Retrieve the kind of the given cursor.
2399 */
2400CINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor);
2401
2402/**
2403 * Determine whether the given cursor kind represents a declaration.
2404 */
2405CINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind);
2406
2407/**
2408 * Determine whether the given declaration is invalid.
2409 *
2410 * A declaration is invalid if it could not be parsed successfully.
2411 *
2412 * \returns non-zero if the cursor represents a declaration and it is
2413 * invalid, otherwise zero.
2414 */
2415CINDEX_LINKAGE unsigned clang_isInvalidDeclaration(CXCursor);
2416
2417/**
2418 * Determine whether the given cursor kind represents a simple
2419 * reference.
2420 *
2421 * Note that other kinds of cursors (such as expressions) can also refer to
2422 * other cursors. Use clang_getCursorReferenced() to determine whether a
2423 * particular cursor refers to another entity.
2424 */
2425CINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind);
2426
2427/**
2428 * Determine whether the given cursor kind represents an expression.
2429 */
2430CINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind);
2431
2432/**
2433 * Determine whether the given cursor kind represents a statement.
2434 */
2435CINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind);
2436
2437/**
2438 * Determine whether the given cursor kind represents an attribute.
2439 */
2440CINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind);
2441
2442/**
2443 * Determine whether the given cursor has any attributes.
2444 */
2445CINDEX_LINKAGE unsigned clang_Cursor_hasAttrs(CXCursor C);
2446
2447/**
2448 * Determine whether the given cursor kind represents an invalid
2449 * cursor.
2450 */
2451CINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind);
2452
2453/**
2454 * Determine whether the given cursor kind represents a translation
2455 * unit.
2456 */
2457CINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind);
2458
2459/***
2460 * Determine whether the given cursor represents a preprocessing
2461 * element, such as a preprocessor directive or macro instantiation.
2462 */
2463CINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind);
2464
2465/***
2466 * Determine whether the given cursor represents a currently
2467 * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
2468 */
2469CINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind);
2470
2471/**
2472 * Describe the linkage of the entity referred to by a cursor.
2473 */
2474enum CXLinkageKind {
2475 /** This value indicates that no linkage information is available
2476 * for a provided CXCursor. */
2477 CXLinkage_Invalid,
2478 /**
2479 * This is the linkage for variables, parameters, and so on that
2480 * have automatic storage. This covers normal (non-extern) local variables.
2481 */
2482 CXLinkage_NoLinkage,
2483 /** This is the linkage for static variables and static functions. */
2484 CXLinkage_Internal,
2485 /** This is the linkage for entities with external linkage that live
2486 * in C++ anonymous namespaces.*/
2487 CXLinkage_UniqueExternal,
2488 /** This is the linkage for entities with true, external linkage. */
2489 CXLinkage_External
2490};
2491
2492/**
2493 * Determine the linkage of the entity referred to by a given cursor.
2494 */
2495CINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor);
2496
2497enum CXVisibilityKind {
2498 /** This value indicates that no visibility information is available
2499 * for a provided CXCursor. */
2500 CXVisibility_Invalid,
2501
2502 /** Symbol not seen by the linker. */
2503 CXVisibility_Hidden,
2504 /** Symbol seen by the linker but resolves to a symbol inside this object. */
2505 CXVisibility_Protected,
2506 /** Symbol seen by the linker and acts like a normal symbol. */
2507 CXVisibility_Default
2508};
2509
2510/**
2511 * Describe the visibility of the entity referred to by a cursor.
2512 *
2513 * This returns the default visibility if not explicitly specified by
2514 * a visibility attribute. The default visibility may be changed by
2515 * commandline arguments.
2516 *
2517 * \param cursor The cursor to query.
2518 *
2519 * \returns The visibility of the cursor.
2520 */
2521CINDEX_LINKAGE enum CXVisibilityKind clang_getCursorVisibility(CXCursor cursor);
2522
2523/**
2524 * Determine the availability of the entity that this cursor refers to,
2525 * taking the current target platform into account.
2526 *
2527 * \param cursor The cursor to query.
2528 *
2529 * \returns The availability of the cursor.
2530 */
2531CINDEX_LINKAGE enum CXAvailabilityKind
2532clang_getCursorAvailability(CXCursor cursor);
2533
2534/**
2535 * Describes the availability of a given entity on a particular platform, e.g.,
2536 * a particular class might only be available on Mac OS 10.7 or newer.
2537 */
2538typedef struct CXPlatformAvailability {
2539 /**
2540 * A string that describes the platform for which this structure
2541 * provides availability information.
2542 *
2543 * Possible values are "ios" or "macos".
2544 */
2545 CXString Platform;
2546 /**
2547 * The version number in which this entity was introduced.
2548 */
2549 CXVersion Introduced;
2550 /**
2551 * The version number in which this entity was deprecated (but is
2552 * still available).
2553 */
2554 CXVersion Deprecated;
2555 /**
2556 * The version number in which this entity was obsoleted, and therefore
2557 * is no longer available.
2558 */
2559 CXVersion Obsoleted;
2560 /**
2561 * Whether the entity is unconditionally unavailable on this platform.
2562 */
2563 int Unavailable;
2564 /**
2565 * An optional message to provide to a user of this API, e.g., to
2566 * suggest replacement APIs.
2567 */
2568 CXString Message;
2569} CXPlatformAvailability;
2570
2571/**
2572 * Determine the availability of the entity that this cursor refers to
2573 * on any platforms for which availability information is known.
2574 *
2575 * \param cursor The cursor to query.
2576 *
2577 * \param always_deprecated If non-NULL, will be set to indicate whether the
2578 * entity is deprecated on all platforms.
2579 *
2580 * \param deprecated_message If non-NULL, will be set to the message text
2581 * provided along with the unconditional deprecation of this entity. The client
2582 * is responsible for deallocating this string.
2583 *
2584 * \param always_unavailable If non-NULL, will be set to indicate whether the
2585 * entity is unavailable on all platforms.
2586 *
2587 * \param unavailable_message If non-NULL, will be set to the message text
2588 * provided along with the unconditional unavailability of this entity. The
2589 * client is responsible for deallocating this string.
2590 *
2591 * \param availability If non-NULL, an array of CXPlatformAvailability instances
2592 * that will be populated with platform availability information, up to either
2593 * the number of platforms for which availability information is available (as
2594 * returned by this function) or \c availability_size, whichever is smaller.
2595 *
2596 * \param availability_size The number of elements available in the
2597 * \c availability array.
2598 *
2599 * \returns The number of platforms (N) for which availability information is
2600 * available (which is unrelated to \c availability_size).
2601 *
2602 * Note that the client is responsible for calling
2603 * \c clang_disposeCXPlatformAvailability to free each of the
2604 * platform-availability structures returned. There are
2605 * \c min(N, availability_size) such structures.
2606 */
2607CINDEX_LINKAGE int clang_getCursorPlatformAvailability(
2608 CXCursor cursor, int *always_deprecated, CXString *deprecated_message,
2609 int *always_unavailable, CXString *unavailable_message,
2610 CXPlatformAvailability *availability, int availability_size);
2611
2612/**
2613 * Free the memory associated with a \c CXPlatformAvailability structure.
2614 */
2615CINDEX_LINKAGE void
2616clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability);
2617
2618/**
2619 * If cursor refers to a variable declaration and it has initializer returns
2620 * cursor referring to the initializer otherwise return null cursor.
2621 */
2622CINDEX_LINKAGE CXCursor clang_Cursor_getVarDeclInitializer(CXCursor cursor);
2623
2624/**
2625 * If cursor refers to a variable declaration that has global storage returns 1.
2626 * If cursor refers to a variable declaration that doesn't have global storage
2627 * returns 0. Otherwise returns -1.
2628 */
2629CINDEX_LINKAGE int clang_Cursor_hasVarDeclGlobalStorage(CXCursor cursor);
2630
2631/**
2632 * If cursor refers to a variable declaration that has external storage
2633 * returns 1. If cursor refers to a variable declaration that doesn't have
2634 * external storage returns 0. Otherwise returns -1.
2635 */
2636CINDEX_LINKAGE int clang_Cursor_hasVarDeclExternalStorage(CXCursor cursor);
2637
2638/**
2639 * Describe the "language" of the entity referred to by a cursor.
2640 */
2641enum CXLanguageKind {
2642 CXLanguage_Invalid = 0,
2643 CXLanguage_C,
2644 CXLanguage_ObjC,
2645 CXLanguage_CPlusPlus
2646};
2647
2648/**
2649 * Determine the "language" of the entity referred to by a given cursor.
2650 */
2651CINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor);
2652
2653/**
2654 * Describe the "thread-local storage (TLS) kind" of the declaration
2655 * referred to by a cursor.
2656 */
2657enum CXTLSKind { CXTLS_None = 0, CXTLS_Dynamic, CXTLS_Static };
2658
2659/**
2660 * Determine the "thread-local storage (TLS) kind" of the declaration
2661 * referred to by a cursor.
2662 */
2663CINDEX_LINKAGE enum CXTLSKind clang_getCursorTLSKind(CXCursor cursor);
2664
2665/**
2666 * Returns the translation unit that a cursor originated from.
2667 */
2668CINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor);
2669
2670/**
2671 * A fast container representing a set of CXCursors.
2672 */
2673typedef struct CXCursorSetImpl *CXCursorSet;
2674
2675/**
2676 * Creates an empty CXCursorSet.
2677 */
2678CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void);
2679
2680/**
2681 * Disposes a CXCursorSet and releases its associated memory.
2682 */
2683CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
2684
2685/**
2686 * Queries a CXCursorSet to see if it contains a specific CXCursor.
2687 *
2688 * \returns non-zero if the set contains the specified cursor.
2689 */
2690CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
2691 CXCursor cursor);
2692
2693/**
2694 * Inserts a CXCursor into a CXCursorSet.
2695 *
2696 * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
2697 */
2698CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
2699 CXCursor cursor);
2700
2701/**
2702 * Determine the semantic parent of the given cursor.
2703 *
2704 * The semantic parent of a cursor is the cursor that semantically contains
2705 * the given \p cursor. For many declarations, the lexical and semantic parents
2706 * are equivalent (the lexical parent is returned by
2707 * \c clang_getCursorLexicalParent()). They diverge when declarations or
2708 * definitions are provided out-of-line. For example:
2709 *
2710 * \code
2711 * class C {
2712 * void f();
2713 * };
2714 *
2715 * void C::f() { }
2716 * \endcode
2717 *
2718 * In the out-of-line definition of \c C::f, the semantic parent is
2719 * the class \c C, of which this function is a member. The lexical parent is
2720 * the place where the declaration actually occurs in the source code; in this
2721 * case, the definition occurs in the translation unit. In general, the
2722 * lexical parent for a given entity can change without affecting the semantics
2723 * of the program, and the lexical parent of different declarations of the
2724 * same entity may be different. Changing the semantic parent of a declaration,
2725 * on the other hand, can have a major impact on semantics, and redeclarations
2726 * of a particular entity should all have the same semantic context.
2727 *
2728 * In the example above, both declarations of \c C::f have \c C as their
2729 * semantic context, while the lexical context of the first \c C::f is \c C
2730 * and the lexical context of the second \c C::f is the translation unit.
2731 *
2732 * For global declarations, the semantic parent is the translation unit.
2733 */
2734CINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor);
2735
2736/**
2737 * Determine the lexical parent of the given cursor.
2738 *
2739 * The lexical parent of a cursor is the cursor in which the given \p cursor
2740 * was actually written. For many declarations, the lexical and semantic parents
2741 * are equivalent (the semantic parent is returned by
2742 * \c clang_getCursorSemanticParent()). They diverge when declarations or
2743 * definitions are provided out-of-line. For example:
2744 *
2745 * \code
2746 * class C {
2747 * void f();
2748 * };
2749 *
2750 * void C::f() { }
2751 * \endcode
2752 *
2753 * In the out-of-line definition of \c C::f, the semantic parent is
2754 * the class \c C, of which this function is a member. The lexical parent is
2755 * the place where the declaration actually occurs in the source code; in this
2756 * case, the definition occurs in the translation unit. In general, the
2757 * lexical parent for a given entity can change without affecting the semantics
2758 * of the program, and the lexical parent of different declarations of the
2759 * same entity may be different. Changing the semantic parent of a declaration,
2760 * on the other hand, can have a major impact on semantics, and redeclarations
2761 * of a particular entity should all have the same semantic context.
2762 *
2763 * In the example above, both declarations of \c C::f have \c C as their
2764 * semantic context, while the lexical context of the first \c C::f is \c C
2765 * and the lexical context of the second \c C::f is the translation unit.
2766 *
2767 * For declarations written in the global scope, the lexical parent is
2768 * the translation unit.
2769 */
2770CINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor);
2771
2772/**
2773 * Determine the set of methods that are overridden by the given
2774 * method.
2775 *
2776 * In both Objective-C and C++, a method (aka virtual member function,
2777 * in C++) can override a virtual method in a base class. For
2778 * Objective-C, a method is said to override any method in the class's
2779 * base class, its protocols, or its categories' protocols, that has the same
2780 * selector and is of the same kind (class or instance).
2781 * If no such method exists, the search continues to the class's superclass,
2782 * its protocols, and its categories, and so on. A method from an Objective-C
2783 * implementation is considered to override the same methods as its
2784 * corresponding method in the interface.
2785 *
2786 * For C++, a virtual member function overrides any virtual member
2787 * function with the same signature that occurs in its base
2788 * classes. With multiple inheritance, a virtual member function can
2789 * override several virtual member functions coming from different
2790 * base classes.
2791 *
2792 * In all cases, this function determines the immediate overridden
2793 * method, rather than all of the overridden methods. For example, if
2794 * a method is originally declared in a class A, then overridden in B
2795 * (which in inherits from A) and also in C (which inherited from B),
2796 * then the only overridden method returned from this function when
2797 * invoked on C's method will be B's method. The client may then
2798 * invoke this function again, given the previously-found overridden
2799 * methods, to map out the complete method-override set.
2800 *
2801 * \param cursor A cursor representing an Objective-C or C++
2802 * method. This routine will compute the set of methods that this
2803 * method overrides.
2804 *
2805 * \param overridden A pointer whose pointee will be replaced with a
2806 * pointer to an array of cursors, representing the set of overridden
2807 * methods. If there are no overridden methods, the pointee will be
2808 * set to NULL. The pointee must be freed via a call to
2809 * \c clang_disposeOverriddenCursors().
2810 *
2811 * \param num_overridden A pointer to the number of overridden
2812 * functions, will be set to the number of overridden functions in the
2813 * array pointed to by \p overridden.
2814 */
2815CINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor,
2816 CXCursor **overridden,
2817 unsigned *num_overridden);
2818
2819/**
2820 * Free the set of overridden cursors returned by \c
2821 * clang_getOverriddenCursors().
2822 */
2823CINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden);
2824
2825/**
2826 * Retrieve the file that is included by the given inclusion directive
2827 * cursor.
2828 */
2829CINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor);
2830
2831/**
2832 * @}
2833 */
2834
2835/**
2836 * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
2837 *
2838 * Cursors represent a location within the Abstract Syntax Tree (AST). These
2839 * routines help map between cursors and the physical locations where the
2840 * described entities occur in the source code. The mapping is provided in
2841 * both directions, so one can map from source code to the AST and back.
2842 *
2843 * @{
2844 */
2845
2846/**
2847 * Map a source location to the cursor that describes the entity at that
2848 * location in the source code.
2849 *
2850 * clang_getCursor() maps an arbitrary source location within a translation
2851 * unit down to the most specific cursor that describes the entity at that
2852 * location. For example, given an expression \c x + y, invoking
2853 * clang_getCursor() with a source location pointing to "x" will return the
2854 * cursor for "x"; similarly for "y". If the cursor points anywhere between
2855 * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
2856 * will return a cursor referring to the "+" expression.
2857 *
2858 * \returns a cursor representing the entity at the given source location, or
2859 * a NULL cursor if no such entity can be found.
2860 */
2861CINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation);
2862
2863/**
2864 * Retrieve the physical location of the source constructor referenced
2865 * by the given cursor.
2866 *
2867 * The location of a declaration is typically the location of the name of that
2868 * declaration, where the name of that declaration would occur if it is
2869 * unnamed, or some keyword that introduces that particular declaration.
2870 * The location of a reference is where that reference occurs within the
2871 * source code.
2872 */
2873CINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor);
2874
2875/**
2876 * Retrieve the physical extent of the source construct referenced by
2877 * the given cursor.
2878 *
2879 * The extent of a cursor starts with the file/line/column pointing at the
2880 * first character within the source construct that the cursor refers to and
2881 * ends with the last character within that source construct. For a
2882 * declaration, the extent covers the declaration itself. For a reference,
2883 * the extent covers the location of the reference (e.g., where the referenced
2884 * entity was actually used).
2885 */
2886CINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor);
2887
2888/**
2889 * @}
2890 */
2891
2892/**
2893 * \defgroup CINDEX_TYPES Type information for CXCursors
2894 *
2895 * @{
2896 */
2897
2898/**
2899 * Describes the kind of type
2900 */
2901enum CXTypeKind {
2902 /**
2903 * Represents an invalid type (e.g., where no type is available).
2904 */
2905 CXType_Invalid = 0,
2906
2907 /**
2908 * A type whose specific kind is not exposed via this
2909 * interface.
2910 */
2911 CXType_Unexposed = 1,
2912
2913 /* Builtin types */
2914 CXType_Void = 2,
2915 CXType_Bool = 3,
2916 CXType_Char_U = 4,
2917 CXType_UChar = 5,
2918 CXType_Char16 = 6,
2919 CXType_Char32 = 7,
2920 CXType_UShort = 8,
2921 CXType_UInt = 9,
2922 CXType_ULong = 10,
2923 CXType_ULongLong = 11,
2924 CXType_UInt128 = 12,
2925 CXType_Char_S = 13,
2926 CXType_SChar = 14,
2927 CXType_WChar = 15,
2928 CXType_Short = 16,
2929 CXType_Int = 17,
2930 CXType_Long = 18,
2931 CXType_LongLong = 19,
2932 CXType_Int128 = 20,
2933 CXType_Float = 21,
2934 CXType_Double = 22,
2935 CXType_LongDouble = 23,
2936 CXType_NullPtr = 24,
2937 CXType_Overload = 25,
2938 CXType_Dependent = 26,
2939 CXType_ObjCId = 27,
2940 CXType_ObjCClass = 28,
2941 CXType_ObjCSel = 29,
2942 CXType_Float128 = 30,
2943 CXType_Half = 31,
2944 CXType_Float16 = 32,
2945 CXType_ShortAccum = 33,
2946 CXType_Accum = 34,
2947 CXType_LongAccum = 35,
2948 CXType_UShortAccum = 36,
2949 CXType_UAccum = 37,
2950 CXType_ULongAccum = 38,
2951 CXType_BFloat16 = 39,
2952 CXType_Ibm128 = 40,
2953 CXType_FirstBuiltin = CXType_Void,
2954 CXType_LastBuiltin = CXType_Ibm128,
2955
2956 CXType_Complex = 100,
2957 CXType_Pointer = 101,
2958 CXType_BlockPointer = 102,
2959 CXType_LValueReference = 103,
2960 CXType_RValueReference = 104,
2961 CXType_Record = 105,
2962 CXType_Enum = 106,
2963 CXType_Typedef = 107,
2964 CXType_ObjCInterface = 108,
2965 CXType_ObjCObjectPointer = 109,
2966 CXType_FunctionNoProto = 110,
2967 CXType_FunctionProto = 111,
2968 CXType_ConstantArray = 112,
2969 CXType_Vector = 113,
2970 CXType_IncompleteArray = 114,
2971 CXType_VariableArray = 115,
2972 CXType_DependentSizedArray = 116,
2973 CXType_MemberPointer = 117,
2974 CXType_Auto = 118,
2975
2976 /**
2977 * Represents a type that was referred to using an elaborated type keyword.
2978 *
2979 * E.g., struct S, or via a qualified name, e.g., N::M::type, or both.
2980 */
2981 CXType_Elaborated = 119,
2982
2983 /* OpenCL PipeType. */
2984 CXType_Pipe = 120,
2985
2986 /* OpenCL builtin types. */
2987 CXType_OCLImage1dRO = 121,
2988 CXType_OCLImage1dArrayRO = 122,
2989 CXType_OCLImage1dBufferRO = 123,
2990 CXType_OCLImage2dRO = 124,
2991 CXType_OCLImage2dArrayRO = 125,
2992 CXType_OCLImage2dDepthRO = 126,
2993 CXType_OCLImage2dArrayDepthRO = 127,
2994 CXType_OCLImage2dMSAARO = 128,
2995 CXType_OCLImage2dArrayMSAARO = 129,
2996 CXType_OCLImage2dMSAADepthRO = 130,
2997 CXType_OCLImage2dArrayMSAADepthRO = 131,
2998 CXType_OCLImage3dRO = 132,
2999 CXType_OCLImage1dWO = 133,
3000 CXType_OCLImage1dArrayWO = 134,
3001 CXType_OCLImage1dBufferWO = 135,
3002 CXType_OCLImage2dWO = 136,
3003 CXType_OCLImage2dArrayWO = 137,
3004 CXType_OCLImage2dDepthWO = 138,
3005 CXType_OCLImage2dArrayDepthWO = 139,
3006 CXType_OCLImage2dMSAAWO = 140,
3007 CXType_OCLImage2dArrayMSAAWO = 141,
3008 CXType_OCLImage2dMSAADepthWO = 142,
3009 CXType_OCLImage2dArrayMSAADepthWO = 143,
3010 CXType_OCLImage3dWO = 144,
3011 CXType_OCLImage1dRW = 145,
3012 CXType_OCLImage1dArrayRW = 146,
3013 CXType_OCLImage1dBufferRW = 147,
3014 CXType_OCLImage2dRW = 148,
3015 CXType_OCLImage2dArrayRW = 149,
3016 CXType_OCLImage2dDepthRW = 150,
3017 CXType_OCLImage2dArrayDepthRW = 151,
3018 CXType_OCLImage2dMSAARW = 152,
3019 CXType_OCLImage2dArrayMSAARW = 153,
3020 CXType_OCLImage2dMSAADepthRW = 154,
3021 CXType_OCLImage2dArrayMSAADepthRW = 155,
3022 CXType_OCLImage3dRW = 156,
3023 CXType_OCLSampler = 157,
3024 CXType_OCLEvent = 158,
3025 CXType_OCLQueue = 159,
3026 CXType_OCLReserveID = 160,
3027
3028 CXType_ObjCObject = 161,
3029 CXType_ObjCTypeParam = 162,
3030 CXType_Attributed = 163,
3031
3032 CXType_OCLIntelSubgroupAVCMcePayload = 164,
3033 CXType_OCLIntelSubgroupAVCImePayload = 165,
3034 CXType_OCLIntelSubgroupAVCRefPayload = 166,
3035 CXType_OCLIntelSubgroupAVCSicPayload = 167,
3036 CXType_OCLIntelSubgroupAVCMceResult = 168,
3037 CXType_OCLIntelSubgroupAVCImeResult = 169,
3038 CXType_OCLIntelSubgroupAVCRefResult = 170,
3039 CXType_OCLIntelSubgroupAVCSicResult = 171,
3040 CXType_OCLIntelSubgroupAVCImeResultSingleReferenceStreamout = 172,
3041 CXType_OCLIntelSubgroupAVCImeResultDualReferenceStreamout = 173,
3042 CXType_OCLIntelSubgroupAVCImeSingleReferenceStreamin = 174,
3043 CXType_OCLIntelSubgroupAVCImeDualReferenceStreamin = 175,
3044
3045 /* Old aliases for AVC OpenCL extension types. */
3046 CXType_OCLIntelSubgroupAVCImeResultSingleRefStreamout = 172,
3047 CXType_OCLIntelSubgroupAVCImeResultDualRefStreamout = 173,
3048 CXType_OCLIntelSubgroupAVCImeSingleRefStreamin = 174,
3049 CXType_OCLIntelSubgroupAVCImeDualRefStreamin = 175,
3050
3051 CXType_ExtVector = 176,
3052 CXType_Atomic = 177,
3053 CXType_BTFTagAttributed = 178,
3054
3055 /* HLSL Types */
3056 CXType_HLSLResource = 179,
3057 CXType_HLSLAttributedResource = 180,
3058 CXType_HLSLInlineSpirv = 181,
3059
3060 CXType_PredefinedSugar = 182
3061};
3062
3063/**
3064 * Describes the calling convention of a function type
3065 */
3066enum CXCallingConv {
3067 CXCallingConv_Default = 0,
3068 CXCallingConv_C = 1,
3069 CXCallingConv_X86StdCall = 2,
3070 CXCallingConv_X86FastCall = 3,
3071 CXCallingConv_X86ThisCall = 4,
3072 CXCallingConv_X86Pascal = 5,
3073 CXCallingConv_AAPCS = 6,
3074 CXCallingConv_AAPCS_VFP = 7,
3075 CXCallingConv_X86RegCall = 8,
3076 CXCallingConv_IntelOclBicc = 9,
3077 CXCallingConv_Win64 = 10,
3078 /* Alias for compatibility with older versions of API. */
3079 CXCallingConv_X86_64Win64 = CXCallingConv_Win64,
3080 CXCallingConv_X86_64SysV = 11,
3081 CXCallingConv_X86VectorCall = 12,
3082 CXCallingConv_Swift = 13,
3083 CXCallingConv_PreserveMost = 14,
3084 CXCallingConv_PreserveAll = 15,
3085 CXCallingConv_AArch64VectorCall = 16,
3086 CXCallingConv_SwiftAsync = 17,
3087 CXCallingConv_AArch64SVEPCS = 18,
3088 CXCallingConv_M68kRTD = 19,
3089 CXCallingConv_PreserveNone = 20,
3090 CXCallingConv_RISCVVectorCall = 21,
3091 CXCallingConv_RISCVVLSCall_32 = 22,
3092 CXCallingConv_RISCVVLSCall_64 = 23,
3093 CXCallingConv_RISCVVLSCall_128 = 24,
3094 CXCallingConv_RISCVVLSCall_256 = 25,
3095 CXCallingConv_RISCVVLSCall_512 = 26,
3096 CXCallingConv_RISCVVLSCall_1024 = 27,
3097 CXCallingConv_RISCVVLSCall_2048 = 28,
3098 CXCallingConv_RISCVVLSCall_4096 = 29,
3099 CXCallingConv_RISCVVLSCall_8192 = 30,
3100 CXCallingConv_RISCVVLSCall_16384 = 31,
3101 CXCallingConv_RISCVVLSCall_32768 = 32,
3102 CXCallingConv_RISCVVLSCall_65536 = 33,
3103
3104 CXCallingConv_Invalid = 100,
3105 CXCallingConv_Unexposed = 200
3106};
3107
3108/**
3109 * The type of an element in the abstract syntax tree.
3110 *
3111 */
3112typedef struct {
3113 enum CXTypeKind kind;
3114 void *data[2];
3115} CXType;
3116
3117/**
3118 * Retrieve the type of a CXCursor (if any).
3119 */
3120CINDEX_LINKAGE CXType clang_getCursorType(CXCursor C);
3121
3122/**
3123 * Pretty-print the underlying type using the rules of the
3124 * language of the translation unit from which it came.
3125 *
3126 * If the type is invalid, an empty string is returned.
3127 */
3128CINDEX_LINKAGE CXString clang_getTypeSpelling(CXType CT);
3129
3130/**
3131 * Retrieve the underlying type of a typedef declaration.
3132 *
3133 * If the cursor does not reference a typedef declaration, an invalid type is
3134 * returned.
3135 */
3136CINDEX_LINKAGE CXType clang_getTypedefDeclUnderlyingType(CXCursor C);
3137
3138/**
3139 * Retrieve the integer type of an enum declaration.
3140 *
3141 * If the cursor does not reference an enum declaration, an invalid type is
3142 * returned.
3143 */
3144CINDEX_LINKAGE CXType clang_getEnumDeclIntegerType(CXCursor C);
3145
3146/**
3147 * Retrieve the integer value of an enum constant declaration as a signed
3148 * long long.
3149 *
3150 * If the cursor does not reference an enum constant declaration, LLONG_MIN is
3151 * returned. Since this is also potentially a valid constant value, the kind of
3152 * the cursor must be verified before calling this function.
3153 */
3154CINDEX_LINKAGE long long clang_getEnumConstantDeclValue(CXCursor C);
3155
3156/**
3157 * Retrieve the integer value of an enum constant declaration as an unsigned
3158 * long long.
3159 *
3160 * If the cursor does not reference an enum constant declaration, ULLONG_MAX is
3161 * returned. Since this is also potentially a valid constant value, the kind of
3162 * the cursor must be verified before calling this function.
3163 */
3164CINDEX_LINKAGE unsigned long long
3165clang_getEnumConstantDeclUnsignedValue(CXCursor C);
3166
3167/**
3168 * Returns non-zero if the cursor specifies a Record member that is a bit-field.
3169 */
3170CINDEX_LINKAGE unsigned clang_Cursor_isBitField(CXCursor C);
3171
3172/**
3173 * Retrieve the bit width of a bit-field declaration as an integer.
3174 *
3175 * If the cursor does not reference a bit-field, or if the bit-field's width
3176 * expression cannot be evaluated, -1 is returned.
3177 *
3178 * For example:
3179 * \code
3180 * if (clang_Cursor_isBitField(Cursor)) {
3181 * int Width = clang_getFieldDeclBitWidth(Cursor);
3182 * if (Width != -1) {
3183 * // The bit-field width is not value-dependent.
3184 * }
3185 * }
3186 * \endcode
3187 */
3188CINDEX_LINKAGE int clang_getFieldDeclBitWidth(CXCursor C);
3189
3190/**
3191 * Retrieve the number of non-variadic arguments associated with a given
3192 * cursor.
3193 *
3194 * The number of arguments can be determined for calls as well as for
3195 * declarations of functions or methods. For other cursors -1 is returned.
3196 */
3197CINDEX_LINKAGE int clang_Cursor_getNumArguments(CXCursor C);
3198
3199/**
3200 * Retrieve the argument cursor of a function or method.
3201 *
3202 * The argument cursor can be determined for calls as well as for declarations
3203 * of functions or methods. For other cursors and for invalid indices, an
3204 * invalid cursor is returned.
3205 */
3206CINDEX_LINKAGE CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i);
3207
3208/**
3209 * Describes the kind of a template argument.
3210 *
3211 * See the definition of llvm::clang::TemplateArgument::ArgKind for full
3212 * element descriptions.
3213 */
3214enum CXTemplateArgumentKind {
3215 CXTemplateArgumentKind_Null,
3216 CXTemplateArgumentKind_Type,
3217 CXTemplateArgumentKind_Declaration,
3218 CXTemplateArgumentKind_NullPtr,
3219 CXTemplateArgumentKind_Integral,
3220 CXTemplateArgumentKind_Template,
3221 CXTemplateArgumentKind_TemplateExpansion,
3222 CXTemplateArgumentKind_Expression,
3223 CXTemplateArgumentKind_Pack,
3224 /* Indicates an error case, preventing the kind from being deduced. */
3225 CXTemplateArgumentKind_Invalid
3226};
3227
3228/**
3229 * Returns the number of template args of a function, struct, or class decl
3230 * representing a template specialization.
3231 *
3232 * If the argument cursor cannot be converted into a template function
3233 * declaration, -1 is returned.
3234 *
3235 * For example, for the following declaration and specialization:
3236 * template <typename T, int kInt, bool kBool>
3237 * void foo() { ... }
3238 *
3239 * template <>
3240 * void foo<float, -7, true>();
3241 *
3242 * The value 3 would be returned from this call.
3243 */
3244CINDEX_LINKAGE int clang_Cursor_getNumTemplateArguments(CXCursor C);
3245
3246/**
3247 * Retrieve the kind of the I'th template argument of the CXCursor C.
3248 *
3249 * If the argument CXCursor does not represent a FunctionDecl, StructDecl, or
3250 * ClassTemplatePartialSpecialization, an invalid template argument kind is
3251 * returned.
3252 *
3253 * For example, for the following declaration and specialization:
3254 * template <typename T, int kInt, bool kBool>
3255 * void foo() { ... }
3256 *
3257 * template <>
3258 * void foo<float, -7, true>();
3259 *
3260 * For I = 0, 1, and 2, Type, Integral, and Integral will be returned,
3261 * respectively.
3262 */
3263CINDEX_LINKAGE enum CXTemplateArgumentKind
3264clang_Cursor_getTemplateArgumentKind(CXCursor C, unsigned I);
3265
3266/**
3267 * Retrieve a CXType representing the type of a TemplateArgument of a
3268 * function decl representing a template specialization.
3269 *
3270 * If the argument CXCursor does not represent a FunctionDecl, StructDecl,
3271 * ClassDecl or ClassTemplatePartialSpecialization whose I'th template argument
3272 * has a kind of CXTemplateArgKind_Integral, an invalid type is returned.
3273 *
3274 * For example, for the following declaration and specialization:
3275 * template <typename T, int kInt, bool kBool>
3276 * void foo() { ... }
3277 *
3278 * template <>
3279 * void foo<float, -7, true>();
3280 *
3281 * If called with I = 0, "float", will be returned.
3282 * Invalid types will be returned for I == 1 or 2.
3283 */
3284CINDEX_LINKAGE CXType clang_Cursor_getTemplateArgumentType(CXCursor C,
3285 unsigned I);
3286
3287/**
3288 * Retrieve the value of an Integral TemplateArgument (of a function
3289 * decl representing a template specialization) as a signed long long.
3290 *
3291 * It is undefined to call this function on a CXCursor that does not represent a
3292 * FunctionDecl, StructDecl, ClassDecl or ClassTemplatePartialSpecialization
3293 * whose I'th template argument is not an integral value.
3294 *
3295 * For example, for the following declaration and specialization:
3296 * template <typename T, int kInt, bool kBool>
3297 * void foo() { ... }
3298 *
3299 * template <>
3300 * void foo<float, -7, true>();
3301 *
3302 * If called with I = 1 or 2, -7 or true will be returned, respectively.
3303 * For I == 0, this function's behavior is undefined.
3304 */
3305CINDEX_LINKAGE long long clang_Cursor_getTemplateArgumentValue(CXCursor C,
3306 unsigned I);
3307
3308/**
3309 * Retrieve the value of an Integral TemplateArgument (of a function
3310 * decl representing a template specialization) as an unsigned long long.
3311 *
3312 * It is undefined to call this function on a CXCursor that does not represent a
3313 * FunctionDecl, StructDecl, ClassDecl or ClassTemplatePartialSpecialization or
3314 * whose I'th template argument is not an integral value.
3315 *
3316 * For example, for the following declaration and specialization:
3317 * template <typename T, int kInt, bool kBool>
3318 * void foo() { ... }
3319 *
3320 * template <>
3321 * void foo<float, 2147483649, true>();
3322 *
3323 * If called with I = 1 or 2, 2147483649 or true will be returned, respectively.
3324 * For I == 0, this function's behavior is undefined.
3325 */
3326CINDEX_LINKAGE unsigned long long
3327clang_Cursor_getTemplateArgumentUnsignedValue(CXCursor C, unsigned I);
3328
3329/**
3330 * Determine whether two CXTypes represent the same type.
3331 *
3332 * \returns non-zero if the CXTypes represent the same type and
3333 * zero otherwise.
3334 */
3335CINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B);
3336
3337/**
3338 * Return the canonical type for a CXType.
3339 *
3340 * Clang's type system explicitly models typedefs and all the ways
3341 * a specific type can be represented. The canonical type is the underlying
3342 * type with all the "sugar" removed. For example, if 'T' is a typedef
3343 * for 'int', the canonical type for 'T' would be 'int'.
3344 */
3345CINDEX_LINKAGE CXType clang_getCanonicalType(CXType T);
3346
3347/**
3348 * Determine whether a CXType has the "const" qualifier set,
3349 * without looking through typedefs that may have added "const" at a
3350 * different level.
3351 */
3352CINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T);
3353
3354/**
3355 * Determine whether a CXCursor that is a macro, is
3356 * function like.
3357 */
3358CINDEX_LINKAGE unsigned clang_Cursor_isMacroFunctionLike(CXCursor C);
3359
3360/**
3361 * Determine whether a CXCursor that is a macro, is a
3362 * builtin one.
3363 */
3364CINDEX_LINKAGE unsigned clang_Cursor_isMacroBuiltin(CXCursor C);
3365
3366/**
3367 * Determine whether a CXCursor that is a function declaration, is an
3368 * inline declaration.
3369 */
3370CINDEX_LINKAGE unsigned clang_Cursor_isFunctionInlined(CXCursor C);
3371
3372/**
3373 * Determine whether a CXType has the "volatile" qualifier set,
3374 * without looking through typedefs that may have added "volatile" at
3375 * a different level.
3376 */
3377CINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T);
3378
3379/**
3380 * Determine whether a CXType has the "restrict" qualifier set,
3381 * without looking through typedefs that may have added "restrict" at a
3382 * different level.
3383 */
3384CINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T);
3385
3386/**
3387 * Returns the address space of the given type.
3388 */
3389CINDEX_LINKAGE unsigned clang_getAddressSpace(CXType T);
3390
3391/**
3392 * Returns the typedef name of the given type.
3393 */
3394CINDEX_LINKAGE CXString clang_getTypedefName(CXType CT);
3395
3396/**
3397 * For pointer types, returns the type of the pointee.
3398 */
3399CINDEX_LINKAGE CXType clang_getPointeeType(CXType T);
3400
3401/**
3402 * Retrieve the unqualified variant of the given type, removing as
3403 * little sugar as possible.
3404 *
3405 * For example, given the following series of typedefs:
3406 *
3407 * \code
3408 * typedef int Integer;
3409 * typedef const Integer CInteger;
3410 * typedef CInteger DifferenceType;
3411 * \endcode
3412 *
3413 * Executing \c clang_getUnqualifiedType() on a \c CXType that
3414 * represents \c DifferenceType, will desugar to a type representing
3415 * \c Integer, that has no qualifiers.
3416 *
3417 * And, executing \c clang_getUnqualifiedType() on the type of the
3418 * first argument of the following function declaration:
3419 *
3420 * \code
3421 * void foo(const int);
3422 * \endcode
3423 *
3424 * Will return a type representing \c int, removing the \c const
3425 * qualifier.
3426 *
3427 * Sugar over array types is not desugared.
3428 *
3429 * A type can be checked for qualifiers with \c
3430 * clang_isConstQualifiedType(), \c clang_isVolatileQualifiedType()
3431 * and \c clang_isRestrictQualifiedType().
3432 *
3433 * A type that resulted from a call to \c clang_getUnqualifiedType
3434 * will return \c false for all of the above calls.
3435 */
3436CINDEX_LINKAGE CXType clang_getUnqualifiedType(CXType CT);
3437
3438/**
3439 * For reference types (e.g., "const int&"), returns the type that the
3440 * reference refers to (e.g "const int").
3441 *
3442 * Otherwise, returns the type itself.
3443 *
3444 * A type that has kind \c CXType_LValueReference or
3445 * \c CXType_RValueReference is a reference type.
3446 */
3447CINDEX_LINKAGE CXType clang_getNonReferenceType(CXType CT);
3448
3449/**
3450 * Return the cursor for the declaration of the given type.
3451 */
3452CINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T);
3453
3454/**
3455 * Returns the Objective-C type encoding for the specified declaration.
3456 */
3457CINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C);
3458
3459/**
3460 * Returns the Objective-C type encoding for the specified CXType.
3461 */
3462CINDEX_LINKAGE CXString clang_Type_getObjCEncoding(CXType type);
3463
3464/**
3465 * Retrieve the spelling of a given CXTypeKind.
3466 */
3467CINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K);
3468
3469/**
3470 * Retrieve the calling convention associated with a function type.
3471 *
3472 * If a non-function type is passed in, CXCallingConv_Invalid is returned.
3473 */
3474CINDEX_LINKAGE enum CXCallingConv clang_getFunctionTypeCallingConv(CXType T);
3475
3476/**
3477 * Retrieve the return type associated with a function type.
3478 *
3479 * If a non-function type is passed in, an invalid type is returned.
3480 */
3481CINDEX_LINKAGE CXType clang_getResultType(CXType T);
3482
3483/**
3484 * Retrieve the exception specification type associated with a function type.
3485 * This is a value of type CXCursor_ExceptionSpecificationKind.
3486 *
3487 * If a non-function type is passed in, an error code of -1 is returned.
3488 */
3489CINDEX_LINKAGE int clang_getExceptionSpecificationType(CXType T);
3490
3491/**
3492 * Retrieve the number of non-variadic parameters associated with a
3493 * function type.
3494 *
3495 * If a non-function type is passed in, -1 is returned.
3496 */
3497CINDEX_LINKAGE int clang_getNumArgTypes(CXType T);
3498
3499/**
3500 * Retrieve the type of a parameter of a function type.
3501 *
3502 * If a non-function type is passed in or the function does not have enough
3503 * parameters, an invalid type is returned.
3504 */
3505CINDEX_LINKAGE CXType clang_getArgType(CXType T, unsigned i);
3506
3507/**
3508 * Retrieves the base type of the ObjCObjectType.
3509 *
3510 * If the type is not an ObjC object, an invalid type is returned.
3511 */
3512CINDEX_LINKAGE CXType clang_Type_getObjCObjectBaseType(CXType T);
3513
3514/**
3515 * Retrieve the number of protocol references associated with an ObjC object/id.
3516 *
3517 * If the type is not an ObjC object, 0 is returned.
3518 */
3519CINDEX_LINKAGE unsigned clang_Type_getNumObjCProtocolRefs(CXType T);
3520
3521/**
3522 * Retrieve the decl for a protocol reference for an ObjC object/id.
3523 *
3524 * If the type is not an ObjC object or there are not enough protocol
3525 * references, an invalid cursor is returned.
3526 */
3527CINDEX_LINKAGE CXCursor clang_Type_getObjCProtocolDecl(CXType T, unsigned i);
3528
3529/**
3530 * Retrieve the number of type arguments associated with an ObjC object.
3531 *
3532 * If the type is not an ObjC object, 0 is returned.
3533 */
3534CINDEX_LINKAGE unsigned clang_Type_getNumObjCTypeArgs(CXType T);
3535
3536/**
3537 * Retrieve a type argument associated with an ObjC object.
3538 *
3539 * If the type is not an ObjC or the index is not valid,
3540 * an invalid type is returned.
3541 */
3542CINDEX_LINKAGE CXType clang_Type_getObjCTypeArg(CXType T, unsigned i);
3543
3544/**
3545 * Return 1 if the CXType is a variadic function type, and 0 otherwise.
3546 */
3547CINDEX_LINKAGE unsigned clang_isFunctionTypeVariadic(CXType T);
3548
3549/**
3550 * Retrieve the return type associated with a given cursor.
3551 *
3552 * This only returns a valid type if the cursor refers to a function or method.
3553 */
3554CINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C);
3555
3556/**
3557 * Retrieve the exception specification type associated with a given cursor.
3558 * This is a value of type CXCursor_ExceptionSpecificationKind.
3559 *
3560 * This only returns a valid result if the cursor refers to a function or
3561 * method.
3562 */
3563CINDEX_LINKAGE int clang_getCursorExceptionSpecificationType(CXCursor C);
3564
3565/**
3566 * Return 1 if the CXType is a POD (plain old data) type, and 0
3567 * otherwise.
3568 */
3569CINDEX_LINKAGE unsigned clang_isPODType(CXType T);
3570
3571/**
3572 * Return the element type of an array, complex, or vector type.
3573 *
3574 * If a type is passed in that is not an array, complex, or vector type,
3575 * an invalid type is returned.
3576 */
3577CINDEX_LINKAGE CXType clang_getElementType(CXType T);
3578
3579/**
3580 * Return the number of elements of an array or vector type.
3581 *
3582 * If a type is passed in that is not an array or vector type,
3583 * -1 is returned.
3584 */
3585CINDEX_LINKAGE long long clang_getNumElements(CXType T);
3586
3587/**
3588 * Return the element type of an array type.
3589 *
3590 * If a non-array type is passed in, an invalid type is returned.
3591 */
3592CINDEX_LINKAGE CXType clang_getArrayElementType(CXType T);
3593
3594/**
3595 * Return the array size of a constant array.
3596 *
3597 * If a non-array type is passed in, -1 is returned.
3598 */
3599CINDEX_LINKAGE long long clang_getArraySize(CXType T);
3600
3601/**
3602 * Retrieve the type named by the qualified-id.
3603 *
3604 * If a non-elaborated type is passed in, an invalid type is returned.
3605 */
3606CINDEX_LINKAGE CXType clang_Type_getNamedType(CXType T);
3607
3608/**
3609 * Determine if a typedef is 'transparent' tag.
3610 *
3611 * A typedef is considered 'transparent' if it shares a name and spelling
3612 * location with its underlying tag type, as is the case with the NS_ENUM macro.
3613 *
3614 * \returns non-zero if transparent and zero otherwise.
3615 */
3616CINDEX_LINKAGE unsigned clang_Type_isTransparentTagTypedef(CXType T);
3617
3618enum CXTypeNullabilityKind {
3619 /**
3620 * Values of this type can never be null.
3621 */
3622 CXTypeNullability_NonNull = 0,
3623 /**
3624 * Values of this type can be null.
3625 */
3626 CXTypeNullability_Nullable = 1,
3627 /**
3628 * Whether values of this type can be null is (explicitly)
3629 * unspecified. This captures a (fairly rare) case where we
3630 * can't conclude anything about the nullability of the type even
3631 * though it has been considered.
3632 */
3633 CXTypeNullability_Unspecified = 2,
3634 /**
3635 * Nullability is not applicable to this type.
3636 */
3637 CXTypeNullability_Invalid = 3,
3638
3639 /**
3640 * Generally behaves like Nullable, except when used in a block parameter that
3641 * was imported into a swift async method. There, swift will assume that the
3642 * parameter can get null even if no error occurred. _Nullable parameters are
3643 * assumed to only get null on error.
3644 */
3645 CXTypeNullability_NullableResult = 4
3646};
3647
3648/**
3649 * Retrieve the nullability kind of a pointer type.
3650 */
3651CINDEX_LINKAGE enum CXTypeNullabilityKind clang_Type_getNullability(CXType T);
3652
3653/**
3654 * List the possible error codes for \c clang_Type_getSizeOf,
3655 * \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf,
3656 * \c clang_Cursor_getOffsetOf, and \c clang_getOffsetOfBase.
3657 *
3658 * A value of this enumeration type can be returned if the target type is not
3659 * a valid argument to sizeof, alignof or offsetof.
3660 */
3661enum CXTypeLayoutError {
3662 /**
3663 * Type is of kind CXType_Invalid.
3664 */
3665 CXTypeLayoutError_Invalid = -1,
3666 /**
3667 * The type is an incomplete Type.
3668 */
3669 CXTypeLayoutError_Incomplete = -2,
3670 /**
3671 * The type is a dependent Type.
3672 */
3673 CXTypeLayoutError_Dependent = -3,
3674 /**
3675 * The type is not a constant size type.
3676 */
3677 CXTypeLayoutError_NotConstantSize = -4,
3678 /**
3679 * The Field name is not valid for this record.
3680 */
3681 CXTypeLayoutError_InvalidFieldName = -5,
3682 /**
3683 * The type is undeduced.
3684 */
3685 CXTypeLayoutError_Undeduced = -6
3686};
3687
3688/**
3689 * Return the alignment of a type in bytes as per C++[expr.alignof]
3690 * standard.
3691 *
3692 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3693 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3694 * is returned.
3695 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3696 * returned.
3697 * If the type declaration is not a constant size type,
3698 * CXTypeLayoutError_NotConstantSize is returned.
3699 */
3700CINDEX_LINKAGE long long clang_Type_getAlignOf(CXType T);
3701
3702/**
3703 * Return the class type of an member pointer type.
3704 *
3705 * If a non-member-pointer type is passed in, an invalid type is returned.
3706 */
3707CINDEX_LINKAGE CXType clang_Type_getClassType(CXType T);
3708
3709/**
3710 * Return the size of a type in bytes as per C++[expr.sizeof] standard.
3711 *
3712 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3713 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3714 * is returned.
3715 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3716 * returned.
3717 */
3718CINDEX_LINKAGE long long clang_Type_getSizeOf(CXType T);
3719
3720/**
3721 * Return the offset of a field named S in a record of type T in bits
3722 * as it would be returned by __offsetof__ as per C++11[18.2p4]
3723 *
3724 * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
3725 * is returned.
3726 * If the field's type declaration is an incomplete type,
3727 * CXTypeLayoutError_Incomplete is returned.
3728 * If the field's type declaration is a dependent type,
3729 * CXTypeLayoutError_Dependent is returned.
3730 * If the field's name S is not found,
3731 * CXTypeLayoutError_InvalidFieldName is returned.
3732 */
3733CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S);
3734
3735/**
3736 * Return the type that was modified by this attributed type.
3737 *
3738 * If the type is not an attributed type, an invalid type is returned.
3739 */
3740CINDEX_LINKAGE CXType clang_Type_getModifiedType(CXType T);
3741
3742/**
3743 * Gets the type contained by this atomic type.
3744 *
3745 * If a non-atomic type is passed in, an invalid type is returned.
3746 */
3747CINDEX_LINKAGE CXType clang_Type_getValueType(CXType CT);
3748
3749/**
3750 * Return the offset of the field represented by the Cursor.
3751 *
3752 * If the cursor is not a field declaration, -1 is returned.
3753 * If the cursor semantic parent is not a record field declaration,
3754 * CXTypeLayoutError_Invalid is returned.
3755 * If the field's type declaration is an incomplete type,
3756 * CXTypeLayoutError_Incomplete is returned.
3757 * If the field's type declaration is a dependent type,
3758 * CXTypeLayoutError_Dependent is returned.
3759 * If the field's name S is not found,
3760 * CXTypeLayoutError_InvalidFieldName is returned.
3761 */
3762CINDEX_LINKAGE long long clang_Cursor_getOffsetOfField(CXCursor C);
3763
3764/**
3765 * Determine whether the given cursor represents an anonymous
3766 * tag or namespace
3767 */
3768CINDEX_LINKAGE unsigned clang_Cursor_isAnonymous(CXCursor C);
3769
3770/**
3771 * Determine whether the given cursor represents an anonymous record
3772 * declaration.
3773 */
3774CINDEX_LINKAGE unsigned clang_Cursor_isAnonymousRecordDecl(CXCursor C);
3775
3776/**
3777 * Determine whether the given cursor represents an inline namespace
3778 * declaration.
3779 */
3780CINDEX_LINKAGE unsigned clang_Cursor_isInlineNamespace(CXCursor C);
3781
3782enum CXRefQualifierKind {
3783 /** No ref-qualifier was provided. */
3784 CXRefQualifier_None = 0,
3785 /** An lvalue ref-qualifier was provided (\c &). */
3786 CXRefQualifier_LValue,
3787 /** An rvalue ref-qualifier was provided (\c &&). */
3788 CXRefQualifier_RValue
3789};
3790
3791/**
3792 * Returns the number of template arguments for given template
3793 * specialization, or -1 if type \c T is not a template specialization.
3794 */
3795CINDEX_LINKAGE int clang_Type_getNumTemplateArguments(CXType T);
3796
3797/**
3798 * Returns the type template argument of a template class specialization
3799 * at given index.
3800 *
3801 * This function only returns template type arguments and does not handle
3802 * template template arguments or variadic packs.
3803 */
3804CINDEX_LINKAGE CXType clang_Type_getTemplateArgumentAsType(CXType T,
3805 unsigned i);
3806
3807/**
3808 * Retrieve the ref-qualifier kind of a function or method.
3809 *
3810 * The ref-qualifier is returned for C++ functions or methods. For other types
3811 * or non-C++ declarations, CXRefQualifier_None is returned.
3812 */
3813CINDEX_LINKAGE enum CXRefQualifierKind clang_Type_getCXXRefQualifier(CXType T);
3814
3815/**
3816 * Returns 1 if the base class specified by the cursor with kind
3817 * CX_CXXBaseSpecifier is virtual.
3818 */
3819CINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor);
3820
3821/**
3822 * Returns the offset in bits of a CX_CXXBaseSpecifier relative to the parent
3823 * class.
3824 *
3825 * Returns a small negative number if the offset cannot be computed. See
3826 * CXTypeLayoutError for error codes.
3827 */
3828CINDEX_LINKAGE long long clang_getOffsetOfBase(CXCursor Parent, CXCursor Base);
3829
3830/**
3831 * Represents the C++ access control level to a base class for a
3832 * cursor with kind CX_CXXBaseSpecifier.
3833 */
3834enum CX_CXXAccessSpecifier {
3835 CX_CXXInvalidAccessSpecifier,
3836 CX_CXXPublic,
3837 CX_CXXProtected,
3838 CX_CXXPrivate
3839};
3840
3841/**
3842 * Returns the access control level for the referenced object.
3843 *
3844 * If the cursor refers to a C++ declaration, its access control level within
3845 * its parent scope is returned. Otherwise, if the cursor refers to a base
3846 * specifier or access specifier, the specifier itself is returned.
3847 */
3848CINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor);
3849
3850/**
3851 * Represents the storage classes as declared in the source. CX_SC_Invalid
3852 * was added for the case that the passed cursor in not a declaration.
3853 */
3854enum CX_StorageClass {
3855 CX_SC_Invalid,
3856 CX_SC_None,
3857 CX_SC_Extern,
3858 CX_SC_Static,
3859 CX_SC_PrivateExtern,
3860 CX_SC_OpenCLWorkGroupLocal,
3861 CX_SC_Auto,
3862 CX_SC_Register
3863};
3864
3865/**
3866 * Represents a specific kind of binary operator which can appear at a cursor.
3867 */
3868enum CX_BinaryOperatorKind {
3869 CX_BO_Invalid = 0,
3870 CX_BO_PtrMemD = 1,
3871 CX_BO_PtrMemI = 2,
3872 CX_BO_Mul = 3,
3873 CX_BO_Div = 4,
3874 CX_BO_Rem = 5,
3875 CX_BO_Add = 6,
3876 CX_BO_Sub = 7,
3877 CX_BO_Shl = 8,
3878 CX_BO_Shr = 9,
3879 CX_BO_Cmp = 10,
3880 CX_BO_LT = 11,
3881 CX_BO_GT = 12,
3882 CX_BO_LE = 13,
3883 CX_BO_GE = 14,
3884 CX_BO_EQ = 15,
3885 CX_BO_NE = 16,
3886 CX_BO_And = 17,
3887 CX_BO_Xor = 18,
3888 CX_BO_Or = 19,
3889 CX_BO_LAnd = 20,
3890 CX_BO_LOr = 21,
3891 CX_BO_Assign = 22,
3892 CX_BO_MulAssign = 23,
3893 CX_BO_DivAssign = 24,
3894 CX_BO_RemAssign = 25,
3895 CX_BO_AddAssign = 26,
3896 CX_BO_SubAssign = 27,
3897 CX_BO_ShlAssign = 28,
3898 CX_BO_ShrAssign = 29,
3899 CX_BO_AndAssign = 30,
3900 CX_BO_XorAssign = 31,
3901 CX_BO_OrAssign = 32,
3902 CX_BO_Comma = 33,
3903 CX_BO_LAST = CX_BO_Comma
3904};
3905
3906/**
3907 * \brief Returns the operator code for the binary operator.
3908 *
3909 * @deprecated: use clang_getCursorBinaryOperatorKind instead.
3910 */
3911CINDEX_LINKAGE enum CX_BinaryOperatorKind
3912clang_Cursor_getBinaryOpcode(CXCursor C);
3913
3914/**
3915 * \brief Returns a string containing the spelling of the binary operator.
3916 *
3917 * @deprecated: use clang_getBinaryOperatorKindSpelling instead
3918 */
3919CINDEX_LINKAGE CXString
3920clang_Cursor_getBinaryOpcodeStr(enum CX_BinaryOperatorKind Op);
3921
3922/**
3923 * Returns the storage class for a function or variable declaration.
3924 *
3925 * If the passed in Cursor is not a function or variable declaration,
3926 * CX_SC_Invalid is returned else the storage class.
3927 */
3928CINDEX_LINKAGE enum CX_StorageClass clang_Cursor_getStorageClass(CXCursor);
3929
3930/**
3931 * Determine the number of overloaded declarations referenced by a
3932 * \c CXCursor_OverloadedDeclRef cursor.
3933 *
3934 * \param cursor The cursor whose overloaded declarations are being queried.
3935 *
3936 * \returns The number of overloaded declarations referenced by \c cursor. If it
3937 * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
3938 */
3939CINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor);
3940
3941/**
3942 * Retrieve a cursor for one of the overloaded declarations referenced
3943 * by a \c CXCursor_OverloadedDeclRef cursor.
3944 *
3945 * \param cursor The cursor whose overloaded declarations are being queried.
3946 *
3947 * \param index The zero-based index into the set of overloaded declarations in
3948 * the cursor.
3949 *
3950 * \returns A cursor representing the declaration referenced by the given
3951 * \c cursor at the specified \c index. If the cursor does not have an
3952 * associated set of overloaded declarations, or if the index is out of bounds,
3953 * returns \c clang_getNullCursor();
3954 */
3955CINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor,
3956 unsigned index);
3957
3958/**
3959 * @}
3960 */
3961
3962/**
3963 * \defgroup CINDEX_ATTRIBUTES Information for attributes
3964 *
3965 * @{
3966 */
3967
3968/**
3969 * For cursors representing an iboutletcollection attribute,
3970 * this function returns the collection element type.
3971 *
3972 */
3973CINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor);
3974
3975/**
3976 * @}
3977 */
3978
3979/**
3980 * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
3981 *
3982 * These routines provide the ability to traverse the abstract syntax tree
3983 * using cursors.
3984 *
3985 * @{
3986 */
3987
3988/**
3989 * Describes how the traversal of the children of a particular
3990 * cursor should proceed after visiting a particular child cursor.
3991 *
3992 * A value of this enumeration type should be returned by each
3993 * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
3994 */
3995enum CXChildVisitResult {
3996 /**
3997 * Terminates the cursor traversal.
3998 */
3999 CXChildVisit_Break,
4000 /**
4001 * Continues the cursor traversal with the next sibling of
4002 * the cursor just visited, without visiting its children.
4003 */
4004 CXChildVisit_Continue,
4005 /**
4006 * Recursively traverse the children of this cursor, using
4007 * the same visitor and client data.
4008 */
4009 CXChildVisit_Recurse
4010};
4011
4012/**
4013 * Visitor invoked for each cursor found by a traversal.
4014 *
4015 * This visitor function will be invoked for each cursor found by
4016 * clang_visitCursorChildren(). Its first argument is the cursor being
4017 * visited, its second argument is the parent visitor for that cursor,
4018 * and its third argument is the client data provided to
4019 * clang_visitCursorChildren().
4020 *
4021 * The visitor should return one of the \c CXChildVisitResult values
4022 * to direct clang_visitCursorChildren().
4023 */
4024typedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor,
4025 CXCursor parent,
4026 CXClientData client_data);
4027
4028/**
4029 * Visit the children of a particular cursor.
4030 *
4031 * This function visits all the direct children of the given cursor,
4032 * invoking the given \p visitor function with the cursors of each
4033 * visited child. The traversal may be recursive, if the visitor returns
4034 * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
4035 * the visitor returns \c CXChildVisit_Break.
4036 *
4037 * \param parent the cursor whose child may be visited. All kinds of
4038 * cursors can be visited, including invalid cursors (which, by
4039 * definition, have no children).
4040 *
4041 * \param visitor the visitor function that will be invoked for each
4042 * child of \p parent.
4043 *
4044 * \param client_data pointer data supplied by the client, which will
4045 * be passed to the visitor each time it is invoked.
4046 *
4047 * \returns a non-zero value if the traversal was terminated
4048 * prematurely by the visitor returning \c CXChildVisit_Break.
4049 */
4050CINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent,
4051 CXCursorVisitor visitor,
4052 CXClientData client_data);
4053/**
4054 * Visitor invoked for each cursor found by a traversal.
4055 *
4056 * This visitor block will be invoked for each cursor found by
4057 * clang_visitChildrenWithBlock(). Its first argument is the cursor being
4058 * visited, its second argument is the parent visitor for that cursor.
4059 *
4060 * The visitor should return one of the \c CXChildVisitResult values
4061 * to direct clang_visitChildrenWithBlock().
4062 */
4063#if __has_feature(blocks)
4064typedef enum CXChildVisitResult (^CXCursorVisitorBlock)(CXCursor cursor,
4065 CXCursor parent);
4066#else
4067typedef struct _CXChildVisitResult *CXCursorVisitorBlock;
4068#endif
4069
4070/**
4071 * Visits the children of a cursor using the specified block. Behaves
4072 * identically to clang_visitChildren() in all other respects.
4073 */
4074CINDEX_LINKAGE unsigned
4075clang_visitChildrenWithBlock(CXCursor parent, CXCursorVisitorBlock block);
4076
4077/**
4078 * @}
4079 */
4080
4081/**
4082 * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
4083 *
4084 * These routines provide the ability to determine references within and
4085 * across translation units, by providing the names of the entities referenced
4086 * by cursors, follow reference cursors to the declarations they reference,
4087 * and associate declarations with their definitions.
4088 *
4089 * @{
4090 */
4091
4092/**
4093 * Retrieve a Unified Symbol Resolution (USR) for the entity referenced
4094 * by the given cursor.
4095 *
4096 * A Unified Symbol Resolution (USR) is a string that identifies a particular
4097 * entity (function, class, variable, etc.) within a program. USRs can be
4098 * compared across translation units to determine, e.g., when references in
4099 * one translation refer to an entity defined in another translation unit.
4100 */
4101CINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor);
4102
4103/**
4104 * Construct a USR for a specified Objective-C class.
4105 */
4106CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
4107
4108/**
4109 * Construct a USR for a specified Objective-C category.
4110 */
4111CINDEX_LINKAGE CXString clang_constructUSR_ObjCCategory(
4112 const char *class_name, const char *category_name);
4113
4114/**
4115 * Construct a USR for a specified Objective-C protocol.
4116 */
4117CINDEX_LINKAGE CXString
4118clang_constructUSR_ObjCProtocol(const char *protocol_name);
4119
4120/**
4121 * Construct a USR for a specified Objective-C instance variable and
4122 * the USR for its containing class.
4123 */
4124CINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name,
4125 CXString classUSR);
4126
4127/**
4128 * Construct a USR for a specified Objective-C method and
4129 * the USR for its containing class.
4130 */
4131CINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name,
4132 unsigned isInstanceMethod,
4133 CXString classUSR);
4134
4135/**
4136 * Construct a USR for a specified Objective-C property and the USR
4137 * for its containing class.
4138 */
4139CINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property,
4140 CXString classUSR);
4141
4142/**
4143 * Retrieve a name for the entity referenced by this cursor.
4144 */
4145CINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor);
4146
4147/**
4148 * Retrieve a range for a piece that forms the cursors spelling name.
4149 * Most of the times there is only one range for the complete spelling but for
4150 * Objective-C methods and Objective-C message expressions, there are multiple
4151 * pieces for each selector identifier.
4152 *
4153 * \param pieceIndex the index of the spelling name piece. If this is greater
4154 * than the actual number of pieces, it will return a NULL (invalid) range.
4155 *
4156 * \param options Reserved.
4157 */
4158CINDEX_LINKAGE CXSourceRange clang_Cursor_getSpellingNameRange(
4159 CXCursor, unsigned pieceIndex, unsigned options);
4160
4161/**
4162 * Opaque pointer representing a policy that controls pretty printing
4163 * for \c clang_getCursorPrettyPrinted.
4164 */
4165typedef void *CXPrintingPolicy;
4166
4167/**
4168 * Properties for the printing policy.
4169 *
4170 * See \c clang::PrintingPolicy for more information.
4171 */
4172enum CXPrintingPolicyProperty {
4173 CXPrintingPolicy_Indentation,
4174 CXPrintingPolicy_SuppressSpecifiers,
4175 CXPrintingPolicy_SuppressTagKeyword,
4176 CXPrintingPolicy_IncludeTagDefinition,
4177 CXPrintingPolicy_SuppressScope,
4178 CXPrintingPolicy_SuppressUnwrittenScope,
4179 CXPrintingPolicy_SuppressInitializers,
4180 CXPrintingPolicy_ConstantArraySizeAsWritten,
4181 CXPrintingPolicy_AnonymousTagLocations,
4182 CXPrintingPolicy_SuppressStrongLifetime,
4183 CXPrintingPolicy_SuppressLifetimeQualifiers,
4184 CXPrintingPolicy_SuppressTemplateArgsInCXXConstructors,
4185 CXPrintingPolicy_Bool,
4186 CXPrintingPolicy_Restrict,
4187 CXPrintingPolicy_Alignof,
4188 CXPrintingPolicy_UnderscoreAlignof,
4189 CXPrintingPolicy_UseVoidForZeroParams,
4190 CXPrintingPolicy_TerseOutput,
4191 CXPrintingPolicy_PolishForDeclaration,
4192 CXPrintingPolicy_Half,
4193 CXPrintingPolicy_MSWChar,
4194 CXPrintingPolicy_IncludeNewlines,
4195 CXPrintingPolicy_MSVCFormatting,
4196 CXPrintingPolicy_ConstantsAsWritten,
4197 CXPrintingPolicy_SuppressImplicitBase,
4198 CXPrintingPolicy_FullyQualifiedName,
4199
4200 CXPrintingPolicy_LastProperty = CXPrintingPolicy_FullyQualifiedName
4201};
4202
4203/**
4204 * Get a property value for the given printing policy.
4205 */
4206CINDEX_LINKAGE unsigned
4207clang_PrintingPolicy_getProperty(CXPrintingPolicy Policy,
4208 enum CXPrintingPolicyProperty Property);
4209
4210/**
4211 * Set a property value for the given printing policy.
4212 */
4213CINDEX_LINKAGE void
4214clang_PrintingPolicy_setProperty(CXPrintingPolicy Policy,
4215 enum CXPrintingPolicyProperty Property,
4216 unsigned Value);
4217
4218/**
4219 * Retrieve the default policy for the cursor.
4220 *
4221 * The policy should be released after use with \c
4222 * clang_PrintingPolicy_dispose.
4223 */
4224CINDEX_LINKAGE CXPrintingPolicy clang_getCursorPrintingPolicy(CXCursor);
4225
4226/**
4227 * Release a printing policy.
4228 */
4229CINDEX_LINKAGE void clang_PrintingPolicy_dispose(CXPrintingPolicy Policy);
4230
4231/**
4232 * Pretty print declarations.
4233 *
4234 * \param Cursor The cursor representing a declaration.
4235 *
4236 * \param Policy The policy to control the entities being printed. If
4237 * NULL, a default policy is used.
4238 *
4239 * \returns The pretty printed declaration or the empty string for
4240 * other cursors.
4241 */
4242CINDEX_LINKAGE CXString clang_getCursorPrettyPrinted(CXCursor Cursor,
4243 CXPrintingPolicy Policy);
4244
4245/**
4246 * Pretty-print the underlying type using a custom printing policy.
4247 *
4248 * If the type is invalid, an empty string is returned.
4249 */
4250CINDEX_LINKAGE CXString clang_getTypePrettyPrinted(CXType CT,
4251 CXPrintingPolicy cxPolicy);
4252
4253/**
4254 * Get the fully qualified name for a type.
4255 *
4256 * This includes full qualification of all template parameters.
4257 *
4258 * Policy - Further refine the type formatting
4259 * WithGlobalNsPrefix - If non-zero, function will prepend a '::' to qualified
4260 * names
4261 */
4262CINDEX_LINKAGE CXString clang_getFullyQualifiedName(
4263 CXType CT, CXPrintingPolicy Policy, unsigned WithGlobalNsPrefix);
4264
4265/**
4266 * Retrieve the display name for the entity referenced by this cursor.
4267 *
4268 * The display name contains extra information that helps identify the cursor,
4269 * such as the parameters of a function or template or the arguments of a
4270 * class template specialization.
4271 */
4272CINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor);
4273
4274/** For a cursor that is a reference, retrieve a cursor representing the
4275 * entity that it references.
4276 *
4277 * Reference cursors refer to other entities in the AST. For example, an
4278 * Objective-C superclass reference cursor refers to an Objective-C class.
4279 * This function produces the cursor for the Objective-C class from the
4280 * cursor for the superclass reference. If the input cursor is a declaration or
4281 * definition, it returns that declaration or definition unchanged.
4282 * Otherwise, returns the NULL cursor.
4283 */
4284CINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor);
4285
4286/**
4287 * For a cursor that is either a reference to or a declaration
4288 * of some entity, retrieve a cursor that describes the definition of
4289 * that entity.
4290 *
4291 * Some entities can be declared multiple times within a translation
4292 * unit, but only one of those declarations can also be a
4293 * definition. For example, given:
4294 *
4295 * \code
4296 * int f(int, int);
4297 * int g(int x, int y) { return f(x, y); }
4298 * int f(int a, int b) { return a + b; }
4299 * int f(int, int);
4300 * \endcode
4301 *
4302 * there are three declarations of the function "f", but only the
4303 * second one is a definition. The clang_getCursorDefinition()
4304 * function will take any cursor pointing to a declaration of "f"
4305 * (the first or fourth lines of the example) or a cursor referenced
4306 * that uses "f" (the call to "f' inside "g") and will return a
4307 * declaration cursor pointing to the definition (the second "f"
4308 * declaration).
4309 *
4310 * If given a cursor for which there is no corresponding definition,
4311 * e.g., because there is no definition of that entity within this
4312 * translation unit, returns a NULL cursor.
4313 */
4314CINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor);
4315
4316/**
4317 * Determine whether the declaration pointed to by this cursor
4318 * is also a definition of that entity.
4319 */
4320CINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor);
4321
4322/**
4323 * Retrieve the canonical cursor corresponding to the given cursor.
4324 *
4325 * In the C family of languages, many kinds of entities can be declared several
4326 * times within a single translation unit. For example, a structure type can
4327 * be forward-declared (possibly multiple times) and later defined:
4328 *
4329 * \code
4330 * struct X;
4331 * struct X;
4332 * struct X {
4333 * int member;
4334 * };
4335 * \endcode
4336 *
4337 * The declarations and the definition of \c X are represented by three
4338 * different cursors, all of which are declarations of the same underlying
4339 * entity. One of these cursor is considered the "canonical" cursor, which
4340 * is effectively the representative for the underlying entity. One can
4341 * determine if two cursors are declarations of the same underlying entity by
4342 * comparing their canonical cursors.
4343 *
4344 * \returns The canonical cursor for the entity referred to by the given cursor.
4345 */
4346CINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor);
4347
4348/**
4349 * If the cursor points to a selector identifier in an Objective-C
4350 * method or message expression, this returns the selector index.
4351 *
4352 * After getting a cursor with #clang_getCursor, this can be called to
4353 * determine if the location points to a selector identifier.
4354 *
4355 * \returns The selector index if the cursor is an Objective-C method or message
4356 * expression and the cursor is pointing to a selector identifier, or -1
4357 * otherwise.
4358 */
4359CINDEX_LINKAGE int clang_Cursor_getObjCSelectorIndex(CXCursor);
4360
4361/**
4362 * Given a cursor pointing to a C++ method call or an Objective-C
4363 * message, returns non-zero if the method/message is "dynamic", meaning:
4364 *
4365 * For a C++ method: the call is virtual.
4366 * For an Objective-C message: the receiver is an object instance, not 'super'
4367 * or a specific class.
4368 *
4369 * If the method/message is "static" or the cursor does not point to a
4370 * method/message, it will return zero.
4371 */
4372CINDEX_LINKAGE int clang_Cursor_isDynamicCall(CXCursor C);
4373
4374/**
4375 * Given a cursor pointing to an Objective-C message or property
4376 * reference, or C++ method call, returns the CXType of the receiver.
4377 */
4378CINDEX_LINKAGE CXType clang_Cursor_getReceiverType(CXCursor C);
4379
4380/**
4381 * Property attributes for a \c CXCursor_ObjCPropertyDecl.
4382 */
4383typedef enum {
4384 CXObjCPropertyAttr_noattr = 0x00,
4385 CXObjCPropertyAttr_readonly = 0x01,
4386 CXObjCPropertyAttr_getter = 0x02,
4387 CXObjCPropertyAttr_assign = 0x04,
4388 CXObjCPropertyAttr_readwrite = 0x08,
4389 CXObjCPropertyAttr_retain = 0x10,
4390 CXObjCPropertyAttr_copy = 0x20,
4391 CXObjCPropertyAttr_nonatomic = 0x40,
4392 CXObjCPropertyAttr_setter = 0x80,
4393 CXObjCPropertyAttr_atomic = 0x100,
4394 CXObjCPropertyAttr_weak = 0x200,
4395 CXObjCPropertyAttr_strong = 0x400,
4396 CXObjCPropertyAttr_unsafe_unretained = 0x800,
4397 CXObjCPropertyAttr_class = 0x1000
4398} CXObjCPropertyAttrKind;
4399
4400/**
4401 * Given a cursor that represents a property declaration, return the
4402 * associated property attributes. The bits are formed from
4403 * \c CXObjCPropertyAttrKind.
4404 *
4405 * \param reserved Reserved for future use, pass 0.
4406 */
4407CINDEX_LINKAGE unsigned
4408clang_Cursor_getObjCPropertyAttributes(CXCursor C, unsigned reserved);
4409
4410/**
4411 * Given a cursor that represents a property declaration, return the
4412 * name of the method that implements the getter.
4413 */
4414CINDEX_LINKAGE CXString clang_Cursor_getObjCPropertyGetterName(CXCursor C);
4415
4416/**
4417 * Given a cursor that represents a property declaration, return the
4418 * name of the method that implements the setter, if any.
4419 */
4420CINDEX_LINKAGE CXString clang_Cursor_getObjCPropertySetterName(CXCursor C);
4421
4422/**
4423 * 'Qualifiers' written next to the return and parameter types in
4424 * Objective-C method declarations.
4425 */
4426typedef enum {
4427 CXObjCDeclQualifier_None = 0x0,
4428 CXObjCDeclQualifier_In = 0x1,
4429 CXObjCDeclQualifier_Inout = 0x2,
4430 CXObjCDeclQualifier_Out = 0x4,
4431 CXObjCDeclQualifier_Bycopy = 0x8,
4432 CXObjCDeclQualifier_Byref = 0x10,
4433 CXObjCDeclQualifier_Oneway = 0x20
4434} CXObjCDeclQualifierKind;
4435
4436/**
4437 * Given a cursor that represents an Objective-C method or parameter
4438 * declaration, return the associated Objective-C qualifiers for the return
4439 * type or the parameter respectively. The bits are formed from
4440 * CXObjCDeclQualifierKind.
4441 */
4442CINDEX_LINKAGE unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C);
4443
4444/**
4445 * Given a cursor that represents an Objective-C method or property
4446 * declaration, return non-zero if the declaration was affected by "\@optional".
4447 * Returns zero if the cursor is not such a declaration or it is "\@required".
4448 */
4449CINDEX_LINKAGE unsigned clang_Cursor_isObjCOptional(CXCursor C);
4450
4451/**
4452 * Returns non-zero if the given cursor is a variadic function or method.
4453 */
4454CINDEX_LINKAGE unsigned clang_Cursor_isVariadic(CXCursor C);
4455
4456/**
4457 * Returns non-zero if the given cursor points to a symbol marked with
4458 * external_source_symbol attribute.
4459 *
4460 * \param language If non-NULL, and the attribute is present, will be set to
4461 * the 'language' string from the attribute.
4462 *
4463 * \param definedIn If non-NULL, and the attribute is present, will be set to
4464 * the 'definedIn' string from the attribute.
4465 *
4466 * \param isGenerated If non-NULL, and the attribute is present, will be set to
4467 * non-zero if the 'generated_declaration' is set in the attribute.
4468 */
4469CINDEX_LINKAGE unsigned clang_Cursor_isExternalSymbol(CXCursor C,
4470 CXString *language,
4471 CXString *definedIn,
4472 unsigned *isGenerated);
4473
4474/**
4475 * Given a cursor that represents a declaration, return the associated
4476 * comment's source range. The range may include multiple consecutive comments
4477 * with whitespace in between.
4478 */
4479CINDEX_LINKAGE CXSourceRange clang_Cursor_getCommentRange(CXCursor C);
4480
4481/**
4482 * Given a cursor that represents a declaration, return the associated
4483 * comment text, including comment markers.
4484 */
4485CINDEX_LINKAGE CXString clang_Cursor_getRawCommentText(CXCursor C);
4486
4487/**
4488 * Given a cursor that represents a documentable entity (e.g.,
4489 * declaration), return the associated \paragraph; otherwise return the
4490 * first paragraph.
4491 */
4492CINDEX_LINKAGE CXString clang_Cursor_getBriefCommentText(CXCursor C);
4493
4494/**
4495 * @}
4496 */
4497
4498/** \defgroup CINDEX_MANGLE Name Mangling API Functions
4499 *
4500 * @{
4501 */
4502
4503/**
4504 * Retrieve the CXString representing the mangled name of the cursor.
4505 */
4506CINDEX_LINKAGE CXString clang_Cursor_getMangling(CXCursor);
4507
4508/**
4509 * Retrieve the CXStrings representing the mangled symbols of the C++
4510 * constructor or destructor at the cursor.
4511 */
4512CINDEX_LINKAGE CXStringSet *clang_Cursor_getCXXManglings(CXCursor);
4513
4514/**
4515 * Retrieve the CXStrings representing the mangled symbols of the ObjC
4516 * class interface or implementation at the cursor.
4517 */
4518CINDEX_LINKAGE CXStringSet *clang_Cursor_getObjCManglings(CXCursor);
4519
4520/**
4521 * @}
4522 */
4523
4524/**
4525 * \defgroup CINDEX_MODULE Inline Assembly introspection
4526 *
4527 * The functions in this group provide access to information about GCC-style
4528 * inline assembly statements.
4529 *
4530 * @{
4531 */
4532
4533/**
4534 * Given a CXCursor_GCCAsmStmt cursor, return the assembly template string.
4535 * As per LLVM IR Assembly Template language, template placeholders for
4536 * inputs and outputs are either of the form $N where N is a decimal number
4537 * as an index into the input-output specification,
4538 * or ${N:M} where N is a decimal number also as an index into the
4539 * input-output specification and M is the template argument modifier.
4540 * The index N in both cases points into the the total inputs and outputs,
4541 * or more specifically, into the list of outputs followed by the inputs,
4542 * starting from index 0 as the first available template argument.
4543 *
4544 * This function also returns a valid empty string if the cursor does not point
4545 * at a GCC inline assembly block.
4546 *
4547 * Users are responsible for releasing the allocation of returned string via
4548 * \c clang_disposeString.
4549 */
4550
4551CINDEX_LINKAGE CXString clang_Cursor_getGCCAssemblyTemplate(CXCursor);
4552
4553/**
4554 * Given a CXCursor_GCCAsmStmt cursor, check if the assembly block has goto
4555 * labels.
4556 * This function also returns 0 if the cursor does not point at a GCC inline
4557 * assembly block.
4558 */
4559
4560CINDEX_LINKAGE unsigned clang_Cursor_isGCCAssemblyHasGoto(CXCursor);
4561
4562/**
4563 * Given a CXCursor_GCCAsmStmt cursor, count the number of outputs.
4564 * This function also returns 0 if the cursor does not point at a GCC inline
4565 * assembly block.
4566 */
4567
4568CINDEX_LINKAGE unsigned clang_Cursor_getGCCAssemblyNumOutputs(CXCursor);
4569
4570/**
4571 * Given a CXCursor_GCCAsmStmt cursor, count the number of inputs.
4572 * This function also returns 0 if the cursor does not point at a GCC inline
4573 * assembly block.
4574 */
4575
4576CINDEX_LINKAGE unsigned clang_Cursor_getGCCAssemblyNumInputs(CXCursor);
4577
4578/**
4579 * Given a CXCursor_GCCAsmStmt cursor, get the constraint and expression cursor
4580 * to the Index-th input.
4581 * This function returns 1 when the cursor points at a GCC inline assembly
4582 * statement, `Index` is within bounds and both the `Constraint` and `Expr` are
4583 * not NULL.
4584 * Otherwise, this function returns 0 but leaves `Constraint` and `Expr`
4585 * intact.
4586 *
4587 * Users are responsible for releasing the allocation of `Constraint` via
4588 * \c clang_disposeString.
4589 */
4590
4591CINDEX_LINKAGE unsigned clang_Cursor_getGCCAssemblyInput(CXCursor Cursor,
4592 unsigned Index,
4593 CXString *Constraint,
4594 CXCursor *Expr);
4595
4596/**
4597 * Given a CXCursor_GCCAsmStmt cursor, get the constraint and expression cursor
4598 * to the Index-th output.
4599 * This function returns 1 when the cursor points at a GCC inline assembly
4600 * statement, `Index` is within bounds and both the `Constraint` and `Expr` are
4601 * not NULL.
4602 * Otherwise, this function returns 0 but leaves `Constraint` and `Expr`
4603 * intact.
4604 *
4605 * Users are responsible for releasing the allocation of `Constraint` via
4606 * \c clang_disposeString.
4607 */
4608
4609CINDEX_LINKAGE unsigned clang_Cursor_getGCCAssemblyOutput(CXCursor Cursor,
4610 unsigned Index,
4611 CXString *Constraint,
4612 CXCursor *Expr);
4613
4614/**
4615 * Given a CXCursor_GCCAsmStmt cursor, count the clobbers in it.
4616 * This function also returns 0 if the cursor does not point at a GCC inline
4617 * assembly block.
4618 */
4619
4620CINDEX_LINKAGE unsigned clang_Cursor_getGCCAssemblyNumClobbers(CXCursor Cursor);
4621
4622/**
4623 * Given a CXCursor_GCCAsmStmt cursor, get the Index-th clobber of it.
4624 * This function returns a valid empty string if the cursor does not point
4625 * at a GCC inline assembly block or `Index` is out of bounds.
4626 *
4627 * Users are responsible for releasing the allocation of returned string via
4628 * \c clang_disposeString.
4629 */
4630
4631CINDEX_LINKAGE CXString clang_Cursor_getGCCAssemblyClobber(CXCursor Cursor,
4632 unsigned Index);
4633
4634/**
4635 * Given a CXCursor_GCCAsmStmt cursor, check if the inline assembly is
4636 * `volatile`.
4637 * This function returns 0 if the cursor does not point at a GCC inline
4638 * assembly block.
4639 */
4640
4641CINDEX_LINKAGE unsigned clang_Cursor_isGCCAssemblyVolatile(CXCursor Cursor);
4642
4643/**
4644 * @}
4645 */
4646
4647/**
4648 * \defgroup CINDEX_MODULE Module introspection
4649 *
4650 * The functions in this group provide access to information about modules.
4651 *
4652 * @{
4653 */
4654
4655typedef void *CXModule;
4656
4657/**
4658 * Given a CXCursor_ModuleImportDecl cursor, return the associated module.
4659 */
4660CINDEX_LINKAGE CXModule clang_Cursor_getModule(CXCursor C);
4661
4662/**
4663 * Given a CXFile header file, return the module that contains it, if one
4664 * exists.
4665 */
4666CINDEX_LINKAGE CXModule clang_getModuleForFile(CXTranslationUnit, CXFile);
4667
4668/**
4669 * \param Module a module object.
4670 *
4671 * \returns the module file where the provided module object came from.
4672 *
4673 * @deprecated: module files are longer guaranteed to be loaded from a CXFile
4674 */
4675CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module);
4676
4677/**
4678 * \param Module a module object.
4679 *
4680 * \returns the parent of a sub-module or NULL if the given module is top-level,
4681 * e.g. for 'std.vector' it will return the 'std' module.
4682 */
4683CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module);
4684
4685/**
4686 * \param Module a module object.
4687 *
4688 * \returns the name of the module, e.g. for the 'std.vector' sub-module it
4689 * will return "vector".
4690 */
4691CINDEX_LINKAGE CXString clang_Module_getName(CXModule Module);
4692
4693/**
4694 * \param Module a module object.
4695 *
4696 * \returns the full name of the module, e.g. "std.vector".
4697 */
4698CINDEX_LINKAGE CXString clang_Module_getFullName(CXModule Module);
4699
4700/**
4701 * \param Module a module object.
4702 *
4703 * \returns non-zero if the module is a system one.
4704 */
4705CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module);
4706
4707/**
4708 * \param Module a module object.
4709 *
4710 * \returns the number of top level headers associated with this module.
4711 */
4712CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit,
4713 CXModule Module);
4714
4715/**
4716 * \param Module a module object.
4717 *
4718 * \param Index top level header index (zero-based).
4719 *
4720 * \returns the specified top level header associated with the module.
4721 */
4722CINDEX_LINKAGE
4723CXFile clang_Module_getTopLevelHeader(CXTranslationUnit, CXModule Module,
4724 unsigned Index);
4725
4726/**
4727 * @}
4728 */
4729
4730/**
4731 * \defgroup CINDEX_CPP C++ AST introspection
4732 *
4733 * The routines in this group provide access information in the ASTs specific
4734 * to C++ language features.
4735 *
4736 * @{
4737 */
4738
4739/**
4740 * Determine if a C++ constructor is a converting constructor.
4741 */
4742CINDEX_LINKAGE unsigned
4743clang_CXXConstructor_isConvertingConstructor(CXCursor C);
4744
4745/**
4746 * Determine if a C++ constructor is a copy constructor.
4747 */
4748CINDEX_LINKAGE unsigned clang_CXXConstructor_isCopyConstructor(CXCursor C);
4749
4750/**
4751 * Determine if a C++ constructor is the default constructor.
4752 */
4753CINDEX_LINKAGE unsigned clang_CXXConstructor_isDefaultConstructor(CXCursor C);
4754
4755/**
4756 * Determine if a C++ constructor is a move constructor.
4757 */
4758CINDEX_LINKAGE unsigned clang_CXXConstructor_isMoveConstructor(CXCursor C);
4759
4760/**
4761 * Determine if a C++ field is declared 'mutable'.
4762 */
4763CINDEX_LINKAGE unsigned clang_CXXField_isMutable(CXCursor C);
4764
4765/**
4766 * Determine if a C++ method is declared '= default'.
4767 */
4768CINDEX_LINKAGE unsigned clang_CXXMethod_isDefaulted(CXCursor C);
4769
4770/**
4771 * Determine if a C++ method is declared '= delete'.
4772 */
4773CINDEX_LINKAGE unsigned clang_CXXMethod_isDeleted(CXCursor C);
4774
4775/**
4776 * Determine if a C++ member function or member function template is
4777 * pure virtual.
4778 */
4779CINDEX_LINKAGE unsigned clang_CXXMethod_isPureVirtual(CXCursor C);
4780
4781/**
4782 * Determine if a C++ member function or member function template is
4783 * declared 'static'.
4784 */
4785CINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C);
4786
4787/**
4788 * Determine if a C++ member function or member function template is
4789 * explicitly declared 'virtual' or if it overrides a virtual method from
4790 * one of the base classes.
4791 */
4792CINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C);
4793
4794/**
4795 * Determine if a C++ member function is a copy-assignment operator,
4796 * returning 1 if such is the case and 0 otherwise.
4797 *
4798 * > A copy-assignment operator `X::operator=` is a non-static,
4799 * > non-template member function of _class_ `X` with exactly one
4800 * > parameter of type `X`, `X&`, `const X&`, `volatile X&` or `const
4801 * > volatile X&`.
4802 *
4803 * That is, for example, the `operator=` in:
4804 *
4805 * class Foo {
4806 * bool operator=(const volatile Foo&);
4807 * };
4808 *
4809 * Is a copy-assignment operator, while the `operator=` in:
4810 *
4811 * class Bar {
4812 * bool operator=(const int&);
4813 * };
4814 *
4815 * Is not.
4816 */
4817CINDEX_LINKAGE unsigned clang_CXXMethod_isCopyAssignmentOperator(CXCursor C);
4818
4819/**
4820 * Determine if a C++ member function is a move-assignment operator,
4821 * returning 1 if such is the case and 0 otherwise.
4822 *
4823 * > A move-assignment operator `X::operator=` is a non-static,
4824 * > non-template member function of _class_ `X` with exactly one
4825 * > parameter of type `X&&`, `const X&&`, `volatile X&&` or `const
4826 * > volatile X&&`.
4827 *
4828 * That is, for example, the `operator=` in:
4829 *
4830 * class Foo {
4831 * bool operator=(const volatile Foo&&);
4832 * };
4833 *
4834 * Is a move-assignment operator, while the `operator=` in:
4835 *
4836 * class Bar {
4837 * bool operator=(const int&&);
4838 * };
4839 *
4840 * Is not.
4841 */
4842CINDEX_LINKAGE unsigned clang_CXXMethod_isMoveAssignmentOperator(CXCursor C);
4843
4844/**
4845 * Determines if a C++ constructor or conversion function was declared
4846 * explicit, returning 1 if such is the case and 0 otherwise.
4847 *
4848 * Constructors or conversion functions are declared explicit through
4849 * the use of the explicit specifier.
4850 *
4851 * For example, the following constructor and conversion function are
4852 * not explicit as they lack the explicit specifier:
4853 *
4854 * class Foo {
4855 * Foo();
4856 * operator int();
4857 * };
4858 *
4859 * While the following constructor and conversion function are
4860 * explicit as they are declared with the explicit specifier.
4861 *
4862 * class Foo {
4863 * explicit Foo();
4864 * explicit operator int();
4865 * };
4866 *
4867 * This function will return 0 when given a cursor pointing to one of
4868 * the former declarations and it will return 1 for a cursor pointing
4869 * to the latter declarations.
4870 *
4871 * The explicit specifier allows the user to specify a
4872 * conditional compile-time expression whose value decides
4873 * whether the marked element is explicit or not.
4874 *
4875 * For example:
4876 *
4877 * constexpr bool foo(int i) { return i % 2 == 0; }
4878 *
4879 * class Foo {
4880 * explicit(foo(1)) Foo();
4881 * explicit(foo(2)) operator int();
4882 * }
4883 *
4884 * This function will return 0 for the constructor and 1 for
4885 * the conversion function.
4886 */
4887CINDEX_LINKAGE unsigned clang_CXXMethod_isExplicit(CXCursor C);
4888
4889/**
4890 * Determine if a C++ record is abstract, i.e. whether a class or struct
4891 * has a pure virtual member function.
4892 */
4893CINDEX_LINKAGE unsigned clang_CXXRecord_isAbstract(CXCursor C);
4894
4895/**
4896 * Determine if an enum declaration refers to a scoped enum.
4897 */
4898CINDEX_LINKAGE unsigned clang_EnumDecl_isScoped(CXCursor C);
4899
4900/**
4901 * Determine if a C++ member function or member function template is
4902 * declared 'const'.
4903 */
4904CINDEX_LINKAGE unsigned clang_CXXMethod_isConst(CXCursor C);
4905
4906/**
4907 * Given a cursor that represents a template, determine
4908 * the cursor kind of the specializations would be generated by instantiating
4909 * the template.
4910 *
4911 * This routine can be used to determine what flavor of function template,
4912 * class template, or class template partial specialization is stored in the
4913 * cursor. For example, it can describe whether a class template cursor is
4914 * declared with "struct", "class" or "union".
4915 *
4916 * \param C The cursor to query. This cursor should represent a template
4917 * declaration.
4918 *
4919 * \returns The cursor kind of the specializations that would be generated
4920 * by instantiating the template \p C. If \p C is not a template, returns
4921 * \c CXCursor_NoDeclFound.
4922 */
4923CINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C);
4924
4925/**
4926 * Given a cursor that may represent a specialization or instantiation
4927 * of a template, retrieve the cursor that represents the template that it
4928 * specializes or from which it was instantiated.
4929 *
4930 * This routine determines the template involved both for explicit
4931 * specializations of templates and for implicit instantiations of the template,
4932 * both of which are referred to as "specializations". For a class template
4933 * specialization (e.g., \c std::vector<bool>), this routine will return
4934 * either the primary template (\c std::vector) or, if the specialization was
4935 * instantiated from a class template partial specialization, the class template
4936 * partial specialization. For a class template partial specialization and a
4937 * function template specialization (including instantiations), this
4938 * this routine will return the specialized template.
4939 *
4940 * For members of a class template (e.g., member functions, member classes, or
4941 * static data members), returns the specialized or instantiated member.
4942 * Although not strictly "templates" in the C++ language, members of class
4943 * templates have the same notions of specializations and instantiations that
4944 * templates do, so this routine treats them similarly.
4945 *
4946 * \param C A cursor that may be a specialization of a template or a member
4947 * of a template.
4948 *
4949 * \returns If the given cursor is a specialization or instantiation of a
4950 * template or a member thereof, the template or member that it specializes or
4951 * from which it was instantiated. Otherwise, returns a NULL cursor.
4952 */
4953CINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C);
4954
4955/**
4956 * Given a cursor that references something else, return the source range
4957 * covering that reference.
4958 *
4959 * \param C A cursor pointing to a member reference, a declaration reference, or
4960 * an operator call.
4961 * \param NameFlags A bitset with three independent flags:
4962 * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
4963 * CXNameRange_WantSinglePiece.
4964 * \param PieceIndex For contiguous names or when passing the flag
4965 * CXNameRange_WantSinglePiece, only one piece with index 0 is
4966 * available. When the CXNameRange_WantSinglePiece flag is not passed for a
4967 * non-contiguous names, this index can be used to retrieve the individual
4968 * pieces of the name. See also CXNameRange_WantSinglePiece.
4969 *
4970 * \returns The piece of the name pointed to by the given cursor. If there is no
4971 * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
4972 */
4973CINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(
4974 CXCursor C, unsigned NameFlags, unsigned PieceIndex);
4975
4976enum CXNameRefFlags {
4977 /**
4978 * Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
4979 * range.
4980 */
4981 CXNameRange_WantQualifier = 0x1,
4982
4983 /**
4984 * Include the explicit template arguments, e.g. \<int> in x.f<int>,
4985 * in the range.
4986 */
4987 CXNameRange_WantTemplateArgs = 0x2,
4988
4989 /**
4990 * If the name is non-contiguous, return the full spanning range.
4991 *
4992 * Non-contiguous names occur in Objective-C when a selector with two or more
4993 * parameters is used, or in C++ when using an operator:
4994 * \code
4995 * [object doSomething:here withValue:there]; // Objective-C
4996 * return some_vector[1]; // C++
4997 * \endcode
4998 */
4999 CXNameRange_WantSinglePiece = 0x4
5000};
5001
5002/**
5003 * @}
5004 */
5005
5006/**
5007 * \defgroup CINDEX_LEX Token extraction and manipulation
5008 *
5009 * The routines in this group provide access to the tokens within a
5010 * translation unit, along with a semantic mapping of those tokens to
5011 * their corresponding cursors.
5012 *
5013 * @{
5014 */
5015
5016/**
5017 * Describes a kind of token.
5018 */
5019typedef enum CXTokenKind {
5020 /**
5021 * A token that contains some kind of punctuation.
5022 */
5023 CXToken_Punctuation,
5024
5025 /**
5026 * A language keyword.
5027 */
5028 CXToken_Keyword,
5029
5030 /**
5031 * An identifier (that is not a keyword).
5032 */
5033 CXToken_Identifier,
5034
5035 /**
5036 * A numeric, string, or character literal.
5037 */
5038 CXToken_Literal,
5039
5040 /**
5041 * A comment.
5042 */
5043 CXToken_Comment
5044} CXTokenKind;
5045
5046/**
5047 * Describes a single preprocessing token.
5048 */
5049typedef struct {
5050 unsigned int_data[4];
5051 void *ptr_data;
5052} CXToken;
5053
5054/**
5055 * Get the raw lexical token starting with the given location.
5056 *
5057 * \param TU the translation unit whose text is being tokenized.
5058 *
5059 * \param Location the source location with which the token starts.
5060 *
5061 * \returns The token starting with the given location or NULL if no such token
5062 * exist. The returned pointer must be freed with clang_disposeTokens before the
5063 * translation unit is destroyed.
5064 */
5065CINDEX_LINKAGE CXToken *clang_getToken(CXTranslationUnit TU,
5066 CXSourceLocation Location);
5067
5068/**
5069 * Determine the kind of the given token.
5070 */
5071CINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken);
5072
5073/**
5074 * Determine the spelling of the given token.
5075 *
5076 * The spelling of a token is the textual representation of that token, e.g.,
5077 * the text of an identifier or keyword.
5078 */
5079CINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken);
5080
5081/**
5082 * Retrieve the source location of the given token.
5083 */
5084CINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit,
5085 CXToken);
5086
5087/**
5088 * Retrieve a source range that covers the given token.
5089 */
5090CINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken);
5091
5092/**
5093 * Tokenize the source code described by the given range into raw
5094 * lexical tokens.
5095 *
5096 * \param TU the translation unit whose text is being tokenized.
5097 *
5098 * \param Range the source range in which text should be tokenized. All of the
5099 * tokens produced by tokenization will fall within this source range,
5100 *
5101 * \param Tokens this pointer will be set to point to the array of tokens
5102 * that occur within the given source range. The returned pointer must be
5103 * freed with clang_disposeTokens() before the translation unit is destroyed.
5104 *
5105 * \param NumTokens will be set to the number of tokens in the \c *Tokens
5106 * array.
5107 *
5108 */
5109CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
5110 CXToken **Tokens, unsigned *NumTokens);
5111
5112/**
5113 * Annotate the given set of tokens by providing cursors for each token
5114 * that can be mapped to a specific entity within the abstract syntax tree.
5115 *
5116 * This token-annotation routine is equivalent to invoking
5117 * clang_getCursor() for the source locations of each of the
5118 * tokens. The cursors provided are filtered, so that only those
5119 * cursors that have a direct correspondence to the token are
5120 * accepted. For example, given a function call \c f(x),
5121 * clang_getCursor() would provide the following cursors:
5122 *
5123 * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
5124 * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
5125 * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
5126 *
5127 * Only the first and last of these cursors will occur within the
5128 * annotate, since the tokens "f" and "x' directly refer to a function
5129 * and a variable, respectively, but the parentheses are just a small
5130 * part of the full syntax of the function call expression, which is
5131 * not provided as an annotation.
5132 *
5133 * \param TU the translation unit that owns the given tokens.
5134 *
5135 * \param Tokens the set of tokens to annotate.
5136 *
5137 * \param NumTokens the number of tokens in \p Tokens.
5138 *
5139 * \param Cursors an array of \p NumTokens cursors, whose contents will be
5140 * replaced with the cursors corresponding to each token.
5141 */
5142CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU, CXToken *Tokens,
5143 unsigned NumTokens, CXCursor *Cursors);
5144
5145/**
5146 * Free the given set of tokens.
5147 */
5148CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU, CXToken *Tokens,
5149 unsigned NumTokens);
5150
5151/**
5152 * @}
5153 */
5154
5155/**
5156 * \defgroup CINDEX_DEBUG Debugging facilities
5157 *
5158 * These routines are used for testing and debugging, only, and should not
5159 * be relied upon.
5160 *
5161 * @{
5162 */
5163
5164/* for debug/testing */
5165CINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind);
5166CINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(
5167 CXCursor, const char **startBuf, const char **endBuf, unsigned *startLine,
5168 unsigned *startColumn, unsigned *endLine, unsigned *endColumn);
5169CINDEX_LINKAGE void clang_enableStackTraces(void);
5170CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void *), void *user_data,
5171 unsigned stack_size);
5172
5173/**
5174 * @}
5175 */
5176
5177/**
5178 * \defgroup CINDEX_CODE_COMPLET Code completion
5179 *
5180 * Code completion involves taking an (incomplete) source file, along with
5181 * knowledge of where the user is actively editing that file, and suggesting
5182 * syntactically- and semantically-valid constructs that the user might want to
5183 * use at that particular point in the source code. These data structures and
5184 * routines provide support for code completion.
5185 *
5186 * @{
5187 */
5188
5189/**
5190 * A semantic string that describes a code-completion result.
5191 *
5192 * A semantic string that describes the formatting of a code-completion
5193 * result as a single "template" of text that should be inserted into the
5194 * source buffer when a particular code-completion result is selected.
5195 * Each semantic string is made up of some number of "chunks", each of which
5196 * contains some text along with a description of what that text means, e.g.,
5197 * the name of the entity being referenced, whether the text chunk is part of
5198 * the template, or whether it is a "placeholder" that the user should replace
5199 * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
5200 * description of the different kinds of chunks.
5201 */
5202typedef void *CXCompletionString;
5203
5204/**
5205 * A single result of code completion.
5206 */
5207typedef struct {
5208 /**
5209 * The kind of entity that this completion refers to.
5210 *
5211 * The cursor kind will be a macro, keyword, or a declaration (one of the
5212 * *Decl cursor kinds), describing the entity that the completion is
5213 * referring to.
5214 *
5215 * \todo In the future, we would like to provide a full cursor, to allow
5216 * the client to extract additional information from declaration.
5217 */
5218 enum CXCursorKind CursorKind;
5219
5220 /**
5221 * The code-completion string that describes how to insert this
5222 * code-completion result into the editing buffer.
5223 */
5224 CXCompletionString CompletionString;
5225} CXCompletionResult;
5226
5227/**
5228 * Describes a single piece of text within a code-completion string.
5229 *
5230 * Each "chunk" within a code-completion string (\c CXCompletionString) is
5231 * either a piece of text with a specific "kind" that describes how that text
5232 * should be interpreted by the client or is another completion string.
5233 */
5234enum CXCompletionChunkKind {
5235 /**
5236 * A code-completion string that describes "optional" text that
5237 * could be a part of the template (but is not required).
5238 *
5239 * The Optional chunk is the only kind of chunk that has a code-completion
5240 * string for its representation, which is accessible via
5241 * \c clang_getCompletionChunkCompletionString(). The code-completion string
5242 * describes an additional part of the template that is completely optional.
5243 * For example, optional chunks can be used to describe the placeholders for
5244 * arguments that match up with defaulted function parameters, e.g. given:
5245 *
5246 * \code
5247 * void f(int x, float y = 3.14, double z = 2.71828);
5248 * \endcode
5249 *
5250 * The code-completion string for this function would contain:
5251 * - a TypedText chunk for "f".
5252 * - a LeftParen chunk for "(".
5253 * - a Placeholder chunk for "int x"
5254 * - an Optional chunk containing the remaining defaulted arguments, e.g.,
5255 * - a Comma chunk for ","
5256 * - a Placeholder chunk for "float y"
5257 * - an Optional chunk containing the last defaulted argument:
5258 * - a Comma chunk for ","
5259 * - a Placeholder chunk for "double z"
5260 * - a RightParen chunk for ")"
5261 *
5262 * There are many ways to handle Optional chunks. Two simple approaches are:
5263 * - Completely ignore optional chunks, in which case the template for the
5264 * function "f" would only include the first parameter ("int x").
5265 * - Fully expand all optional chunks, in which case the template for the
5266 * function "f" would have all of the parameters.
5267 */
5268 CXCompletionChunk_Optional,
5269 /**
5270 * Text that a user would be expected to type to get this
5271 * code-completion result.
5272 *
5273 * There will be exactly one "typed text" chunk in a semantic string, which
5274 * will typically provide the spelling of a keyword or the name of a
5275 * declaration that could be used at the current code point. Clients are
5276 * expected to filter the code-completion results based on the text in this
5277 * chunk.
5278 */
5279 CXCompletionChunk_TypedText,
5280 /**
5281 * Text that should be inserted as part of a code-completion result.
5282 *
5283 * A "text" chunk represents text that is part of the template to be
5284 * inserted into user code should this particular code-completion result
5285 * be selected.
5286 */
5287 CXCompletionChunk_Text,
5288 /**
5289 * Placeholder text that should be replaced by the user.
5290 *
5291 * A "placeholder" chunk marks a place where the user should insert text
5292 * into the code-completion template. For example, placeholders might mark
5293 * the function parameters for a function declaration, to indicate that the
5294 * user should provide arguments for each of those parameters. The actual
5295 * text in a placeholder is a suggestion for the text to display before
5296 * the user replaces the placeholder with real code.
5297 */
5298 CXCompletionChunk_Placeholder,
5299 /**
5300 * Informative text that should be displayed but never inserted as
5301 * part of the template.
5302 *
5303 * An "informative" chunk contains annotations that can be displayed to
5304 * help the user decide whether a particular code-completion result is the
5305 * right option, but which is not part of the actual template to be inserted
5306 * by code completion.
5307 */
5308 CXCompletionChunk_Informative,
5309 /**
5310 * Text that describes the current parameter when code-completion is
5311 * referring to function call, message send, or template specialization.
5312 *
5313 * A "current parameter" chunk occurs when code-completion is providing
5314 * information about a parameter corresponding to the argument at the
5315 * code-completion point. For example, given a function
5316 *
5317 * \code
5318 * int add(int x, int y);
5319 * \endcode
5320 *
5321 * and the source code \c add(, where the code-completion point is after the
5322 * "(", the code-completion string will contain a "current parameter" chunk
5323 * for "int x", indicating that the current argument will initialize that
5324 * parameter. After typing further, to \c add(17, (where the code-completion
5325 * point is after the ","), the code-completion string will contain a
5326 * "current parameter" chunk to "int y".
5327 */
5328 CXCompletionChunk_CurrentParameter,
5329 /**
5330 * A left parenthesis ('('), used to initiate a function call or
5331 * signal the beginning of a function parameter list.
5332 */
5333 CXCompletionChunk_LeftParen,
5334 /**
5335 * A right parenthesis (')'), used to finish a function call or
5336 * signal the end of a function parameter list.
5337 */
5338 CXCompletionChunk_RightParen,
5339 /**
5340 * A left bracket ('[').
5341 */
5342 CXCompletionChunk_LeftBracket,
5343 /**
5344 * A right bracket (']').
5345 */
5346 CXCompletionChunk_RightBracket,
5347 /**
5348 * A left brace ('{').
5349 */
5350 CXCompletionChunk_LeftBrace,
5351 /**
5352 * A right brace ('}').
5353 */
5354 CXCompletionChunk_RightBrace,
5355 /**
5356 * A left angle bracket ('<').
5357 */
5358 CXCompletionChunk_LeftAngle,
5359 /**
5360 * A right angle bracket ('>').
5361 */
5362 CXCompletionChunk_RightAngle,
5363 /**
5364 * A comma separator (',').
5365 */
5366 CXCompletionChunk_Comma,
5367 /**
5368 * Text that specifies the result type of a given result.
5369 *
5370 * This special kind of informative chunk is not meant to be inserted into
5371 * the text buffer. Rather, it is meant to illustrate the type that an
5372 * expression using the given completion string would have.
5373 */
5374 CXCompletionChunk_ResultType,
5375 /**
5376 * A colon (':').
5377 */
5378 CXCompletionChunk_Colon,
5379 /**
5380 * A semicolon (';').
5381 */
5382 CXCompletionChunk_SemiColon,
5383 /**
5384 * An '=' sign.
5385 */
5386 CXCompletionChunk_Equal,
5387 /**
5388 * Horizontal space (' ').
5389 */
5390 CXCompletionChunk_HorizontalSpace,
5391 /**
5392 * Vertical space ('\\n'), after which it is generally a good idea to
5393 * perform indentation.
5394 */
5395 CXCompletionChunk_VerticalSpace
5396};
5397
5398/**
5399 * Determine the kind of a particular chunk within a completion string.
5400 *
5401 * \param completion_string the completion string to query.
5402 *
5403 * \param chunk_number the 0-based index of the chunk in the completion string.
5404 *
5405 * \returns the kind of the chunk at the index \c chunk_number.
5406 */
5407CINDEX_LINKAGE enum CXCompletionChunkKind
5408clang_getCompletionChunkKind(CXCompletionString completion_string,
5409 unsigned chunk_number);
5410
5411/**
5412 * Retrieve the text associated with a particular chunk within a
5413 * completion string.
5414 *
5415 * \param completion_string the completion string to query.
5416 *
5417 * \param chunk_number the 0-based index of the chunk in the completion string.
5418 *
5419 * \returns the text associated with the chunk at index \c chunk_number.
5420 */
5421CINDEX_LINKAGE CXString clang_getCompletionChunkText(
5422 CXCompletionString completion_string, unsigned chunk_number);
5423
5424/**
5425 * Retrieve the completion string associated with a particular chunk
5426 * within a completion string.
5427 *
5428 * \param completion_string the completion string to query.
5429 *
5430 * \param chunk_number the 0-based index of the chunk in the completion string.
5431 *
5432 * \returns the completion string associated with the chunk at index
5433 * \c chunk_number.
5434 */
5435CINDEX_LINKAGE CXCompletionString clang_getCompletionChunkCompletionString(
5436 CXCompletionString completion_string, unsigned chunk_number);
5437
5438/**
5439 * Retrieve the number of chunks in the given code-completion string.
5440 */
5441CINDEX_LINKAGE unsigned
5442clang_getNumCompletionChunks(CXCompletionString completion_string);
5443
5444/**
5445 * Determine the priority of this code completion.
5446 *
5447 * The priority of a code completion indicates how likely it is that this
5448 * particular completion is the completion that the user will select. The
5449 * priority is selected by various internal heuristics.
5450 *
5451 * \param completion_string The completion string to query.
5452 *
5453 * \returns The priority of this completion string. Smaller values indicate
5454 * higher-priority (more likely) completions.
5455 */
5456CINDEX_LINKAGE unsigned
5457clang_getCompletionPriority(CXCompletionString completion_string);
5458
5459/**
5460 * Determine the availability of the entity that this code-completion
5461 * string refers to.
5462 *
5463 * \param completion_string The completion string to query.
5464 *
5465 * \returns The availability of the completion string.
5466 */
5467CINDEX_LINKAGE enum CXAvailabilityKind
5468clang_getCompletionAvailability(CXCompletionString completion_string);
5469
5470/**
5471 * Retrieve the number of annotations associated with the given
5472 * completion string.
5473 *
5474 * \param completion_string the completion string to query.
5475 *
5476 * \returns the number of annotations associated with the given completion
5477 * string.
5478 */
5479CINDEX_LINKAGE unsigned
5480clang_getCompletionNumAnnotations(CXCompletionString completion_string);
5481
5482/**
5483 * Retrieve the annotation associated with the given completion string.
5484 *
5485 * \param completion_string the completion string to query.
5486 *
5487 * \param annotation_number the 0-based index of the annotation of the
5488 * completion string.
5489 *
5490 * \returns annotation string associated with the completion at index
5491 * \c annotation_number, or a NULL string if that annotation is not available.
5492 */
5493CINDEX_LINKAGE CXString clang_getCompletionAnnotation(
5494 CXCompletionString completion_string, unsigned annotation_number);
5495
5496/**
5497 * Retrieve the parent context of the given completion string.
5498 *
5499 * The parent context of a completion string is the semantic parent of
5500 * the declaration (if any) that the code completion represents. For example,
5501 * a code completion for an Objective-C method would have the method's class
5502 * or protocol as its context.
5503 *
5504 * \param completion_string The code completion string whose parent is
5505 * being queried.
5506 *
5507 * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
5508 *
5509 * \returns The name of the completion parent, e.g., "NSObject" if
5510 * the completion string represents a method in the NSObject class.
5511 */
5512CINDEX_LINKAGE CXString clang_getCompletionParent(
5513 CXCompletionString completion_string, enum CXCursorKind *kind);
5514
5515/**
5516 * Retrieve the brief documentation comment attached to the declaration
5517 * that corresponds to the given completion string.
5518 */
5519CINDEX_LINKAGE CXString
5520clang_getCompletionBriefComment(CXCompletionString completion_string);
5521
5522/**
5523 * Retrieve a completion string for an arbitrary declaration or macro
5524 * definition cursor.
5525 *
5526 * \param cursor The cursor to query.
5527 *
5528 * \returns A non-context-sensitive completion string for declaration and macro
5529 * definition cursors, or NULL for other kinds of cursors.
5530 */
5531CINDEX_LINKAGE CXCompletionString
5532clang_getCursorCompletionString(CXCursor cursor);
5533
5534/**
5535 * Contains the results of code-completion.
5536 *
5537 * This data structure contains the results of code completion, as
5538 * produced by \c clang_codeCompleteAt(). Its contents must be freed by
5539 * \c clang_disposeCodeCompleteResults.
5540 */
5541typedef struct {
5542 /**
5543 * The code-completion results.
5544 */
5545 CXCompletionResult *Results;
5546
5547 /**
5548 * The number of code-completion results stored in the
5549 * \c Results array.
5550 */
5551 unsigned NumResults;
5552} CXCodeCompleteResults;
5553
5554/**
5555 * Retrieve the number of fix-its for the given completion index.
5556 *
5557 * Calling this makes sense only if CXCodeComplete_IncludeCompletionsWithFixIts
5558 * option was set.
5559 *
5560 * \param results The structure keeping all completion results
5561 *
5562 * \param completion_index The index of the completion
5563 *
5564 * \return The number of fix-its which must be applied before the completion at
5565 * completion_index can be applied
5566 */
5567CINDEX_LINKAGE unsigned
5568clang_getCompletionNumFixIts(CXCodeCompleteResults *results,
5569 unsigned completion_index);
5570
5571/**
5572 * Fix-its that *must* be applied before inserting the text for the
5573 * corresponding completion.
5574 *
5575 * By default, clang_codeCompleteAt() only returns completions with empty
5576 * fix-its. Extra completions with non-empty fix-its should be explicitly
5577 * requested by setting CXCodeComplete_IncludeCompletionsWithFixIts.
5578 *
5579 * For the clients to be able to compute position of the cursor after applying
5580 * fix-its, the following conditions are guaranteed to hold for
5581 * replacement_range of the stored fix-its:
5582 * - Ranges in the fix-its are guaranteed to never contain the completion
5583 * point (or identifier under completion point, if any) inside them, except
5584 * at the start or at the end of the range.
5585 * - If a fix-it range starts or ends with completion point (or starts or
5586 * ends after the identifier under completion point), it will contain at
5587 * least one character. It allows to unambiguously recompute completion
5588 * point after applying the fix-it.
5589 *
5590 * The intuition is that provided fix-its change code around the identifier we
5591 * complete, but are not allowed to touch the identifier itself or the
5592 * completion point. One example of completions with corrections are the ones
5593 * replacing '.' with '->' and vice versa:
5594 *
5595 * std::unique_ptr<std::vector<int>> vec_ptr;
5596 * In 'vec_ptr.^', one of the completions is 'push_back', it requires
5597 * replacing '.' with '->'.
5598 * In 'vec_ptr->^', one of the completions is 'release', it requires
5599 * replacing '->' with '.'.
5600 *
5601 * \param results The structure keeping all completion results
5602 *
5603 * \param completion_index The index of the completion
5604 *
5605 * \param fixit_index The index of the fix-it for the completion at
5606 * completion_index
5607 *
5608 * \param replacement_range The fix-it range that must be replaced before the
5609 * completion at completion_index can be applied
5610 *
5611 * \returns The fix-it string that must replace the code at replacement_range
5612 * before the completion at completion_index can be applied
5613 */
5614CINDEX_LINKAGE CXString clang_getCompletionFixIt(
5615 CXCodeCompleteResults *results, unsigned completion_index,
5616 unsigned fixit_index, CXSourceRange *replacement_range);
5617
5618/**
5619 * Flags that can be passed to \c clang_codeCompleteAt() to
5620 * modify its behavior.
5621 *
5622 * The enumerators in this enumeration can be bitwise-OR'd together to
5623 * provide multiple options to \c clang_codeCompleteAt().
5624 */
5625enum CXCodeComplete_Flags {
5626 /**
5627 * Whether to include macros within the set of code
5628 * completions returned.
5629 */
5630 CXCodeComplete_IncludeMacros = 0x01,
5631
5632 /**
5633 * Whether to include code patterns for language constructs
5634 * within the set of code completions, e.g., for loops.
5635 */
5636 CXCodeComplete_IncludeCodePatterns = 0x02,
5637
5638 /**
5639 * Whether to include brief documentation within the set of code
5640 * completions returned.
5641 */
5642 CXCodeComplete_IncludeBriefComments = 0x04,
5643
5644 /**
5645 * Whether to speed up completion by omitting top- or namespace-level entities
5646 * defined in the preamble. There's no guarantee any particular entity is
5647 * omitted. This may be useful if the headers are indexed externally.
5648 */
5649 CXCodeComplete_SkipPreamble = 0x08,
5650
5651 /**
5652 * Whether to include completions with small
5653 * fix-its, e.g. change '.' to '->' on member access, etc.
5654 */
5655 CXCodeComplete_IncludeCompletionsWithFixIts = 0x10
5656};
5657
5658/**
5659 * Bits that represent the context under which completion is occurring.
5660 *
5661 * The enumerators in this enumeration may be bitwise-OR'd together if multiple
5662 * contexts are occurring simultaneously.
5663 */
5664enum CXCompletionContext {
5665 /**
5666 * The context for completions is unexposed, as only Clang results
5667 * should be included. (This is equivalent to having no context bits set.)
5668 */
5669 CXCompletionContext_Unexposed = 0,
5670
5671 /**
5672 * Completions for any possible type should be included in the results.
5673 */
5674 CXCompletionContext_AnyType = 1 << 0,
5675
5676 /**
5677 * Completions for any possible value (variables, function calls, etc.)
5678 * should be included in the results.
5679 */
5680 CXCompletionContext_AnyValue = 1 << 1,
5681 /**
5682 * Completions for values that resolve to an Objective-C object should
5683 * be included in the results.
5684 */
5685 CXCompletionContext_ObjCObjectValue = 1 << 2,
5686 /**
5687 * Completions for values that resolve to an Objective-C selector
5688 * should be included in the results.
5689 */
5690 CXCompletionContext_ObjCSelectorValue = 1 << 3,
5691 /**
5692 * Completions for values that resolve to a C++ class type should be
5693 * included in the results.
5694 */
5695 CXCompletionContext_CXXClassTypeValue = 1 << 4,
5696
5697 /**
5698 * Completions for fields of the member being accessed using the dot
5699 * operator should be included in the results.
5700 */
5701 CXCompletionContext_DotMemberAccess = 1 << 5,
5702 /**
5703 * Completions for fields of the member being accessed using the arrow
5704 * operator should be included in the results.
5705 */
5706 CXCompletionContext_ArrowMemberAccess = 1 << 6,
5707 /**
5708 * Completions for properties of the Objective-C object being accessed
5709 * using the dot operator should be included in the results.
5710 */
5711 CXCompletionContext_ObjCPropertyAccess = 1 << 7,
5712
5713 /**
5714 * Completions for enum tags should be included in the results.
5715 */
5716 CXCompletionContext_EnumTag = 1 << 8,
5717 /**
5718 * Completions for union tags should be included in the results.
5719 */
5720 CXCompletionContext_UnionTag = 1 << 9,
5721 /**
5722 * Completions for struct tags should be included in the results.
5723 */
5724 CXCompletionContext_StructTag = 1 << 10,
5725
5726 /**
5727 * Completions for C++ class names should be included in the results.
5728 */
5729 CXCompletionContext_ClassTag = 1 << 11,
5730 /**
5731 * Completions for C++ namespaces and namespace aliases should be
5732 * included in the results.
5733 */
5734 CXCompletionContext_Namespace = 1 << 12,
5735 /**
5736 * Completions for C++ nested name specifiers should be included in
5737 * the results.
5738 */
5739 CXCompletionContext_NestedNameSpecifier = 1 << 13,
5740
5741 /**
5742 * Completions for Objective-C interfaces (classes) should be included
5743 * in the results.
5744 */
5745 CXCompletionContext_ObjCInterface = 1 << 14,
5746 /**
5747 * Completions for Objective-C protocols should be included in
5748 * the results.
5749 */
5750 CXCompletionContext_ObjCProtocol = 1 << 15,
5751 /**
5752 * Completions for Objective-C categories should be included in
5753 * the results.
5754 */
5755 CXCompletionContext_ObjCCategory = 1 << 16,
5756 /**
5757 * Completions for Objective-C instance messages should be included
5758 * in the results.
5759 */
5760 CXCompletionContext_ObjCInstanceMessage = 1 << 17,
5761 /**
5762 * Completions for Objective-C class messages should be included in
5763 * the results.
5764 */
5765 CXCompletionContext_ObjCClassMessage = 1 << 18,
5766 /**
5767 * Completions for Objective-C selector names should be included in
5768 * the results.
5769 */
5770 CXCompletionContext_ObjCSelectorName = 1 << 19,
5771
5772 /**
5773 * Completions for preprocessor macro names should be included in
5774 * the results.
5775 */
5776 CXCompletionContext_MacroName = 1 << 20,
5777
5778 /**
5779 * Natural language completions should be included in the results.
5780 */
5781 CXCompletionContext_NaturalLanguage = 1 << 21,
5782
5783 /**
5784 * #include file completions should be included in the results.
5785 */
5786 CXCompletionContext_IncludedFile = 1 << 22,
5787
5788 /**
5789 * The current context is unknown, so set all contexts.
5790 */
5791 CXCompletionContext_Unknown = ((1 << 23) - 1)
5792};
5793
5794/**
5795 * Returns a default set of code-completion options that can be
5796 * passed to\c clang_codeCompleteAt().
5797 */
5798CINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void);
5799
5800/**
5801 * Perform code completion at a given location in a translation unit.
5802 *
5803 * This function performs code completion at a particular file, line, and
5804 * column within source code, providing results that suggest potential
5805 * code snippets based on the context of the completion. The basic model
5806 * for code completion is that Clang will parse a complete source file,
5807 * performing syntax checking up to the location where code-completion has
5808 * been requested. At that point, a special code-completion token is passed
5809 * to the parser, which recognizes this token and determines, based on the
5810 * current location in the C/Objective-C/C++ grammar and the state of
5811 * semantic analysis, what completions to provide. These completions are
5812 * returned via a new \c CXCodeCompleteResults structure.
5813 *
5814 * Code completion itself is meant to be triggered by the client when the
5815 * user types punctuation characters or whitespace, at which point the
5816 * code-completion location will coincide with the cursor. For example, if \c p
5817 * is a pointer, code-completion might be triggered after the "-" and then
5818 * after the ">" in \c p->. When the code-completion location is after the ">",
5819 * the completion results will provide, e.g., the members of the struct that
5820 * "p" points to. The client is responsible for placing the cursor at the
5821 * beginning of the token currently being typed, then filtering the results
5822 * based on the contents of the token. For example, when code-completing for
5823 * the expression \c p->get, the client should provide the location just after
5824 * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
5825 * client can filter the results based on the current token text ("get"), only
5826 * showing those results that start with "get". The intent of this interface
5827 * is to separate the relatively high-latency acquisition of code-completion
5828 * results from the filtering of results on a per-character basis, which must
5829 * have a lower latency.
5830 *
5831 * \param TU The translation unit in which code-completion should
5832 * occur. The source files for this translation unit need not be
5833 * completely up-to-date (and the contents of those source files may
5834 * be overridden via \p unsaved_files). Cursors referring into the
5835 * translation unit may be invalidated by this invocation.
5836 *
5837 * \param complete_filename The name of the source file where code
5838 * completion should be performed. This filename may be any file
5839 * included in the translation unit.
5840 *
5841 * \param complete_line The line at which code-completion should occur.
5842 *
5843 * \param complete_column The column at which code-completion should occur.
5844 * Note that the column should point just after the syntactic construct that
5845 * initiated code completion, and not in the middle of a lexical token.
5846 *
5847 * \param unsaved_files the Files that have not yet been saved to disk
5848 * but may be required for parsing or code completion, including the
5849 * contents of those files. The contents and name of these files (as
5850 * specified by CXUnsavedFile) are copied when necessary, so the
5851 * client only needs to guarantee their validity until the call to
5852 * this function returns.
5853 *
5854 * \param num_unsaved_files The number of unsaved file entries in \p
5855 * unsaved_files.
5856 *
5857 * \param options Extra options that control the behavior of code
5858 * completion, expressed as a bitwise OR of the enumerators of the
5859 * CXCodeComplete_Flags enumeration. The
5860 * \c clang_defaultCodeCompleteOptions() function returns a default set
5861 * of code-completion options.
5862 *
5863 * \returns If successful, a new \c CXCodeCompleteResults structure
5864 * containing code-completion results, which should eventually be
5865 * freed with \c clang_disposeCodeCompleteResults(). If code
5866 * completion fails, returns NULL.
5867 */
5868CINDEX_LINKAGE
5869CXCodeCompleteResults *
5870clang_codeCompleteAt(CXTranslationUnit TU, const char *complete_filename,
5871 unsigned complete_line, unsigned complete_column,
5872 struct CXUnsavedFile *unsaved_files,
5873 unsigned num_unsaved_files, unsigned options);
5874
5875/**
5876 * Sort the code-completion results in case-insensitive alphabetical
5877 * order.
5878 *
5879 * \param Results The set of results to sort.
5880 * \param NumResults The number of results in \p Results.
5881 */
5882CINDEX_LINKAGE
5883void clang_sortCodeCompletionResults(CXCompletionResult *Results,
5884 unsigned NumResults);
5885
5886/**
5887 * Free the given set of code-completion results.
5888 */
5889CINDEX_LINKAGE
5890void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results);
5891
5892/**
5893 * Determine the number of diagnostics produced prior to the
5894 * location where code completion was performed.
5895 */
5896CINDEX_LINKAGE
5897unsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results);
5898
5899/**
5900 * Retrieve a diagnostic associated with the given code completion.
5901 *
5902 * \param Results the code completion results to query.
5903 * \param Index the zero-based diagnostic number to retrieve.
5904 *
5905 * \returns the requested diagnostic. This diagnostic must be freed
5906 * via a call to \c clang_disposeDiagnostic().
5907 */
5908CINDEX_LINKAGE
5909CXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results,
5910 unsigned Index);
5911
5912/**
5913 * Determines what completions are appropriate for the context
5914 * the given code completion.
5915 *
5916 * \param Results the code completion results to query
5917 *
5918 * \returns the kinds of completions that are appropriate for use
5919 * along with the given code completion results.
5920 */
5921CINDEX_LINKAGE
5922unsigned long long
5923clang_codeCompleteGetContexts(CXCodeCompleteResults *Results);
5924
5925/**
5926 * Returns the cursor kind for the container for the current code
5927 * completion context. The container is only guaranteed to be set for
5928 * contexts where a container exists (i.e. member accesses or Objective-C
5929 * message sends); if there is not a container, this function will return
5930 * CXCursor_InvalidCode.
5931 *
5932 * \param Results the code completion results to query
5933 *
5934 * \param IsIncomplete on return, this value will be false if Clang has complete
5935 * information about the container. If Clang does not have complete
5936 * information, this value will be true.
5937 *
5938 * \returns the container kind, or CXCursor_InvalidCode if there is not a
5939 * container
5940 */
5941CINDEX_LINKAGE
5942enum CXCursorKind
5943clang_codeCompleteGetContainerKind(CXCodeCompleteResults *Results,
5944 unsigned *IsIncomplete);
5945
5946/**
5947 * Returns the USR for the container for the current code completion
5948 * context. If there is not a container for the current context, this
5949 * function will return the empty string.
5950 *
5951 * \param Results the code completion results to query
5952 *
5953 * \returns the USR for the container
5954 */
5955CINDEX_LINKAGE
5956CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results);
5957
5958/**
5959 * Returns the currently-entered selector for an Objective-C message
5960 * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
5961 * non-empty string for CXCompletionContext_ObjCInstanceMessage and
5962 * CXCompletionContext_ObjCClassMessage.
5963 *
5964 * \param Results the code completion results to query
5965 *
5966 * \returns the selector (or partial selector) that has been entered thus far
5967 * for an Objective-C message send.
5968 */
5969CINDEX_LINKAGE
5970CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results);
5971
5972/**
5973 * @}
5974 */
5975
5976/**
5977 * \defgroup CINDEX_MISC Miscellaneous utility functions
5978 *
5979 * @{
5980 */
5981
5982/**
5983 * Return a version string, suitable for showing to a user, but not
5984 * intended to be parsed (the format is not guaranteed to be stable).
5985 */
5986CINDEX_LINKAGE CXString clang_getClangVersion(void);
5987
5988/**
5989 * Enable/disable crash recovery.
5990 *
5991 * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero
5992 * value enables crash recovery, while 0 disables it.
5993 */
5994CINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled);
5995
5996/**
5997 * Visitor invoked for each file in a translation unit
5998 * (used with clang_getInclusions()).
5999 *
6000 * This visitor function will be invoked by clang_getInclusions() for each
6001 * file included (either at the top-level or by \#include directives) within
6002 * a translation unit. The first argument is the file being included, and
6003 * the second and third arguments provide the inclusion stack. The
6004 * array is sorted in order of immediate inclusion. For example,
6005 * the first element refers to the location that included 'included_file'.
6006 */
6007typedef void (*CXInclusionVisitor)(CXFile included_file,
6008 CXSourceLocation *inclusion_stack,
6009 unsigned include_len,
6010 CXClientData client_data);
6011
6012/**
6013 * Visit the set of preprocessor inclusions in a translation unit.
6014 * The visitor function is called with the provided data for every included
6015 * file. This does not include headers included by the PCH file (unless one
6016 * is inspecting the inclusions in the PCH file itself).
6017 */
6018CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
6019 CXInclusionVisitor visitor,
6020 CXClientData client_data);
6021
6022typedef enum {
6023 CXEval_Int = 1,
6024 CXEval_Float = 2,
6025 CXEval_ObjCStrLiteral = 3,
6026 CXEval_StrLiteral = 4,
6027 CXEval_CFStr = 5,
6028 CXEval_Other = 6,
6029
6030 CXEval_UnExposed = 0
6031
6032} CXEvalResultKind;
6033
6034/**
6035 * Evaluation result of a cursor
6036 */
6037typedef void *CXEvalResult;
6038
6039/**
6040 * If cursor is a statement declaration tries to evaluate the
6041 * statement and if its variable, tries to evaluate its initializer,
6042 * into its corresponding type.
6043 * If it's an expression, tries to evaluate the expression.
6044 */
6045CINDEX_LINKAGE CXEvalResult clang_Cursor_Evaluate(CXCursor C);
6046
6047/**
6048 * Returns the kind of the evaluated result.
6049 */
6050CINDEX_LINKAGE CXEvalResultKind clang_EvalResult_getKind(CXEvalResult E);
6051
6052/**
6053 * Returns the evaluation result as integer if the
6054 * kind is Int.
6055 */
6056CINDEX_LINKAGE int clang_EvalResult_getAsInt(CXEvalResult E);
6057
6058/**
6059 * Returns the evaluation result as a long long integer if the
6060 * kind is Int. This prevents overflows that may happen if the result is
6061 * returned with clang_EvalResult_getAsInt.
6062 */
6063CINDEX_LINKAGE long long clang_EvalResult_getAsLongLong(CXEvalResult E);
6064
6065/**
6066 * Returns a non-zero value if the kind is Int and the evaluation
6067 * result resulted in an unsigned integer.
6068 */
6069CINDEX_LINKAGE unsigned clang_EvalResult_isUnsignedInt(CXEvalResult E);
6070
6071/**
6072 * Returns the evaluation result as an unsigned integer if
6073 * the kind is Int and clang_EvalResult_isUnsignedInt is non-zero.
6074 */
6075CINDEX_LINKAGE unsigned long long
6076clang_EvalResult_getAsUnsigned(CXEvalResult E);
6077
6078/**
6079 * Returns the evaluation result as double if the
6080 * kind is double.
6081 */
6082CINDEX_LINKAGE double clang_EvalResult_getAsDouble(CXEvalResult E);
6083
6084/**
6085 * Returns the evaluation result as a constant string if the
6086 * kind is other than Int or float. User must not free this pointer,
6087 * instead call clang_EvalResult_dispose on the CXEvalResult returned
6088 * by clang_Cursor_Evaluate.
6089 */
6090CINDEX_LINKAGE const char *clang_EvalResult_getAsStr(CXEvalResult E);
6091
6092/**
6093 * Disposes the created Eval memory.
6094 */
6095CINDEX_LINKAGE void clang_EvalResult_dispose(CXEvalResult E);
6096/**
6097 * @}
6098 */
6099
6100/** \defgroup CINDEX_HIGH Higher level API functions
6101 *
6102 * @{
6103 */
6104
6105enum CXVisitorResult { CXVisit_Break, CXVisit_Continue };
6106
6107typedef struct CXCursorAndRangeVisitor {
6108 void *context;
6109 enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
6110} CXCursorAndRangeVisitor;
6111
6112typedef enum {
6113 /**
6114 * Function returned successfully.
6115 */
6116 CXResult_Success = 0,
6117 /**
6118 * One of the parameters was invalid for the function.
6119 */
6120 CXResult_Invalid = 1,
6121 /**
6122 * The function was terminated by a callback (e.g. it returned
6123 * CXVisit_Break)
6124 */
6125 CXResult_VisitBreak = 2
6126
6127} CXResult;
6128
6129/**
6130 * Find references of a declaration in a specific file.
6131 *
6132 * \param cursor pointing to a declaration or a reference of one.
6133 *
6134 * \param file to search for references.
6135 *
6136 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
6137 * each reference found.
6138 * The CXSourceRange will point inside the file; if the reference is inside
6139 * a macro (and not a macro argument) the CXSourceRange will be invalid.
6140 *
6141 * \returns one of the CXResult enumerators.
6142 */
6143CINDEX_LINKAGE CXResult clang_findReferencesInFile(
6144 CXCursor cursor, CXFile file, CXCursorAndRangeVisitor visitor);
6145
6146/**
6147 * Find #import/#include directives in a specific file.
6148 *
6149 * \param TU translation unit containing the file to query.
6150 *
6151 * \param file to search for #import/#include directives.
6152 *
6153 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
6154 * each directive found.
6155 *
6156 * \returns one of the CXResult enumerators.
6157 */
6158CINDEX_LINKAGE CXResult clang_findIncludesInFile(
6159 CXTranslationUnit TU, CXFile file, CXCursorAndRangeVisitor visitor);
6160
6161#if __has_feature(blocks)
6162typedef enum CXVisitorResult (^CXCursorAndRangeVisitorBlock)(CXCursor,
6163 CXSourceRange);
6164#else
6165typedef struct _CXCursorAndRangeVisitorBlock *CXCursorAndRangeVisitorBlock;
6166#endif
6167
6168CINDEX_LINKAGE
6169CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile,
6170 CXCursorAndRangeVisitorBlock);
6171
6172CINDEX_LINKAGE
6173CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile,
6174 CXCursorAndRangeVisitorBlock);
6175
6176/**
6177 * The client's data object that is associated with a CXFile.
6178 */
6179typedef void *CXIdxClientFile;
6180
6181/**
6182 * The client's data object that is associated with a semantic entity.
6183 */
6184typedef void *CXIdxClientEntity;
6185
6186/**
6187 * The client's data object that is associated with a semantic container
6188 * of entities.
6189 */
6190typedef void *CXIdxClientContainer;
6191
6192/**
6193 * The client's data object that is associated with an AST file (PCH
6194 * or module).
6195 */
6196typedef void *CXIdxClientASTFile;
6197
6198/**
6199 * Source location passed to index callbacks.
6200 */
6201typedef struct {
6202 void *ptr_data[2];
6203 unsigned int_data;
6204} CXIdxLoc;
6205
6206/**
6207 * Data for ppIncludedFile callback.
6208 */
6209typedef struct {
6210 /**
6211 * Location of '#' in the \#include/\#import directive.
6212 */
6213 CXIdxLoc hashLoc;
6214 /**
6215 * Filename as written in the \#include/\#import directive.
6216 */
6217 const char *filename;
6218 /**
6219 * The actual file that the \#include/\#import directive resolved to.
6220 */
6221 CXFile file;
6222 int isImport;
6223 int isAngled;
6224 /**
6225 * Non-zero if the directive was automatically turned into a module
6226 * import.
6227 */
6228 int isModuleImport;
6229} CXIdxIncludedFileInfo;
6230
6231/**
6232 * Data for IndexerCallbacks#importedASTFile.
6233 */
6234typedef struct {
6235 /**
6236 * Top level AST file containing the imported PCH, module or submodule.
6237 */
6238 CXFile file;
6239 /**
6240 * The imported module or NULL if the AST file is a PCH.
6241 */
6242 CXModule module;
6243 /**
6244 * Location where the file is imported. Applicable only for modules.
6245 */
6246 CXIdxLoc loc;
6247 /**
6248 * Non-zero if an inclusion directive was automatically turned into
6249 * a module import. Applicable only for modules.
6250 */
6251 int isImplicit;
6252
6253} CXIdxImportedASTFileInfo;
6254
6255typedef enum {
6256 CXIdxEntity_Unexposed = 0,
6257 CXIdxEntity_Typedef = 1,
6258 CXIdxEntity_Function = 2,
6259 CXIdxEntity_Variable = 3,
6260 CXIdxEntity_Field = 4,
6261 CXIdxEntity_EnumConstant = 5,
6262
6263 CXIdxEntity_ObjCClass = 6,
6264 CXIdxEntity_ObjCProtocol = 7,
6265 CXIdxEntity_ObjCCategory = 8,
6266
6267 CXIdxEntity_ObjCInstanceMethod = 9,
6268 CXIdxEntity_ObjCClassMethod = 10,
6269 CXIdxEntity_ObjCProperty = 11,
6270 CXIdxEntity_ObjCIvar = 12,
6271
6272 CXIdxEntity_Enum = 13,
6273 CXIdxEntity_Struct = 14,
6274 CXIdxEntity_Union = 15,
6275
6276 CXIdxEntity_CXXClass = 16,
6277 CXIdxEntity_CXXNamespace = 17,
6278 CXIdxEntity_CXXNamespaceAlias = 18,
6279 CXIdxEntity_CXXStaticVariable = 19,
6280 CXIdxEntity_CXXStaticMethod = 20,
6281 CXIdxEntity_CXXInstanceMethod = 21,
6282 CXIdxEntity_CXXConstructor = 22,
6283 CXIdxEntity_CXXDestructor = 23,
6284 CXIdxEntity_CXXConversionFunction = 24,
6285 CXIdxEntity_CXXTypeAlias = 25,
6286 CXIdxEntity_CXXInterface = 26,
6287 CXIdxEntity_CXXConcept = 27
6288
6289} CXIdxEntityKind;
6290
6291typedef enum {
6292 CXIdxEntityLang_None = 0,
6293 CXIdxEntityLang_C = 1,
6294 CXIdxEntityLang_ObjC = 2,
6295 CXIdxEntityLang_CXX = 3,
6296 CXIdxEntityLang_Swift = 4
6297} CXIdxEntityLanguage;
6298
6299/**
6300 * Extra C++ template information for an entity. This can apply to:
6301 * CXIdxEntity_Function
6302 * CXIdxEntity_CXXClass
6303 * CXIdxEntity_CXXStaticMethod
6304 * CXIdxEntity_CXXInstanceMethod
6305 * CXIdxEntity_CXXConstructor
6306 * CXIdxEntity_CXXConversionFunction
6307 * CXIdxEntity_CXXTypeAlias
6308 */
6309typedef enum {
6310 CXIdxEntity_NonTemplate = 0,
6311 CXIdxEntity_Template = 1,
6312 CXIdxEntity_TemplatePartialSpecialization = 2,
6313 CXIdxEntity_TemplateSpecialization = 3
6314} CXIdxEntityCXXTemplateKind;
6315
6316typedef enum {
6317 CXIdxAttr_Unexposed = 0,
6318 CXIdxAttr_IBAction = 1,
6319 CXIdxAttr_IBOutlet = 2,
6320 CXIdxAttr_IBOutletCollection = 3
6321} CXIdxAttrKind;
6322
6323typedef struct {
6324 CXIdxAttrKind kind;
6325 CXCursor cursor;
6326 CXIdxLoc loc;
6327} CXIdxAttrInfo;
6328
6329typedef struct {
6330 CXIdxEntityKind kind;
6331 CXIdxEntityCXXTemplateKind templateKind;
6332 CXIdxEntityLanguage lang;
6333 const char *name;
6334 const char *USR;
6335 CXCursor cursor;
6336 const CXIdxAttrInfo *const *attributes;
6337 unsigned numAttributes;
6338} CXIdxEntityInfo;
6339
6340typedef struct {
6341 CXCursor cursor;
6342} CXIdxContainerInfo;
6343
6344typedef struct {
6345 const CXIdxAttrInfo *attrInfo;
6346 const CXIdxEntityInfo *objcClass;
6347 CXCursor classCursor;
6348 CXIdxLoc classLoc;
6349} CXIdxIBOutletCollectionAttrInfo;
6350
6351typedef enum { CXIdxDeclFlag_Skipped = 0x1 } CXIdxDeclInfoFlags;
6352
6353typedef struct {
6354 const CXIdxEntityInfo *entityInfo;
6355 CXCursor cursor;
6356 CXIdxLoc loc;
6357 const CXIdxContainerInfo *semanticContainer;
6358 /**
6359 * Generally same as #semanticContainer but can be different in
6360 * cases like out-of-line C++ member functions.
6361 */
6362 const CXIdxContainerInfo *lexicalContainer;
6363 int isRedeclaration;
6364 int isDefinition;
6365 int isContainer;
6366 const CXIdxContainerInfo *declAsContainer;
6367 /**
6368 * Whether the declaration exists in code or was created implicitly
6369 * by the compiler, e.g. implicit Objective-C methods for properties.
6370 */
6371 int isImplicit;
6372 const CXIdxAttrInfo *const *attributes;
6373 unsigned numAttributes;
6374
6375 unsigned flags;
6376
6377} CXIdxDeclInfo;
6378
6379typedef enum {
6380 CXIdxObjCContainer_ForwardRef = 0,
6381 CXIdxObjCContainer_Interface = 1,
6382 CXIdxObjCContainer_Implementation = 2
6383} CXIdxObjCContainerKind;
6384
6385typedef struct {
6386 const CXIdxDeclInfo *declInfo;
6387 CXIdxObjCContainerKind kind;
6388} CXIdxObjCContainerDeclInfo;
6389
6390typedef struct {
6391 const CXIdxEntityInfo *base;
6392 CXCursor cursor;
6393 CXIdxLoc loc;
6394} CXIdxBaseClassInfo;
6395
6396typedef struct {
6397 const CXIdxEntityInfo *protocol;
6398 CXCursor cursor;
6399 CXIdxLoc loc;
6400} CXIdxObjCProtocolRefInfo;
6401
6402typedef struct {
6403 const CXIdxObjCProtocolRefInfo *const *protocols;
6404 unsigned numProtocols;
6405} CXIdxObjCProtocolRefListInfo;
6406
6407typedef struct {
6408 const CXIdxObjCContainerDeclInfo *containerInfo;
6409 const CXIdxBaseClassInfo *superInfo;
6410 const CXIdxObjCProtocolRefListInfo *protocols;
6411} CXIdxObjCInterfaceDeclInfo;
6412
6413typedef struct {
6414 const CXIdxObjCContainerDeclInfo *containerInfo;
6415 const CXIdxEntityInfo *objcClass;
6416 CXCursor classCursor;
6417 CXIdxLoc classLoc;
6418 const CXIdxObjCProtocolRefListInfo *protocols;
6419} CXIdxObjCCategoryDeclInfo;
6420
6421typedef struct {
6422 const CXIdxDeclInfo *declInfo;
6423 const CXIdxEntityInfo *getter;
6424 const CXIdxEntityInfo *setter;
6425} CXIdxObjCPropertyDeclInfo;
6426
6427typedef struct {
6428 const CXIdxDeclInfo *declInfo;
6429 const CXIdxBaseClassInfo *const *bases;
6430 unsigned numBases;
6431} CXIdxCXXClassDeclInfo;
6432
6433/**
6434 * Data for IndexerCallbacks#indexEntityReference.
6435 *
6436 * This may be deprecated in a future version as this duplicates
6437 * the \c CXSymbolRole_Implicit bit in \c CXSymbolRole.
6438 */
6439typedef enum {
6440 /**
6441 * The entity is referenced directly in user's code.
6442 */
6443 CXIdxEntityRef_Direct = 1,
6444 /**
6445 * An implicit reference, e.g. a reference of an Objective-C method
6446 * via the dot syntax.
6447 */
6448 CXIdxEntityRef_Implicit = 2
6449} CXIdxEntityRefKind;
6450
6451/**
6452 * Roles that are attributed to symbol occurrences.
6453 *
6454 * Internal: this currently mirrors low 9 bits of clang::index::SymbolRole with
6455 * higher bits zeroed. These high bits may be exposed in the future.
6456 */
6457typedef enum {
6458 CXSymbolRole_None = 0,
6459 CXSymbolRole_Declaration = 1 << 0,
6460 CXSymbolRole_Definition = 1 << 1,
6461 CXSymbolRole_Reference = 1 << 2,
6462 CXSymbolRole_Read = 1 << 3,
6463 CXSymbolRole_Write = 1 << 4,
6464 CXSymbolRole_Call = 1 << 5,
6465 CXSymbolRole_Dynamic = 1 << 6,
6466 CXSymbolRole_AddressOf = 1 << 7,
6467 CXSymbolRole_Implicit = 1 << 8
6468} CXSymbolRole;
6469
6470/**
6471 * Data for IndexerCallbacks#indexEntityReference.
6472 */
6473typedef struct {
6474 CXIdxEntityRefKind kind;
6475 /**
6476 * Reference cursor.
6477 */
6478 CXCursor cursor;
6479 CXIdxLoc loc;
6480 /**
6481 * The entity that gets referenced.
6482 */
6483 const CXIdxEntityInfo *referencedEntity;
6484 /**
6485 * Immediate "parent" of the reference. For example:
6486 *
6487 * \code
6488 * Foo *var;
6489 * \endcode
6490 *
6491 * The parent of reference of type 'Foo' is the variable 'var'.
6492 * For references inside statement bodies of functions/methods,
6493 * the parentEntity will be the function/method.
6494 */
6495 const CXIdxEntityInfo *parentEntity;
6496 /**
6497 * Lexical container context of the reference.
6498 */
6499 const CXIdxContainerInfo *container;
6500 /**
6501 * Sets of symbol roles of the reference.
6502 */
6503 CXSymbolRole role;
6504} CXIdxEntityRefInfo;
6505
6506/**
6507 * A group of callbacks used by #clang_indexSourceFile and
6508 * #clang_indexTranslationUnit.
6509 */
6510typedef struct {
6511 /**
6512 * Called periodically to check whether indexing should be aborted.
6513 * Should return 0 to continue, and non-zero to abort.
6514 */
6515 int (*abortQuery)(CXClientData client_data, void *reserved);
6516
6517 /**
6518 * Called at the end of indexing; passes the complete diagnostic set.
6519 */
6520 void (*diagnostic)(CXClientData client_data, CXDiagnosticSet, void *reserved);
6521
6522 CXIdxClientFile (*enteredMainFile)(CXClientData client_data, CXFile mainFile,
6523 void *reserved);
6524
6525 /**
6526 * Called when a file gets \#included/\#imported.
6527 */
6528 CXIdxClientFile (*ppIncludedFile)(CXClientData client_data,
6529 const CXIdxIncludedFileInfo *);
6530
6531 /**
6532 * Called when a AST file (PCH or module) gets imported.
6533 *
6534 * AST files will not get indexed (there will not be callbacks to index all
6535 * the entities in an AST file). The recommended action is that, if the AST
6536 * file is not already indexed, to initiate a new indexing job specific to
6537 * the AST file.
6538 */
6539 CXIdxClientASTFile (*importedASTFile)(CXClientData client_data,
6540 const CXIdxImportedASTFileInfo *);
6541
6542 /**
6543 * Called at the beginning of indexing a translation unit.
6544 */
6545 CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data,
6546 void *reserved);
6547
6548 void (*indexDeclaration)(CXClientData client_data, const CXIdxDeclInfo *);
6549
6550 /**
6551 * Called to index a reference of an entity.
6552 */
6553 void (*indexEntityReference)(CXClientData client_data,
6554 const CXIdxEntityRefInfo *);
6555
6556} IndexerCallbacks;
6557
6558CINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind);
6559CINDEX_LINKAGE const CXIdxObjCContainerDeclInfo *
6560clang_index_getObjCContainerDeclInfo(const CXIdxDeclInfo *);
6561
6562CINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo *
6563clang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *);
6564
6565CINDEX_LINKAGE
6566const CXIdxObjCCategoryDeclInfo *
6567clang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *);
6568
6569CINDEX_LINKAGE const CXIdxObjCProtocolRefListInfo *
6570clang_index_getObjCProtocolRefListInfo(const CXIdxDeclInfo *);
6571
6572CINDEX_LINKAGE const CXIdxObjCPropertyDeclInfo *
6573clang_index_getObjCPropertyDeclInfo(const CXIdxDeclInfo *);
6574
6575CINDEX_LINKAGE const CXIdxIBOutletCollectionAttrInfo *
6576clang_index_getIBOutletCollectionAttrInfo(const CXIdxAttrInfo *);
6577
6578CINDEX_LINKAGE const CXIdxCXXClassDeclInfo *
6579clang_index_getCXXClassDeclInfo(const CXIdxDeclInfo *);
6580
6581/**
6582 * For retrieving a custom CXIdxClientContainer attached to a
6583 * container.
6584 */
6585CINDEX_LINKAGE CXIdxClientContainer
6586clang_index_getClientContainer(const CXIdxContainerInfo *);
6587
6588/**
6589 * For setting a custom CXIdxClientContainer attached to a
6590 * container.
6591 */
6592CINDEX_LINKAGE void clang_index_setClientContainer(const CXIdxContainerInfo *,
6593 CXIdxClientContainer);
6594
6595/**
6596 * For retrieving a custom CXIdxClientEntity attached to an entity.
6597 */
6598CINDEX_LINKAGE CXIdxClientEntity
6599clang_index_getClientEntity(const CXIdxEntityInfo *);
6600
6601/**
6602 * For setting a custom CXIdxClientEntity attached to an entity.
6603 */
6604CINDEX_LINKAGE void clang_index_setClientEntity(const CXIdxEntityInfo *,
6605 CXIdxClientEntity);
6606
6607/**
6608 * An indexing action/session, to be applied to one or multiple
6609 * translation units.
6610 */
6611typedef void *CXIndexAction;
6612
6613/**
6614 * An indexing action/session, to be applied to one or multiple
6615 * translation units.
6616 *
6617 * \param CIdx The index object with which the index action will be associated.
6618 */
6619CINDEX_LINKAGE CXIndexAction clang_IndexAction_create(CXIndex CIdx);
6620
6621/**
6622 * Destroy the given index action.
6623 *
6624 * The index action must not be destroyed until all of the translation units
6625 * created within that index action have been destroyed.
6626 */
6627CINDEX_LINKAGE void clang_IndexAction_dispose(CXIndexAction);
6628
6629typedef enum {
6630 /**
6631 * Used to indicate that no special indexing options are needed.
6632 */
6633 CXIndexOpt_None = 0x0,
6634
6635 /**
6636 * Used to indicate that IndexerCallbacks#indexEntityReference should
6637 * be invoked for only one reference of an entity per source file that does
6638 * not also include a declaration/definition of the entity.
6639 */
6640 CXIndexOpt_SuppressRedundantRefs = 0x1,
6641
6642 /**
6643 * Function-local symbols should be indexed. If this is not set
6644 * function-local symbols will be ignored.
6645 */
6646 CXIndexOpt_IndexFunctionLocalSymbols = 0x2,
6647
6648 /**
6649 * Implicit function/class template instantiations should be indexed.
6650 * If this is not set, implicit instantiations will be ignored.
6651 */
6652 CXIndexOpt_IndexImplicitTemplateInstantiations = 0x4,
6653
6654 /**
6655 * Suppress all compiler warnings when parsing for indexing.
6656 */
6657 CXIndexOpt_SuppressWarnings = 0x8,
6658
6659 /**
6660 * Skip a function/method body that was already parsed during an
6661 * indexing session associated with a \c CXIndexAction object.
6662 * Bodies in system headers are always skipped.
6663 */
6664 CXIndexOpt_SkipParsedBodiesInSession = 0x10
6665
6666} CXIndexOptFlags;
6667
6668/**
6669 * Index the given source file and the translation unit corresponding
6670 * to that file via callbacks implemented through #IndexerCallbacks.
6671 *
6672 * \param client_data pointer data supplied by the client, which will
6673 * be passed to the invoked callbacks.
6674 *
6675 * \param index_callbacks Pointer to indexing callbacks that the client
6676 * implements.
6677 *
6678 * \param index_callbacks_size Size of #IndexerCallbacks structure that gets
6679 * passed in index_callbacks.
6680 *
6681 * \param index_options A bitmask of options that affects how indexing is
6682 * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags.
6683 *
6684 * \param[out] out_TU pointer to store a \c CXTranslationUnit that can be
6685 * reused after indexing is finished. Set to \c NULL if you do not require it.
6686 *
6687 * \returns 0 on success or if there were errors from which the compiler could
6688 * recover. If there is a failure from which there is no recovery, returns
6689 * a non-zero \c CXErrorCode.
6690 *
6691 * The rest of the parameters are the same as #clang_parseTranslationUnit.
6692 */
6693CINDEX_LINKAGE int clang_indexSourceFile(
6694 CXIndexAction, CXClientData client_data, IndexerCallbacks *index_callbacks,
6695 unsigned index_callbacks_size, unsigned index_options,
6696 const char *source_filename, const char *const *command_line_args,
6697 int num_command_line_args, struct CXUnsavedFile *unsaved_files,
6698 unsigned num_unsaved_files, CXTranslationUnit *out_TU, unsigned TU_options);
6699
6700/**
6701 * Same as clang_indexSourceFile but requires a full command line
6702 * for \c command_line_args including argv[0]. This is useful if the standard
6703 * library paths are relative to the binary.
6704 */
6705CINDEX_LINKAGE int clang_indexSourceFileFullArgv(
6706 CXIndexAction, CXClientData client_data, IndexerCallbacks *index_callbacks,
6707 unsigned index_callbacks_size, unsigned index_options,
6708 const char *source_filename, const char *const *command_line_args,
6709 int num_command_line_args, struct CXUnsavedFile *unsaved_files,
6710 unsigned num_unsaved_files, CXTranslationUnit *out_TU, unsigned TU_options);
6711
6712/**
6713 * Index the given translation unit via callbacks implemented through
6714 * #IndexerCallbacks.
6715 *
6716 * The order of callback invocations is not guaranteed to be the same as
6717 * when indexing a source file. The high level order will be:
6718 *
6719 * -Preprocessor callbacks invocations
6720 * -Declaration/reference callbacks invocations
6721 * -Diagnostic callback invocations
6722 *
6723 * The parameters are the same as #clang_indexSourceFile.
6724 *
6725 * \returns If there is a failure from which there is no recovery, returns
6726 * non-zero, otherwise returns 0.
6727 */
6728CINDEX_LINKAGE int clang_indexTranslationUnit(
6729 CXIndexAction, CXClientData client_data, IndexerCallbacks *index_callbacks,
6730 unsigned index_callbacks_size, unsigned index_options, CXTranslationUnit);
6731
6732/**
6733 * Retrieve the CXIdxFile, file, line, column, and offset represented by
6734 * the given CXIdxLoc.
6735 *
6736 * If the location refers into a macro expansion, retrieves the
6737 * location of the macro expansion and if it refers into a macro argument
6738 * retrieves the location of the argument.
6739 */
6740CINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc,
6741 CXIdxClientFile *indexFile,
6742 CXFile *file, unsigned *line,
6743 unsigned *column,
6744 unsigned *offset);
6745
6746/**
6747 * Retrieve the CXSourceLocation represented by the given CXIdxLoc.
6748 */
6749CINDEX_LINKAGE
6750CXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc);
6751
6752/**
6753 * Visitor invoked for each field found by a traversal.
6754 *
6755 * This visitor function will be invoked for each field found by
6756 * \c clang_Type_visitFields. Its first argument is the cursor being
6757 * visited, its second argument is the client data provided to
6758 * \c clang_Type_visitFields.
6759 *
6760 * The visitor should return one of the \c CXVisitorResult values
6761 * to direct \c clang_Type_visitFields.
6762 */
6763typedef enum CXVisitorResult (*CXFieldVisitor)(CXCursor C,
6764 CXClientData client_data);
6765
6766/**
6767 * Visit the fields of a particular type.
6768 *
6769 * This function visits all the direct fields of the given cursor,
6770 * invoking the given \p visitor function with the cursors of each
6771 * visited field. The traversal may be ended prematurely, if
6772 * the visitor returns \c CXFieldVisit_Break.
6773 *
6774 * \param T the record type whose field may be visited.
6775 *
6776 * \param visitor the visitor function that will be invoked for each
6777 * field of \p T.
6778 *
6779 * \param client_data pointer data supplied by the client, which will
6780 * be passed to the visitor each time it is invoked.
6781 *
6782 * \returns a non-zero value if the traversal was terminated
6783 * prematurely by the visitor returning \c CXFieldVisit_Break.
6784 */
6785CINDEX_LINKAGE unsigned clang_Type_visitFields(CXType T, CXFieldVisitor visitor,
6786 CXClientData client_data);
6787
6788/**
6789 * Visit the base classes of a type.
6790 *
6791 * This function visits all the direct base classes of a the given cursor,
6792 * invoking the given \p visitor function with the cursors of each
6793 * visited base. The traversal may be ended prematurely, if
6794 * the visitor returns \c CXFieldVisit_Break.
6795 *
6796 * \param T the record type whose field may be visited.
6797 *
6798 * \param visitor the visitor function that will be invoked for each
6799 * field of \p T.
6800 *
6801 * \param client_data pointer data supplied by the client, which will
6802 * be passed to the visitor each time it is invoked.
6803 *
6804 * \returns a non-zero value if the traversal was terminated
6805 * prematurely by the visitor returning \c CXFieldVisit_Break.
6806 */
6807CINDEX_LINKAGE unsigned clang_visitCXXBaseClasses(CXType T,
6808 CXFieldVisitor visitor,
6809 CXClientData client_data);
6810
6811/**
6812 * Visit the class methods of a type.
6813 *
6814 * This function visits all the methods of the given cursor,
6815 * invoking the given \p visitor function with the cursors of each
6816 * visited method. The traversal may be ended prematurely, if
6817 * the visitor returns \c CXFieldVisit_Break.
6818 *
6819 * \param T The record type whose field may be visited.
6820 *
6821 * \param visitor The visitor function that will be invoked for each
6822 * field of \p T.
6823 *
6824 * \param client_data Pointer data supplied by the client, which will
6825 * be passed to the visitor each time it is invoked.
6826 *
6827 * \returns A non-zero value if the traversal was terminated
6828 * prematurely by the visitor returning \c CXFieldVisit_Break.
6829 */
6830CINDEX_LINKAGE unsigned clang_visitCXXMethods(CXType T, CXFieldVisitor visitor,
6831 CXClientData client_data);
6832
6833/**
6834 * Describes the kind of binary operators.
6835 */
6836enum CXBinaryOperatorKind {
6837 /** This value describes cursors which are not binary operators. */
6838 CXBinaryOperator_Invalid = 0,
6839 /** C++ Pointer - to - member operator. */
6840 CXBinaryOperator_PtrMemD = 1,
6841 /** C++ Pointer - to - member operator. */
6842 CXBinaryOperator_PtrMemI = 2,
6843 /** Multiplication operator. */
6844 CXBinaryOperator_Mul = 3,
6845 /** Division operator. */
6846 CXBinaryOperator_Div = 4,
6847 /** Remainder operator. */
6848 CXBinaryOperator_Rem = 5,
6849 /** Addition operator. */
6850 CXBinaryOperator_Add = 6,
6851 /** Subtraction operator. */
6852 CXBinaryOperator_Sub = 7,
6853 /** Bitwise shift left operator. */
6854 CXBinaryOperator_Shl = 8,
6855 /** Bitwise shift right operator. */
6856 CXBinaryOperator_Shr = 9,
6857 /** C++ three-way comparison (spaceship) operator. */
6858 CXBinaryOperator_Cmp = 10,
6859 /** Less than operator. */
6860 CXBinaryOperator_LT = 11,
6861 /** Greater than operator. */
6862 CXBinaryOperator_GT = 12,
6863 /** Less or equal operator. */
6864 CXBinaryOperator_LE = 13,
6865 /** Greater or equal operator. */
6866 CXBinaryOperator_GE = 14,
6867 /** Equal operator. */
6868 CXBinaryOperator_EQ = 15,
6869 /** Not equal operator. */
6870 CXBinaryOperator_NE = 16,
6871 /** Bitwise AND operator. */
6872 CXBinaryOperator_And = 17,
6873 /** Bitwise XOR operator. */
6874 CXBinaryOperator_Xor = 18,
6875 /** Bitwise OR operator. */
6876 CXBinaryOperator_Or = 19,
6877 /** Logical AND operator. */
6878 CXBinaryOperator_LAnd = 20,
6879 /** Logical OR operator. */
6880 CXBinaryOperator_LOr = 21,
6881 /** Assignment operator. */
6882 CXBinaryOperator_Assign = 22,
6883 /** Multiplication assignment operator. */
6884 CXBinaryOperator_MulAssign = 23,
6885 /** Division assignment operator. */
6886 CXBinaryOperator_DivAssign = 24,
6887 /** Remainder assignment operator. */
6888 CXBinaryOperator_RemAssign = 25,
6889 /** Addition assignment operator. */
6890 CXBinaryOperator_AddAssign = 26,
6891 /** Subtraction assignment operator. */
6892 CXBinaryOperator_SubAssign = 27,
6893 /** Bitwise shift left assignment operator. */
6894 CXBinaryOperator_ShlAssign = 28,
6895 /** Bitwise shift right assignment operator. */
6896 CXBinaryOperator_ShrAssign = 29,
6897 /** Bitwise AND assignment operator. */
6898 CXBinaryOperator_AndAssign = 30,
6899 /** Bitwise XOR assignment operator. */
6900 CXBinaryOperator_XorAssign = 31,
6901 /** Bitwise OR assignment operator. */
6902 CXBinaryOperator_OrAssign = 32,
6903 /** Comma operator. */
6904 CXBinaryOperator_Comma = 33,
6905 CXBinaryOperator_Last = CXBinaryOperator_Comma
6906};
6907
6908/**
6909 * Retrieve the spelling of a given CXBinaryOperatorKind.
6910 */
6911CINDEX_LINKAGE CXString
6912clang_getBinaryOperatorKindSpelling(enum CXBinaryOperatorKind kind);
6913
6914/**
6915 * Retrieve the binary operator kind of this cursor.
6916 *
6917 * If this cursor is not a binary operator then returns Invalid.
6918 */
6919CINDEX_LINKAGE enum CXBinaryOperatorKind
6920clang_getCursorBinaryOperatorKind(CXCursor cursor);
6921
6922/**
6923 * Describes the kind of unary operators.
6924 */
6925enum CXUnaryOperatorKind {
6926 /** This value describes cursors which are not unary operators. */
6927 CXUnaryOperator_Invalid,
6928 /** Postfix increment operator. */
6929 CXUnaryOperator_PostInc,
6930 /** Postfix decrement operator. */
6931 CXUnaryOperator_PostDec,
6932 /** Prefix increment operator. */
6933 CXUnaryOperator_PreInc,
6934 /** Prefix decrement operator. */
6935 CXUnaryOperator_PreDec,
6936 /** Address of operator. */
6937 CXUnaryOperator_AddrOf,
6938 /** Dereference operator. */
6939 CXUnaryOperator_Deref,
6940 /** Plus operator. */
6941 CXUnaryOperator_Plus,
6942 /** Minus operator. */
6943 CXUnaryOperator_Minus,
6944 /** Not operator. */
6945 CXUnaryOperator_Not,
6946 /** LNot operator. */
6947 CXUnaryOperator_LNot,
6948 /** "__real expr" operator. */
6949 CXUnaryOperator_Real,
6950 /** "__imag expr" operator. */
6951 CXUnaryOperator_Imag,
6952 /** __extension__ marker operator. */
6953 CXUnaryOperator_Extension,
6954 /** C++ co_await operator. */
6955 CXUnaryOperator_Coawait,
6956 CXUnaryOperator_Last = CXUnaryOperator_Coawait
6957};
6958
6959/**
6960 * Retrieve the spelling of a given CXUnaryOperatorKind.
6961 */
6962CINDEX_LINKAGE CXString
6963clang_getUnaryOperatorKindSpelling(enum CXUnaryOperatorKind kind);
6964
6965/**
6966 * Retrieve the unary operator kind of this cursor.
6967 *
6968 * If this cursor is not a unary operator then returns Invalid.
6969 */
6970CINDEX_LINKAGE enum CXUnaryOperatorKind
6971clang_getCursorUnaryOperatorKind(CXCursor cursor);
6972
6973/**
6974 * @}
6975 */
6976
6977/**
6978 * @}
6979 */
6980
6981/* CINDEX_DEPRECATED - disabled to silence MSVC deprecation warnings */
6982typedef void *CXRemapping;
6983
6984CINDEX_DEPRECATED CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *);
6985
6986CINDEX_DEPRECATED CINDEX_LINKAGE CXRemapping
6987clang_getRemappingsFromFileList(const char **, unsigned);
6988
6989CINDEX_DEPRECATED CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
6990
6991CINDEX_DEPRECATED CINDEX_LINKAGE void
6992clang_remap_getFilenames(CXRemapping, unsigned, CXString *, CXString *);
6993
6994CINDEX_DEPRECATED CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
6995
6996LLVM_CLANG_C_EXTERN_C_END
6997
6998#endif
6999