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