clang 21.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
2205 /** OpenACC update Construct.
2206 */
2208
2209 /** OpenACC atomic Construct.
2210 */
2212
2214
2215 /**
2216 * Cursor that represents the translation unit itself.
2217 *
2218 * The translation unit cursor exists primarily to act as the root
2219 * cursor for traversing the contents of a translation unit.
2220 */
2222
2223 /* Attributes */
2225 /**
2226 * An attribute whose specific kind is not exposed via this
2227 * interface.
2228 */
2230
2273
2274 /* Preprocessing */
2282
2283 /* Extra Declarations */
2284 /**
2285 * A module import declaration.
2286 */
2289 /**
2290 * A static_assert or _Static_assert node
2291 */
2293 /**
2294 * a friend declaration.
2295 */
2297 /**
2298 * a concept declaration.
2299 */
2301
2304
2305 /**
2306 * A code completion overload candidate.
2307 */
2310
2311/**
2312 * A cursor representing some element in the abstract syntax tree for
2313 * a translation unit.
2314 *
2315 * The cursor abstraction unifies the different kinds of entities in a
2316 * program--declaration, statements, expressions, references to declarations,
2317 * etc.--under a single "cursor" abstraction with a common set of operations.
2318 * Common operation for a cursor include: getting the physical location in
2319 * a source file where the cursor points, getting the name associated with a
2320 * cursor, and retrieving cursors for any child nodes of a particular cursor.
2321 *
2322 * Cursors can be produced in two specific ways.
2323 * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
2324 * from which one can use clang_visitChildren() to explore the rest of the
2325 * translation unit. clang_getCursor() maps from a physical source location
2326 * to the entity that resides at that location, allowing one to map from the
2327 * source code into the AST.
2328 */
2329typedef struct {
2332 const void *data[3];
2333} CXCursor;
2334
2335/**
2336 * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
2337 *
2338 * @{
2339 */
2340
2341/**
2342 * Retrieve the NULL cursor, which represents no entity.
2343 */
2345
2346/**
2347 * Retrieve the cursor that represents the given translation unit.
2348 *
2349 * The translation unit cursor can be used to start traversing the
2350 * various declarations within the given translation unit.
2351 */
2353
2354/**
2355 * Determine whether two cursors are equivalent.
2356 */
2358
2359/**
2360 * Returns non-zero if \p cursor is null.
2361 */
2363
2364/**
2365 * Compute a hash value for the given cursor.
2366 */
2368
2369/**
2370 * Retrieve the kind of the given cursor.
2371 */
2373
2374/**
2375 * Determine whether the given cursor kind represents a declaration.
2376 */
2378
2379/**
2380 * Determine whether the given declaration is invalid.
2381 *
2382 * A declaration is invalid if it could not be parsed successfully.
2383 *
2384 * \returns non-zero if the cursor represents a declaration and it is
2385 * invalid, otherwise NULL.
2386 */
2388
2389/**
2390 * Determine whether the given cursor kind represents a simple
2391 * reference.
2392 *
2393 * Note that other kinds of cursors (such as expressions) can also refer to
2394 * other cursors. Use clang_getCursorReferenced() to determine whether a
2395 * particular cursor refers to another entity.
2396 */
2398
2399/**
2400 * Determine whether the given cursor kind represents an expression.
2401 */
2403
2404/**
2405 * Determine whether the given cursor kind represents a statement.
2406 */
2408
2409/**
2410 * Determine whether the given cursor kind represents an attribute.
2411 */
2413
2414/**
2415 * Determine whether the given cursor has any attributes.
2416 */
2418
2419/**
2420 * Determine whether the given cursor kind represents an invalid
2421 * cursor.
2422 */
2424
2425/**
2426 * Determine whether the given cursor kind represents a translation
2427 * unit.
2428 */
2430
2431/***
2432 * Determine whether the given cursor represents a preprocessing
2433 * element, such as a preprocessor directive or macro instantiation.
2434 */
2436
2437/***
2438 * Determine whether the given cursor represents a currently
2439 * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
2440 */
2442
2443/**
2444 * Describe the linkage of the entity referred to by a cursor.
2445 */
2447 /** This value indicates that no linkage information is available
2448 * for a provided CXCursor. */
2450 /**
2451 * This is the linkage for variables, parameters, and so on that
2452 * have automatic storage. This covers normal (non-extern) local variables.
2453 */
2455 /** This is the linkage for static variables and static functions. */
2457 /** This is the linkage for entities with external linkage that live
2458 * in C++ anonymous namespaces.*/
2460 /** This is the linkage for entities with true, external linkage. */
2463
2464/**
2465 * Determine the linkage of the entity referred to by a given cursor.
2466 */
2468
2470 /** This value indicates that no visibility information is available
2471 * for a provided CXCursor. */
2473
2474 /** Symbol not seen by the linker. */
2476 /** Symbol seen by the linker but resolves to a symbol inside this object. */
2478 /** Symbol seen by the linker and acts like a normal symbol. */
2481
2482/**
2483 * Describe the visibility of the entity referred to by a cursor.
2484 *
2485 * This returns the default visibility if not explicitly specified by
2486 * a visibility attribute. The default visibility may be changed by
2487 * commandline arguments.
2488 *
2489 * \param cursor The cursor to query.
2490 *
2491 * \returns The visibility of the cursor.
2492 */
2494
2495/**
2496 * Determine the availability of the entity that this cursor refers to,
2497 * taking the current target platform into account.
2498 *
2499 * \param cursor The cursor to query.
2500 *
2501 * \returns The availability of the cursor.
2502 */
2505
2506/**
2507 * Describes the availability of a given entity on a particular platform, e.g.,
2508 * a particular class might only be available on Mac OS 10.7 or newer.
2509 */
2511 /**
2512 * A string that describes the platform for which this structure
2513 * provides availability information.
2514 *
2515 * Possible values are "ios" or "macos".
2516 */
2518 /**
2519 * The version number in which this entity was introduced.
2520 */
2522 /**
2523 * The version number in which this entity was deprecated (but is
2524 * still available).
2525 */
2527 /**
2528 * The version number in which this entity was obsoleted, and therefore
2529 * is no longer available.
2530 */
2532 /**
2533 * Whether the entity is unconditionally unavailable on this platform.
2534 */
2536 /**
2537 * An optional message to provide to a user of this API, e.g., to
2538 * suggest replacement APIs.
2539 */
2542
2543/**
2544 * Determine the availability of the entity that this cursor refers to
2545 * on any platforms for which availability information is known.
2546 *
2547 * \param cursor The cursor to query.
2548 *
2549 * \param always_deprecated If non-NULL, will be set to indicate whether the
2550 * entity is deprecated on all platforms.
2551 *
2552 * \param deprecated_message If non-NULL, will be set to the message text
2553 * provided along with the unconditional deprecation of this entity. The client
2554 * is responsible for deallocating this string.
2555 *
2556 * \param always_unavailable If non-NULL, will be set to indicate whether the
2557 * entity is unavailable on all platforms.
2558 *
2559 * \param unavailable_message If non-NULL, will be set to the message text
2560 * provided along with the unconditional unavailability of this entity. The
2561 * client is responsible for deallocating this string.
2562 *
2563 * \param availability If non-NULL, an array of CXPlatformAvailability instances
2564 * that will be populated with platform availability information, up to either
2565 * the number of platforms for which availability information is available (as
2566 * returned by this function) or \c availability_size, whichever is smaller.
2567 *
2568 * \param availability_size The number of elements available in the
2569 * \c availability array.
2570 *
2571 * \returns The number of platforms (N) for which availability information is
2572 * available (which is unrelated to \c availability_size).
2573 *
2574 * Note that the client is responsible for calling
2575 * \c clang_disposeCXPlatformAvailability to free each of the
2576 * platform-availability structures returned. There are
2577 * \c min(N, availability_size) such structures.
2578 */
2580 CXCursor cursor, int *always_deprecated, CXString *deprecated_message,
2581 int *always_unavailable, CXString *unavailable_message,
2582 CXPlatformAvailability *availability, int availability_size);
2583
2584/**
2585 * Free the memory associated with a \c CXPlatformAvailability structure.
2586 */
2587CINDEX_LINKAGE void
2589
2590/**
2591 * If cursor refers to a variable declaration and it has initializer returns
2592 * cursor referring to the initializer otherwise return null cursor.
2593 */
2595
2596/**
2597 * If cursor refers to a variable declaration that has global storage returns 1.
2598 * If cursor refers to a variable declaration that doesn't have global storage
2599 * returns 0. Otherwise returns -1.
2600 */
2602
2603/**
2604 * If cursor refers to a variable declaration that has external storage
2605 * returns 1. If cursor refers to a variable declaration that doesn't have
2606 * external storage returns 0. Otherwise returns -1.
2607 */
2609
2610/**
2611 * Describe the "language" of the entity referred to by a cursor.
2612 */
2619
2620/**
2621 * Determine the "language" of the entity referred to by a given cursor.
2622 */
2624
2625/**
2626 * Describe the "thread-local storage (TLS) kind" of the declaration
2627 * referred to by a cursor.
2628 */
2630
2631/**
2632 * Determine the "thread-local storage (TLS) kind" of the declaration
2633 * referred to by a cursor.
2634 */
2636
2637/**
2638 * Returns the translation unit that a cursor originated from.
2639 */
2641
2642/**
2643 * A fast container representing a set of CXCursors.
2644 */
2645typedef struct CXCursorSetImpl *CXCursorSet;
2646
2647/**
2648 * Creates an empty CXCursorSet.
2649 */
2651
2652/**
2653 * Disposes a CXCursorSet and releases its associated memory.
2654 */
2656
2657/**
2658 * Queries a CXCursorSet to see if it contains a specific CXCursor.
2659 *
2660 * \returns non-zero if the set contains the specified cursor.
2661 */
2663 CXCursor cursor);
2664
2665/**
2666 * Inserts a CXCursor into a CXCursorSet.
2667 *
2668 * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
2669 */
2671 CXCursor cursor);
2672
2673/**
2674 * Determine the semantic parent of the given cursor.
2675 *
2676 * The semantic parent of a cursor is the cursor that semantically contains
2677 * the given \p cursor. For many declarations, the lexical and semantic parents
2678 * are equivalent (the lexical parent is returned by
2679 * \c clang_getCursorLexicalParent()). They diverge when declarations or
2680 * definitions are provided out-of-line. For example:
2681 *
2682 * \code
2683 * class C {
2684 * void f();
2685 * };
2686 *
2687 * void C::f() { }
2688 * \endcode
2689 *
2690 * In the out-of-line definition of \c C::f, the semantic parent is
2691 * the class \c C, of which this function is a member. The lexical parent is
2692 * the place where the declaration actually occurs in the source code; in this
2693 * case, the definition occurs in the translation unit. In general, the
2694 * lexical parent for a given entity can change without affecting the semantics
2695 * of the program, and the lexical parent of different declarations of the
2696 * same entity may be different. Changing the semantic parent of a declaration,
2697 * on the other hand, can have a major impact on semantics, and redeclarations
2698 * of a particular entity should all have the same semantic context.
2699 *
2700 * In the example above, both declarations of \c C::f have \c C as their
2701 * semantic context, while the lexical context of the first \c C::f is \c C
2702 * and the lexical context of the second \c C::f is the translation unit.
2703 *
2704 * For global declarations, the semantic parent is the translation unit.
2705 */
2707
2708/**
2709 * Determine the lexical parent of the given cursor.
2710 *
2711 * The lexical parent of a cursor is the cursor in which the given \p cursor
2712 * was actually written. For many declarations, the lexical and semantic parents
2713 * are equivalent (the semantic parent is returned by
2714 * \c clang_getCursorSemanticParent()). They diverge when declarations or
2715 * definitions are provided out-of-line. For example:
2716 *
2717 * \code
2718 * class C {
2719 * void f();
2720 * };
2721 *
2722 * void C::f() { }
2723 * \endcode
2724 *
2725 * In the out-of-line definition of \c C::f, the semantic parent is
2726 * the class \c C, of which this function is a member. The lexical parent is
2727 * the place where the declaration actually occurs in the source code; in this
2728 * case, the definition occurs in the translation unit. In general, the
2729 * lexical parent for a given entity can change without affecting the semantics
2730 * of the program, and the lexical parent of different declarations of the
2731 * same entity may be different. Changing the semantic parent of a declaration,
2732 * on the other hand, can have a major impact on semantics, and redeclarations
2733 * of a particular entity should all have the same semantic context.
2734 *
2735 * In the example above, both declarations of \c C::f have \c C as their
2736 * semantic context, while the lexical context of the first \c C::f is \c C
2737 * and the lexical context of the second \c C::f is the translation unit.
2738 *
2739 * For declarations written in the global scope, the lexical parent is
2740 * the translation unit.
2741 */
2743
2744/**
2745 * Determine the set of methods that are overridden by the given
2746 * method.
2747 *
2748 * In both Objective-C and C++, a method (aka virtual member function,
2749 * in C++) can override a virtual method in a base class. For
2750 * Objective-C, a method is said to override any method in the class's
2751 * base class, its protocols, or its categories' protocols, that has the same
2752 * selector and is of the same kind (class or instance).
2753 * If no such method exists, the search continues to the class's superclass,
2754 * its protocols, and its categories, and so on. A method from an Objective-C
2755 * implementation is considered to override the same methods as its
2756 * corresponding method in the interface.
2757 *
2758 * For C++, a virtual member function overrides any virtual member
2759 * function with the same signature that occurs in its base
2760 * classes. With multiple inheritance, a virtual member function can
2761 * override several virtual member functions coming from different
2762 * base classes.
2763 *
2764 * In all cases, this function determines the immediate overridden
2765 * method, rather than all of the overridden methods. For example, if
2766 * a method is originally declared in a class A, then overridden in B
2767 * (which in inherits from A) and also in C (which inherited from B),
2768 * then the only overridden method returned from this function when
2769 * invoked on C's method will be B's method. The client may then
2770 * invoke this function again, given the previously-found overridden
2771 * methods, to map out the complete method-override set.
2772 *
2773 * \param cursor A cursor representing an Objective-C or C++
2774 * method. This routine will compute the set of methods that this
2775 * method overrides.
2776 *
2777 * \param overridden A pointer whose pointee will be replaced with a
2778 * pointer to an array of cursors, representing the set of overridden
2779 * methods. If there are no overridden methods, the pointee will be
2780 * set to NULL. The pointee must be freed via a call to
2781 * \c clang_disposeOverriddenCursors().
2782 *
2783 * \param num_overridden A pointer to the number of overridden
2784 * functions, will be set to the number of overridden functions in the
2785 * array pointed to by \p overridden.
2786 */
2788 CXCursor **overridden,
2789 unsigned *num_overridden);
2790
2791/**
2792 * Free the set of overridden cursors returned by \c
2793 * clang_getOverriddenCursors().
2794 */
2796
2797/**
2798 * Retrieve the file that is included by the given inclusion directive
2799 * cursor.
2800 */
2802
2803/**
2804 * @}
2805 */
2806
2807/**
2808 * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
2809 *
2810 * Cursors represent a location within the Abstract Syntax Tree (AST). These
2811 * routines help map between cursors and the physical locations where the
2812 * described entities occur in the source code. The mapping is provided in
2813 * both directions, so one can map from source code to the AST and back.
2814 *
2815 * @{
2816 */
2817
2818/**
2819 * Map a source location to the cursor that describes the entity at that
2820 * location in the source code.
2821 *
2822 * clang_getCursor() maps an arbitrary source location within a translation
2823 * unit down to the most specific cursor that describes the entity at that
2824 * location. For example, given an expression \c x + y, invoking
2825 * clang_getCursor() with a source location pointing to "x" will return the
2826 * cursor for "x"; similarly for "y". If the cursor points anywhere between
2827 * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
2828 * will return a cursor referring to the "+" expression.
2829 *
2830 * \returns a cursor representing the entity at the given source location, or
2831 * a NULL cursor if no such entity can be found.
2832 */
2834
2835/**
2836 * Retrieve the physical location of the source constructor referenced
2837 * by the given cursor.
2838 *
2839 * The location of a declaration is typically the location of the name of that
2840 * declaration, where the name of that declaration would occur if it is
2841 * unnamed, or some keyword that introduces that particular declaration.
2842 * The location of a reference is where that reference occurs within the
2843 * source code.
2844 */
2846
2847/**
2848 * Retrieve the physical extent of the source construct referenced by
2849 * the given cursor.
2850 *
2851 * The extent of a cursor starts with the file/line/column pointing at the
2852 * first character within the source construct that the cursor refers to and
2853 * ends with the last character within that source construct. For a
2854 * declaration, the extent covers the declaration itself. For a reference,
2855 * the extent covers the location of the reference (e.g., where the referenced
2856 * entity was actually used).
2857 */
2859
2860/**
2861 * @}
2862 */
2863
2864/**
2865 * \defgroup CINDEX_TYPES Type information for CXCursors
2866 *
2867 * @{
2868 */
2869
2870/**
2871 * Describes the kind of type
2872 */
2874 /**
2875 * Represents an invalid type (e.g., where no type is available).
2876 */
2878
2879 /**
2880 * A type whose specific kind is not exposed via this
2881 * interface.
2882 */
2884
2885 /* Builtin types */
2927
2947
2948 /**
2949 * Represents a type that was referred to using an elaborated type keyword.
2950 *
2951 * E.g., struct S, or via a qualified name, e.g., N::M::type, or both.
2952 */
2954
2955 /* OpenCL PipeType. */
2957
2958 /* OpenCL builtin types. */
2999
3003
3016
3017 /* Old aliases for AVC OpenCL extension types. */
3022
3026
3027 /* HLSL Types */
3031
3032/**
3033 * Describes the calling convention of a function type
3034 */
3047 /* Alias for compatibility with older versions of API. */
3060
3064
3065/**
3066 * The type of an element in the abstract syntax tree.
3067 *
3068 */
3069typedef struct {
3071 void *data[2];
3072} CXType;
3073
3074/**
3075 * Retrieve the type of a CXCursor (if any).
3076 */
3078
3079/**
3080 * Pretty-print the underlying type using the rules of the
3081 * language of the translation unit from which it came.
3082 *
3083 * If the type is invalid, an empty string is returned.
3084 */
3086
3087/**
3088 * Retrieve the underlying type of a typedef declaration.
3089 *
3090 * If the cursor does not reference a typedef declaration, an invalid type is
3091 * returned.
3092 */
3094
3095/**
3096 * Retrieve the integer type of an enum declaration.
3097 *
3098 * If the cursor does not reference an enum declaration, an invalid type is
3099 * returned.
3100 */
3102
3103/**
3104 * Retrieve the integer value of an enum constant declaration as a signed
3105 * long long.
3106 *
3107 * If the cursor does not reference an enum constant declaration, LLONG_MIN is
3108 * returned. Since this is also potentially a valid constant value, the kind of
3109 * the cursor must be verified before calling this function.
3110 */
3112
3113/**
3114 * Retrieve the integer value of an enum constant declaration as an unsigned
3115 * long long.
3116 *
3117 * If the cursor does not reference an enum constant declaration, ULLONG_MAX is
3118 * returned. Since this is also potentially a valid constant value, the kind of
3119 * the cursor must be verified before calling this function.
3120 */
3121CINDEX_LINKAGE unsigned long long
3123
3124/**
3125 * Returns non-zero if the cursor specifies a Record member that is a bit-field.
3126 */
3128
3129/**
3130 * Retrieve the bit width of a bit-field declaration as an integer.
3131 *
3132 * If the cursor does not reference a bit-field, or if the bit-field's width
3133 * expression cannot be evaluated, -1 is returned.
3134 *
3135 * For example:
3136 * \code
3137 * if (clang_Cursor_isBitField(Cursor)) {
3138 * int Width = clang_getFieldDeclBitWidth(Cursor);
3139 * if (Width != -1) {
3140 * // The bit-field width is not value-dependent.
3141 * }
3142 * }
3143 * \endcode
3144 */
3146
3147/**
3148 * Retrieve the number of non-variadic arguments associated with a given
3149 * cursor.
3150 *
3151 * The number of arguments can be determined for calls as well as for
3152 * declarations of functions or methods. For other cursors -1 is returned.
3153 */
3155
3156/**
3157 * Retrieve the argument cursor of a function or method.
3158 *
3159 * The argument cursor can be determined for calls as well as for declarations
3160 * of functions or methods. For other cursors and for invalid indices, an
3161 * invalid cursor is returned.
3162 */
3164
3165/**
3166 * Describes the kind of a template argument.
3167 *
3168 * See the definition of llvm::clang::TemplateArgument::ArgKind for full
3169 * element descriptions.
3170 */
3181 /* Indicates an error case, preventing the kind from being deduced. */
3184
3185/**
3186 * Returns the number of template args of a function, struct, or class decl
3187 * representing a template specialization.
3188 *
3189 * If the argument cursor cannot be converted into a template function
3190 * declaration, -1 is returned.
3191 *
3192 * For example, for the following declaration and specialization:
3193 * template <typename T, int kInt, bool kBool>
3194 * void foo() { ... }
3195 *
3196 * template <>
3197 * void foo<float, -7, true>();
3198 *
3199 * The value 3 would be returned from this call.
3200 */
3202
3203/**
3204 * Retrieve the kind of the I'th template argument of the CXCursor C.
3205 *
3206 * If the argument CXCursor does not represent a FunctionDecl, StructDecl, or
3207 * ClassTemplatePartialSpecialization, an invalid template argument kind is
3208 * returned.
3209 *
3210 * For example, for the following declaration and specialization:
3211 * template <typename T, int kInt, bool kBool>
3212 * void foo() { ... }
3213 *
3214 * template <>
3215 * void foo<float, -7, true>();
3216 *
3217 * For I = 0, 1, and 2, Type, Integral, and Integral will be returned,
3218 * respectively.
3219 */
3222
3223/**
3224 * Retrieve a CXType representing the type of a TemplateArgument of a
3225 * function decl representing a template specialization.
3226 *
3227 * If the argument CXCursor does not represent a FunctionDecl, StructDecl,
3228 * ClassDecl or ClassTemplatePartialSpecialization whose I'th template argument
3229 * has a kind of CXTemplateArgKind_Integral, an invalid type is returned.
3230 *
3231 * For example, for the following declaration and specialization:
3232 * template <typename T, int kInt, bool kBool>
3233 * void foo() { ... }
3234 *
3235 * template <>
3236 * void foo<float, -7, true>();
3237 *
3238 * If called with I = 0, "float", will be returned.
3239 * Invalid types will be returned for I == 1 or 2.
3240 */
3242 unsigned I);
3243
3244/**
3245 * Retrieve the value of an Integral TemplateArgument (of a function
3246 * decl representing a template specialization) as a signed long long.
3247 *
3248 * It is undefined to call this function on a CXCursor that does not represent a
3249 * FunctionDecl, StructDecl, ClassDecl or ClassTemplatePartialSpecialization
3250 * whose I'th template argument is not an integral value.
3251 *
3252 * For example, for the following declaration and specialization:
3253 * template <typename T, int kInt, bool kBool>
3254 * void foo() { ... }
3255 *
3256 * template <>
3257 * void foo<float, -7, true>();
3258 *
3259 * If called with I = 1 or 2, -7 or true will be returned, respectively.
3260 * For I == 0, this function's behavior is undefined.
3261 */
3263 unsigned I);
3264
3265/**
3266 * Retrieve the value of an Integral TemplateArgument (of a function
3267 * decl representing a template specialization) as an unsigned long long.
3268 *
3269 * It is undefined to call this function on a CXCursor that does not represent a
3270 * FunctionDecl, StructDecl, ClassDecl or ClassTemplatePartialSpecialization or
3271 * whose I'th template argument is not an integral value.
3272 *
3273 * For example, for the following declaration and specialization:
3274 * template <typename T, int kInt, bool kBool>
3275 * void foo() { ... }
3276 *
3277 * template <>
3278 * void foo<float, 2147483649, true>();
3279 *
3280 * If called with I = 1 or 2, 2147483649 or true will be returned, respectively.
3281 * For I == 0, this function's behavior is undefined.
3282 */
3283CINDEX_LINKAGE unsigned long long
3285
3286/**
3287 * Determine whether two CXTypes represent the same type.
3288 *
3289 * \returns non-zero if the CXTypes represent the same type and
3290 * zero otherwise.
3291 */
3293
3294/**
3295 * Return the canonical type for a CXType.
3296 *
3297 * Clang's type system explicitly models typedefs and all the ways
3298 * a specific type can be represented. The canonical type is the underlying
3299 * type with all the "sugar" removed. For example, if 'T' is a typedef
3300 * for 'int', the canonical type for 'T' would be 'int'.
3301 */
3303
3304/**
3305 * Determine whether a CXType has the "const" qualifier set,
3306 * without looking through typedefs that may have added "const" at a
3307 * different level.
3308 */
3310
3311/**
3312 * Determine whether a CXCursor that is a macro, is
3313 * function like.
3314 */
3316
3317/**
3318 * Determine whether a CXCursor that is a macro, is a
3319 * builtin one.
3320 */
3322
3323/**
3324 * Determine whether a CXCursor that is a function declaration, is an
3325 * inline declaration.
3326 */
3328
3329/**
3330 * Determine whether a CXType has the "volatile" qualifier set,
3331 * without looking through typedefs that may have added "volatile" at
3332 * a different level.
3333 */
3335
3336/**
3337 * Determine whether a CXType has the "restrict" qualifier set,
3338 * without looking through typedefs that may have added "restrict" at a
3339 * different level.
3340 */
3342
3343/**
3344 * Returns the address space of the given type.
3345 */
3347
3348/**
3349 * Returns the typedef name of the given type.
3350 */
3352
3353/**
3354 * For pointer types, returns the type of the pointee.
3355 */
3357
3358/**
3359 * Retrieve the unqualified variant of the given type, removing as
3360 * little sugar as possible.
3361 *
3362 * For example, given the following series of typedefs:
3363 *
3364 * \code
3365 * typedef int Integer;
3366 * typedef const Integer CInteger;
3367 * typedef CInteger DifferenceType;
3368 * \endcode
3369 *
3370 * Executing \c clang_getUnqualifiedType() on a \c CXType that
3371 * represents \c DifferenceType, will desugar to a type representing
3372 * \c Integer, that has no qualifiers.
3373 *
3374 * And, executing \c clang_getUnqualifiedType() on the type of the
3375 * first argument of the following function declaration:
3376 *
3377 * \code
3378 * void foo(const int);
3379 * \endcode
3380 *
3381 * Will return a type representing \c int, removing the \c const
3382 * qualifier.
3383 *
3384 * Sugar over array types is not desugared.
3385 *
3386 * A type can be checked for qualifiers with \c
3387 * clang_isConstQualifiedType(), \c clang_isVolatileQualifiedType()
3388 * and \c clang_isRestrictQualifiedType().
3389 *
3390 * A type that resulted from a call to \c clang_getUnqualifiedType
3391 * will return \c false for all of the above calls.
3392 */
3394
3395/**
3396 * For reference types (e.g., "const int&"), returns the type that the
3397 * reference refers to (e.g "const int").
3398 *
3399 * Otherwise, returns the type itself.
3400 *
3401 * A type that has kind \c CXType_LValueReference or
3402 * \c CXType_RValueReference is a reference type.
3403 */
3405
3406/**
3407 * Return the cursor for the declaration of the given type.
3408 */
3410
3411/**
3412 * Returns the Objective-C type encoding for the specified declaration.
3413 */
3415
3416/**
3417 * Returns the Objective-C type encoding for the specified CXType.
3418 */
3420
3421/**
3422 * Retrieve the spelling of a given CXTypeKind.
3423 */
3425
3426/**
3427 * Retrieve the calling convention associated with a function type.
3428 *
3429 * If a non-function type is passed in, CXCallingConv_Invalid is returned.
3430 */
3432
3433/**
3434 * Retrieve the return type associated with a function type.
3435 *
3436 * If a non-function type is passed in, an invalid type is returned.
3437 */
3439
3440/**
3441 * Retrieve the exception specification type associated with a function type.
3442 * This is a value of type CXCursor_ExceptionSpecificationKind.
3443 *
3444 * If a non-function type is passed in, an error code of -1 is returned.
3445 */
3447
3448/**
3449 * Retrieve the number of non-variadic parameters associated with a
3450 * function type.
3451 *
3452 * If a non-function type is passed in, -1 is returned.
3453 */
3455
3456/**
3457 * Retrieve the type of a parameter of a function type.
3458 *
3459 * If a non-function type is passed in or the function does not have enough
3460 * parameters, an invalid type is returned.
3461 */
3463
3464/**
3465 * Retrieves the base type of the ObjCObjectType.
3466 *
3467 * If the type is not an ObjC object, an invalid type is returned.
3468 */
3470
3471/**
3472 * Retrieve the number of protocol references associated with an ObjC object/id.
3473 *
3474 * If the type is not an ObjC object, 0 is returned.
3475 */
3477
3478/**
3479 * Retrieve the decl for a protocol reference for an ObjC object/id.
3480 *
3481 * If the type is not an ObjC object or there are not enough protocol
3482 * references, an invalid cursor is returned.
3483 */
3485
3486/**
3487 * Retrieve the number of type arguments associated with an ObjC object.
3488 *
3489 * If the type is not an ObjC object, 0 is returned.
3490 */
3492
3493/**
3494 * Retrieve a type argument associated with an ObjC object.
3495 *
3496 * If the type is not an ObjC or the index is not valid,
3497 * an invalid type is returned.
3498 */
3500
3501/**
3502 * Return 1 if the CXType is a variadic function type, and 0 otherwise.
3503 */
3505
3506/**
3507 * Retrieve the return type associated with a given cursor.
3508 *
3509 * This only returns a valid type if the cursor refers to a function or method.
3510 */
3512
3513/**
3514 * Retrieve the exception specification type associated with a given cursor.
3515 * This is a value of type CXCursor_ExceptionSpecificationKind.
3516 *
3517 * This only returns a valid result if the cursor refers to a function or
3518 * method.
3519 */
3521
3522/**
3523 * Return 1 if the CXType is a POD (plain old data) type, and 0
3524 * otherwise.
3525 */
3527
3528/**
3529 * Return the element type of an array, complex, or vector type.
3530 *
3531 * If a type is passed in that is not an array, complex, or vector type,
3532 * an invalid type is returned.
3533 */
3535
3536/**
3537 * Return the number of elements of an array or vector type.
3538 *
3539 * If a type is passed in that is not an array or vector type,
3540 * -1 is returned.
3541 */
3543
3544/**
3545 * Return the element type of an array type.
3546 *
3547 * If a non-array type is passed in, an invalid type is returned.
3548 */
3550
3551/**
3552 * Return the array size of a constant array.
3553 *
3554 * If a non-array type is passed in, -1 is returned.
3555 */
3557
3558/**
3559 * Retrieve the type named by the qualified-id.
3560 *
3561 * If a non-elaborated type is passed in, an invalid type is returned.
3562 */
3564
3565/**
3566 * Determine if a typedef is 'transparent' tag.
3567 *
3568 * A typedef is considered 'transparent' if it shares a name and spelling
3569 * location with its underlying tag type, as is the case with the NS_ENUM macro.
3570 *
3571 * \returns non-zero if transparent and zero otherwise.
3572 */
3574
3576 /**
3577 * Values of this type can never be null.
3578 */
3580 /**
3581 * Values of this type can be null.
3582 */
3584 /**
3585 * Whether values of this type can be null is (explicitly)
3586 * unspecified. This captures a (fairly rare) case where we
3587 * can't conclude anything about the nullability of the type even
3588 * though it has been considered.
3589 */
3591 /**
3592 * Nullability is not applicable to this type.
3593 */
3595
3596 /**
3597 * Generally behaves like Nullable, except when used in a block parameter that
3598 * was imported into a swift async method. There, swift will assume that the
3599 * parameter can get null even if no error occurred. _Nullable parameters are
3600 * assumed to only get null on error.
3601 */
3604
3605/**
3606 * Retrieve the nullability kind of a pointer type.
3607 */
3609
3610/**
3611 * List the possible error codes for \c clang_Type_getSizeOf,
3612 * \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf,
3613 * \c clang_Cursor_getOffsetOf, and \c clang_getOffsetOfBase.
3614 *
3615 * A value of this enumeration type can be returned if the target type is not
3616 * a valid argument to sizeof, alignof or offsetof.
3617 */
3619 /**
3620 * Type is of kind CXType_Invalid.
3621 */
3623 /**
3624 * The type is an incomplete Type.
3625 */
3627 /**
3628 * The type is a dependent Type.
3629 */
3631 /**
3632 * The type is not a constant size type.
3633 */
3635 /**
3636 * The Field name is not valid for this record.
3637 */
3639 /**
3640 * The type is undeduced.
3641 */
3644
3645/**
3646 * Return the alignment of a type in bytes as per C++[expr.alignof]
3647 * standard.
3648 *
3649 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3650 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3651 * is returned.
3652 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3653 * returned.
3654 * If the type declaration is not a constant size type,
3655 * CXTypeLayoutError_NotConstantSize is returned.
3656 */
3658
3659/**
3660 * Return the class type of an member pointer type.
3661 *
3662 * If a non-member-pointer type is passed in, an invalid type is returned.
3663 */
3665
3666/**
3667 * Return the size of a type in bytes as per C++[expr.sizeof] standard.
3668 *
3669 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3670 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3671 * is returned.
3672 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3673 * returned.
3674 */
3676
3677/**
3678 * Return the offset of a field named S in a record of type T in bits
3679 * as it would be returned by __offsetof__ as per C++11[18.2p4]
3680 *
3681 * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
3682 * is returned.
3683 * If the field's type declaration is an incomplete type,
3684 * CXTypeLayoutError_Incomplete is returned.
3685 * If the field's type declaration is a dependent type,
3686 * CXTypeLayoutError_Dependent is returned.
3687 * If the field's name S is not found,
3688 * CXTypeLayoutError_InvalidFieldName is returned.
3689 */
3691
3692/**
3693 * Return the type that was modified by this attributed type.
3694 *
3695 * If the type is not an attributed type, an invalid type is returned.
3696 */
3698
3699/**
3700 * Gets the type contained by this atomic type.
3701 *
3702 * If a non-atomic type is passed in, an invalid type is returned.
3703 */
3705
3706/**
3707 * Return the offset of the field represented by the Cursor.
3708 *
3709 * If the cursor is not a field declaration, -1 is returned.
3710 * If the cursor semantic parent is not a record field declaration,
3711 * CXTypeLayoutError_Invalid is returned.
3712 * If the field's type declaration is an incomplete type,
3713 * CXTypeLayoutError_Incomplete is returned.
3714 * If the field's type declaration is a dependent type,
3715 * CXTypeLayoutError_Dependent is returned.
3716 * If the field's name S is not found,
3717 * CXTypeLayoutError_InvalidFieldName is returned.
3718 */
3720
3721/**
3722 * Determine whether the given cursor represents an anonymous
3723 * tag or namespace
3724 */
3726
3727/**
3728 * Determine whether the given cursor represents an anonymous record
3729 * declaration.
3730 */
3732
3733/**
3734 * Determine whether the given cursor represents an inline namespace
3735 * declaration.
3736 */
3738
3740 /** No ref-qualifier was provided. */
3742 /** An lvalue ref-qualifier was provided (\c &). */
3744 /** An rvalue ref-qualifier was provided (\c &&). */
3747
3748/**
3749 * Returns the number of template arguments for given template
3750 * specialization, or -1 if type \c T is not a template specialization.
3751 */
3753
3754/**
3755 * Returns the type template argument of a template class specialization
3756 * at given index.
3757 *
3758 * This function only returns template type arguments and does not handle
3759 * template template arguments or variadic packs.
3760 */
3762 unsigned i);
3763
3764/**
3765 * Retrieve the ref-qualifier kind of a function or method.
3766 *
3767 * The ref-qualifier is returned for C++ functions or methods. For other types
3768 * or non-C++ declarations, CXRefQualifier_None is returned.
3769 */
3771
3772/**
3773 * Returns 1 if the base class specified by the cursor with kind
3774 * CX_CXXBaseSpecifier is virtual.
3775 */
3777
3778/**
3779 * Returns the offset in bits of a CX_CXXBaseSpecifier relative to the parent
3780 * class.
3781 *
3782 * Returns a small negative number if the offset cannot be computed. See
3783 * CXTypeLayoutError for error codes.
3784 */
3786
3787/**
3788 * Represents the C++ access control level to a base class for a
3789 * cursor with kind CX_CXXBaseSpecifier.
3790 */
3797
3798/**
3799 * Returns the access control level for the referenced object.
3800 *
3801 * If the cursor refers to a C++ declaration, its access control level within
3802 * its parent scope is returned. Otherwise, if the cursor refers to a base
3803 * specifier or access specifier, the specifier itself is returned.
3804 */
3806
3807/**
3808 * Represents the storage classes as declared in the source. CX_SC_Invalid
3809 * was added for the case that the passed cursor in not a declaration.
3810 */
3821
3822/**
3823 * Represents a specific kind of binary operator which can appear at a cursor.
3824 */
3862
3863/**
3864 * \brief Returns the operator code for the binary operator.
3865 */
3868
3869/**
3870 * \brief Returns a string containing the spelling of the binary operator.
3871 */
3874
3875/**
3876 * Returns the storage class for a function or variable declaration.
3877 *
3878 * If the passed in Cursor is not a function or variable declaration,
3879 * CX_SC_Invalid is returned else the storage class.
3880 */
3882
3883/**
3884 * Determine the number of overloaded declarations referenced by a
3885 * \c CXCursor_OverloadedDeclRef cursor.
3886 *
3887 * \param cursor The cursor whose overloaded declarations are being queried.
3888 *
3889 * \returns The number of overloaded declarations referenced by \c cursor. If it
3890 * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
3891 */
3893
3894/**
3895 * Retrieve a cursor for one of the overloaded declarations referenced
3896 * by a \c CXCursor_OverloadedDeclRef cursor.
3897 *
3898 * \param cursor The cursor whose overloaded declarations are being queried.
3899 *
3900 * \param index The zero-based index into the set of overloaded declarations in
3901 * the cursor.
3902 *
3903 * \returns A cursor representing the declaration referenced by the given
3904 * \c cursor at the specified \c index. If the cursor does not have an
3905 * associated set of overloaded declarations, or if the index is out of bounds,
3906 * returns \c clang_getNullCursor();
3907 */
3909 unsigned index);
3910
3911/**
3912 * @}
3913 */
3914
3915/**
3916 * \defgroup CINDEX_ATTRIBUTES Information for attributes
3917 *
3918 * @{
3919 */
3920
3921/**
3922 * For cursors representing an iboutletcollection attribute,
3923 * this function returns the collection element type.
3924 *
3925 */
3927
3928/**
3929 * @}
3930 */
3931
3932/**
3933 * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
3934 *
3935 * These routines provide the ability to traverse the abstract syntax tree
3936 * using cursors.
3937 *
3938 * @{
3939 */
3940
3941/**
3942 * Describes how the traversal of the children of a particular
3943 * cursor should proceed after visiting a particular child cursor.
3944 *
3945 * A value of this enumeration type should be returned by each
3946 * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
3947 */
3949 /**
3950 * Terminates the cursor traversal.
3951 */
3953 /**
3954 * Continues the cursor traversal with the next sibling of
3955 * the cursor just visited, without visiting its children.
3956 */
3958 /**
3959 * Recursively traverse the children of this cursor, using
3960 * the same visitor and client data.
3961 */
3964
3965/**
3966 * Visitor invoked for each cursor found by a traversal.
3967 *
3968 * This visitor function will be invoked for each cursor found by
3969 * clang_visitCursorChildren(). Its first argument is the cursor being
3970 * visited, its second argument is the parent visitor for that cursor,
3971 * and its third argument is the client data provided to
3972 * clang_visitCursorChildren().
3973 *
3974 * The visitor should return one of the \c CXChildVisitResult values
3975 * to direct clang_visitCursorChildren().
3976 */
3977typedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor,
3978 CXCursor parent,
3979 CXClientData client_data);
3980
3981/**
3982 * Visit the children of a particular cursor.
3983 *
3984 * This function visits all the direct children of the given cursor,
3985 * invoking the given \p visitor function with the cursors of each
3986 * visited child. The traversal may be recursive, if the visitor returns
3987 * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
3988 * the visitor returns \c CXChildVisit_Break.
3989 *
3990 * \param parent the cursor whose child may be visited. All kinds of
3991 * cursors can be visited, including invalid cursors (which, by
3992 * definition, have no children).
3993 *
3994 * \param visitor the visitor function that will be invoked for each
3995 * child of \p parent.
3996 *
3997 * \param client_data pointer data supplied by the client, which will
3998 * be passed to the visitor each time it is invoked.
3999 *
4000 * \returns a non-zero value if the traversal was terminated
4001 * prematurely by the visitor returning \c CXChildVisit_Break.
4002 */
4004 CXCursorVisitor visitor,
4005 CXClientData client_data);
4006/**
4007 * Visitor invoked for each cursor found by a traversal.
4008 *
4009 * This visitor block will be invoked for each cursor found by
4010 * clang_visitChildrenWithBlock(). Its first argument is the cursor being
4011 * visited, its second argument is the parent visitor for that cursor.
4012 *
4013 * The visitor should return one of the \c CXChildVisitResult values
4014 * to direct clang_visitChildrenWithBlock().
4015 */
4016#if __has_feature(blocks)
4017typedef enum CXChildVisitResult (^CXCursorVisitorBlock)(CXCursor cursor,
4018 CXCursor parent);
4019#else
4020typedef struct _CXChildVisitResult *CXCursorVisitorBlock;
4021#endif
4022
4023/**
4024 * Visits the children of a cursor using the specified block. Behaves
4025 * identically to clang_visitChildren() in all other respects.
4026 */
4027CINDEX_LINKAGE unsigned
4029
4030/**
4031 * @}
4032 */
4033
4034/**
4035 * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
4036 *
4037 * These routines provide the ability to determine references within and
4038 * across translation units, by providing the names of the entities referenced
4039 * by cursors, follow reference cursors to the declarations they reference,
4040 * and associate declarations with their definitions.
4041 *
4042 * @{
4043 */
4044
4045/**
4046 * Retrieve a Unified Symbol Resolution (USR) for the entity referenced
4047 * by the given cursor.
4048 *
4049 * A Unified Symbol Resolution (USR) is a string that identifies a particular
4050 * entity (function, class, variable, etc.) within a program. USRs can be
4051 * compared across translation units to determine, e.g., when references in
4052 * one translation refer to an entity defined in another translation unit.
4053 */
4055
4056/**
4057 * Construct a USR for a specified Objective-C class.
4058 */
4060
4061/**
4062 * Construct a USR for a specified Objective-C category.
4063 */
4065 const char *class_name, const char *category_name);
4066
4067/**
4068 * Construct a USR for a specified Objective-C protocol.
4069 */
4071clang_constructUSR_ObjCProtocol(const char *protocol_name);
4072
4073/**
4074 * Construct a USR for a specified Objective-C instance variable and
4075 * the USR for its containing class.
4076 */
4078 CXString classUSR);
4079
4080/**
4081 * Construct a USR for a specified Objective-C method and
4082 * the USR for its containing class.
4083 */
4085 unsigned isInstanceMethod,
4086 CXString classUSR);
4087
4088/**
4089 * Construct a USR for a specified Objective-C property and the USR
4090 * for its containing class.
4091 */
4093 CXString classUSR);
4094
4095/**
4096 * Retrieve a name for the entity referenced by this cursor.
4097 */
4099
4100/**
4101 * Retrieve a range for a piece that forms the cursors spelling name.
4102 * Most of the times there is only one range for the complete spelling but for
4103 * Objective-C methods and Objective-C message expressions, there are multiple
4104 * pieces for each selector identifier.
4105 *
4106 * \param pieceIndex the index of the spelling name piece. If this is greater
4107 * than the actual number of pieces, it will return a NULL (invalid) range.
4108 *
4109 * \param options Reserved.
4110 */
4112 CXCursor, unsigned pieceIndex, unsigned options);
4113
4114/**
4115 * Opaque pointer representing a policy that controls pretty printing
4116 * for \c clang_getCursorPrettyPrinted.
4117 */
4118typedef void *CXPrintingPolicy;
4119
4120/**
4121 * Properties for the printing policy.
4122 *
4123 * See \c clang::PrintingPolicy for more information.
4124 */
4152
4155
4156/**
4157 * Get a property value for the given printing policy.
4158 */
4159CINDEX_LINKAGE unsigned
4161 enum CXPrintingPolicyProperty Property);
4162
4163/**
4164 * Set a property value for the given printing policy.
4165 */
4166CINDEX_LINKAGE void
4168 enum CXPrintingPolicyProperty Property,
4169 unsigned Value);
4170
4171/**
4172 * Retrieve the default policy for the cursor.
4173 *
4174 * The policy should be released after use with \c
4175 * clang_PrintingPolicy_dispose.
4176 */
4178
4179/**
4180 * Release a printing policy.
4181 */
4183
4184/**
4185 * Pretty print declarations.
4186 *
4187 * \param Cursor The cursor representing a declaration.
4188 *
4189 * \param Policy The policy to control the entities being printed. If
4190 * NULL, a default policy is used.
4191 *
4192 * \returns The pretty printed declaration or the empty string for
4193 * other cursors.
4194 */
4196 CXPrintingPolicy Policy);
4197
4198/**
4199 * Pretty-print the underlying type using a custom printing policy.
4200 *
4201 * If the type is invalid, an empty string is returned.
4202 */
4204 CXPrintingPolicy cxPolicy);
4205
4206/**
4207 * Retrieve the display name for the entity referenced by this cursor.
4208 *
4209 * The display name contains extra information that helps identify the cursor,
4210 * such as the parameters of a function or template or the arguments of a
4211 * class template specialization.
4212 */
4214
4215/** For a cursor that is a reference, retrieve a cursor representing the
4216 * entity that it references.
4217 *
4218 * Reference cursors refer to other entities in the AST. For example, an
4219 * Objective-C superclass reference cursor refers to an Objective-C class.
4220 * This function produces the cursor for the Objective-C class from the
4221 * cursor for the superclass reference. If the input cursor is a declaration or
4222 * definition, it returns that declaration or definition unchanged.
4223 * Otherwise, returns the NULL cursor.
4224 */
4226
4227/**
4228 * For a cursor that is either a reference to or a declaration
4229 * of some entity, retrieve a cursor that describes the definition of
4230 * that entity.
4231 *
4232 * Some entities can be declared multiple times within a translation
4233 * unit, but only one of those declarations can also be a
4234 * definition. For example, given:
4235 *
4236 * \code
4237 * int f(int, int);
4238 * int g(int x, int y) { return f(x, y); }
4239 * int f(int a, int b) { return a + b; }
4240 * int f(int, int);
4241 * \endcode
4242 *
4243 * there are three declarations of the function "f", but only the
4244 * second one is a definition. The clang_getCursorDefinition()
4245 * function will take any cursor pointing to a declaration of "f"
4246 * (the first or fourth lines of the example) or a cursor referenced
4247 * that uses "f" (the call to "f' inside "g") and will return a
4248 * declaration cursor pointing to the definition (the second "f"
4249 * declaration).
4250 *
4251 * If given a cursor for which there is no corresponding definition,
4252 * e.g., because there is no definition of that entity within this
4253 * translation unit, returns a NULL cursor.
4254 */
4256
4257/**
4258 * Determine whether the declaration pointed to by this cursor
4259 * is also a definition of that entity.
4260 */
4262
4263/**
4264 * Retrieve the canonical cursor corresponding to the given cursor.
4265 *
4266 * In the C family of languages, many kinds of entities can be declared several
4267 * times within a single translation unit. For example, a structure type can
4268 * be forward-declared (possibly multiple times) and later defined:
4269 *
4270 * \code
4271 * struct X;
4272 * struct X;
4273 * struct X {
4274 * int member;
4275 * };
4276 * \endcode
4277 *
4278 * The declarations and the definition of \c X are represented by three
4279 * different cursors, all of which are declarations of the same underlying
4280 * entity. One of these cursor is considered the "canonical" cursor, which
4281 * is effectively the representative for the underlying entity. One can
4282 * determine if two cursors are declarations of the same underlying entity by
4283 * comparing their canonical cursors.
4284 *
4285 * \returns The canonical cursor for the entity referred to by the given cursor.
4286 */
4288
4289/**
4290 * If the cursor points to a selector identifier in an Objective-C
4291 * method or message expression, this returns the selector index.
4292 *
4293 * After getting a cursor with #clang_getCursor, this can be called to
4294 * determine if the location points to a selector identifier.
4295 *
4296 * \returns The selector index if the cursor is an Objective-C method or message
4297 * expression and the cursor is pointing to a selector identifier, or -1
4298 * otherwise.
4299 */
4301
4302/**
4303 * Given a cursor pointing to a C++ method call or an Objective-C
4304 * message, returns non-zero if the method/message is "dynamic", meaning:
4305 *
4306 * For a C++ method: the call is virtual.
4307 * For an Objective-C message: the receiver is an object instance, not 'super'
4308 * or a specific class.
4309 *
4310 * If the method/message is "static" or the cursor does not point to a
4311 * method/message, it will return zero.
4312 */
4314
4315/**
4316 * Given a cursor pointing to an Objective-C message or property
4317 * reference, or C++ method call, returns the CXType of the receiver.
4318 */
4320
4321/**
4322 * Property attributes for a \c CXCursor_ObjCPropertyDecl.
4323 */
4324typedef enum {
4340
4341/**
4342 * Given a cursor that represents a property declaration, return the
4343 * associated property attributes. The bits are formed from
4344 * \c CXObjCPropertyAttrKind.
4345 *
4346 * \param reserved Reserved for future use, pass 0.
4347 */
4348CINDEX_LINKAGE unsigned
4350
4351/**
4352 * Given a cursor that represents a property declaration, return the
4353 * name of the method that implements the getter.
4354 */
4356
4357/**
4358 * Given a cursor that represents a property declaration, return the
4359 * name of the method that implements the setter, if any.
4360 */
4362
4363/**
4364 * 'Qualifiers' written next to the return and parameter types in
4365 * Objective-C method declarations.
4366 */
4367typedef enum {
4376
4377/**
4378 * Given a cursor that represents an Objective-C method or parameter
4379 * declaration, return the associated Objective-C qualifiers for the return
4380 * type or the parameter respectively. The bits are formed from
4381 * CXObjCDeclQualifierKind.
4382 */
4384
4385/**
4386 * Given a cursor that represents an Objective-C method or property
4387 * declaration, return non-zero if the declaration was affected by "\@optional".
4388 * Returns zero if the cursor is not such a declaration or it is "\@required".
4389 */
4391
4392/**
4393 * Returns non-zero if the given cursor is a variadic function or method.
4394 */
4396
4397/**
4398 * Returns non-zero if the given cursor points to a symbol marked with
4399 * external_source_symbol attribute.
4400 *
4401 * \param language If non-NULL, and the attribute is present, will be set to
4402 * the 'language' string from the attribute.
4403 *
4404 * \param definedIn If non-NULL, and the attribute is present, will be set to
4405 * the 'definedIn' string from the attribute.
4406 *
4407 * \param isGenerated If non-NULL, and the attribute is present, will be set to
4408 * non-zero if the 'generated_declaration' is set in the attribute.
4409 */
4411 CXString *language,
4412 CXString *definedIn,
4413 unsigned *isGenerated);
4414
4415/**
4416 * Given a cursor that represents a declaration, return the associated
4417 * comment's source range. The range may include multiple consecutive comments
4418 * with whitespace in between.
4419 */
4421
4422/**
4423 * Given a cursor that represents a declaration, return the associated
4424 * comment text, including comment markers.
4425 */
4427
4428/**
4429 * Given a cursor that represents a documentable entity (e.g.,
4430 * declaration), return the associated \paragraph; otherwise return the
4431 * first paragraph.
4432 */
4434
4435/**
4436 * @}
4437 */
4438
4439/** \defgroup CINDEX_MANGLE Name Mangling API Functions
4440 *
4441 * @{
4442 */
4443
4444/**
4445 * Retrieve the CXString representing the mangled name of the cursor.
4446 */
4448
4449/**
4450 * Retrieve the CXStrings representing the mangled symbols of the C++
4451 * constructor or destructor at the cursor.
4452 */
4454
4455/**
4456 * Retrieve the CXStrings representing the mangled symbols of the ObjC
4457 * class interface or implementation at the cursor.
4458 */
4460
4461/**
4462 * @}
4463 */
4464
4465/**
4466 * \defgroup CINDEX_MODULE Module introspection
4467 *
4468 * The functions in this group provide access to information about modules.
4469 *
4470 * @{
4471 */
4472
4473typedef void *CXModule;
4474
4475/**
4476 * Given a CXCursor_ModuleImportDecl cursor, return the associated module.
4477 */
4479
4480/**
4481 * Given a CXFile header file, return the module that contains it, if one
4482 * exists.
4483 */
4485
4486/**
4487 * \param Module a module object.
4488 *
4489 * \returns the module file where the provided module object came from.
4490 */
4492
4493/**
4494 * \param Module a module object.
4495 *
4496 * \returns the parent of a sub-module or NULL if the given module is top-level,
4497 * e.g. for 'std.vector' it will return the 'std' module.
4498 */
4500
4501/**
4502 * \param Module a module object.
4503 *
4504 * \returns the name of the module, e.g. for the 'std.vector' sub-module it
4505 * will return "vector".
4506 */
4508
4509/**
4510 * \param Module a module object.
4511 *
4512 * \returns the full name of the module, e.g. "std.vector".
4513 */
4515
4516/**
4517 * \param Module a module object.
4518 *
4519 * \returns non-zero if the module is a system one.
4520 */
4522
4523/**
4524 * \param Module a module object.
4525 *
4526 * \returns the number of top level headers associated with this module.
4527 */
4529 CXModule Module);
4530
4531/**
4532 * \param Module a module object.
4533 *
4534 * \param Index top level header index (zero-based).
4535 *
4536 * \returns the specified top level header associated with the module.
4537 */
4540 unsigned Index);
4541
4542/**
4543 * @}
4544 */
4545
4546/**
4547 * \defgroup CINDEX_CPP C++ AST introspection
4548 *
4549 * The routines in this group provide access information in the ASTs specific
4550 * to C++ language features.
4551 *
4552 * @{
4553 */
4554
4555/**
4556 * Determine if a C++ constructor is a converting constructor.
4557 */
4558CINDEX_LINKAGE unsigned
4560
4561/**
4562 * Determine if a C++ constructor is a copy constructor.
4563 */
4565
4566/**
4567 * Determine if a C++ constructor is the default constructor.
4568 */
4570
4571/**
4572 * Determine if a C++ constructor is a move constructor.
4573 */
4575
4576/**
4577 * Determine if a C++ field is declared 'mutable'.
4578 */
4580
4581/**
4582 * Determine if a C++ method is declared '= default'.
4583 */
4585
4586/**
4587 * Determine if a C++ method is declared '= delete'.
4588 */
4590
4591/**
4592 * Determine if a C++ member function or member function template is
4593 * pure virtual.
4594 */
4596
4597/**
4598 * Determine if a C++ member function or member function template is
4599 * declared 'static'.
4600 */
4602
4603/**
4604 * Determine if a C++ member function or member function template is
4605 * explicitly declared 'virtual' or if it overrides a virtual method from
4606 * one of the base classes.
4607 */
4609
4610/**
4611 * Determine if a C++ member function is a copy-assignment operator,
4612 * returning 1 if such is the case and 0 otherwise.
4613 *
4614 * > A copy-assignment operator `X::operator=` is a non-static,
4615 * > non-template member function of _class_ `X` with exactly one
4616 * > parameter of type `X`, `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 copy-assignment operator, while the `operator=` in:
4626 *
4627 * class Bar {
4628 * bool operator=(const int&);
4629 * };
4630 *
4631 * Is not.
4632 */
4634
4635/**
4636 * Determine if a C++ member function is a move-assignment operator,
4637 * returning 1 if such is the case and 0 otherwise.
4638 *
4639 * > A move-assignment operator `X::operator=` is a non-static,
4640 * > non-template member function of _class_ `X` with exactly one
4641 * > parameter of type `X&&`, `const X&&`, `volatile X&&` or `const
4642 * > volatile X&&`.
4643 *
4644 * That is, for example, the `operator=` in:
4645 *
4646 * class Foo {
4647 * bool operator=(const volatile Foo&&);
4648 * };
4649 *
4650 * Is a move-assignment operator, while the `operator=` in:
4651 *
4652 * class Bar {
4653 * bool operator=(const int&&);
4654 * };
4655 *
4656 * Is not.
4657 */
4659
4660/**
4661 * Determines if a C++ constructor or conversion function was declared
4662 * explicit, returning 1 if such is the case and 0 otherwise.
4663 *
4664 * Constructors or conversion functions are declared explicit through
4665 * the use of the explicit specifier.
4666 *
4667 * For example, the following constructor and conversion function are
4668 * not explicit as they lack the explicit specifier:
4669 *
4670 * class Foo {
4671 * Foo();
4672 * operator int();
4673 * };
4674 *
4675 * While the following constructor and conversion function are
4676 * explicit as they are declared with the explicit specifier.
4677 *
4678 * class Foo {
4679 * explicit Foo();
4680 * explicit operator int();
4681 * };
4682 *
4683 * This function will return 0 when given a cursor pointing to one of
4684 * the former declarations and it will return 1 for a cursor pointing
4685 * to the latter declarations.
4686 *
4687 * The explicit specifier allows the user to specify a
4688 * conditional compile-time expression whose value decides
4689 * whether the marked element is explicit or not.
4690 *
4691 * For example:
4692 *
4693 * constexpr bool foo(int i) { return i % 2 == 0; }
4694 *
4695 * class Foo {
4696 * explicit(foo(1)) Foo();
4697 * explicit(foo(2)) operator int();
4698 * }
4699 *
4700 * This function will return 0 for the constructor and 1 for
4701 * the conversion function.
4702 */
4704
4705/**
4706 * Determine if a C++ record is abstract, i.e. whether a class or struct
4707 * has a pure virtual member function.
4708 */
4710
4711/**
4712 * Determine if an enum declaration refers to a scoped enum.
4713 */
4715
4716/**
4717 * Determine if a C++ member function or member function template is
4718 * declared 'const'.
4719 */
4721
4722/**
4723 * Given a cursor that represents a template, determine
4724 * the cursor kind of the specializations would be generated by instantiating
4725 * the template.
4726 *
4727 * This routine can be used to determine what flavor of function template,
4728 * class template, or class template partial specialization is stored in the
4729 * cursor. For example, it can describe whether a class template cursor is
4730 * declared with "struct", "class" or "union".
4731 *
4732 * \param C The cursor to query. This cursor should represent a template
4733 * declaration.
4734 *
4735 * \returns The cursor kind of the specializations that would be generated
4736 * by instantiating the template \p C. If \p C is not a template, returns
4737 * \c CXCursor_NoDeclFound.
4738 */
4740
4741/**
4742 * Given a cursor that may represent a specialization or instantiation
4743 * of a template, retrieve the cursor that represents the template that it
4744 * specializes or from which it was instantiated.
4745 *
4746 * This routine determines the template involved both for explicit
4747 * specializations of templates and for implicit instantiations of the template,
4748 * both of which are referred to as "specializations". For a class template
4749 * specialization (e.g., \c std::vector<bool>), this routine will return
4750 * either the primary template (\c std::vector) or, if the specialization was
4751 * instantiated from a class template partial specialization, the class template
4752 * partial specialization. For a class template partial specialization and a
4753 * function template specialization (including instantiations), this
4754 * this routine will return the specialized template.
4755 *
4756 * For members of a class template (e.g., member functions, member classes, or
4757 * static data members), returns the specialized or instantiated member.
4758 * Although not strictly "templates" in the C++ language, members of class
4759 * templates have the same notions of specializations and instantiations that
4760 * templates do, so this routine treats them similarly.
4761 *
4762 * \param C A cursor that may be a specialization of a template or a member
4763 * of a template.
4764 *
4765 * \returns If the given cursor is a specialization or instantiation of a
4766 * template or a member thereof, the template or member that it specializes or
4767 * from which it was instantiated. Otherwise, returns a NULL cursor.
4768 */
4770
4771/**
4772 * Given a cursor that references something else, return the source range
4773 * covering that reference.
4774 *
4775 * \param C A cursor pointing to a member reference, a declaration reference, or
4776 * an operator call.
4777 * \param NameFlags A bitset with three independent flags:
4778 * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
4779 * CXNameRange_WantSinglePiece.
4780 * \param PieceIndex For contiguous names or when passing the flag
4781 * CXNameRange_WantSinglePiece, only one piece with index 0 is
4782 * available. When the CXNameRange_WantSinglePiece flag is not passed for a
4783 * non-contiguous names, this index can be used to retrieve the individual
4784 * pieces of the name. See also CXNameRange_WantSinglePiece.
4785 *
4786 * \returns The piece of the name pointed to by the given cursor. If there is no
4787 * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
4788 */
4790 CXCursor C, unsigned NameFlags, unsigned PieceIndex);
4791
4793 /**
4794 * Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
4795 * range.
4796 */
4798
4799 /**
4800 * Include the explicit template arguments, e.g. <int> in x.f<int>,
4801 * in the range.
4802 */
4804
4805 /**
4806 * If the name is non-contiguous, return the full spanning range.
4807 *
4808 * Non-contiguous names occur in Objective-C when a selector with two or more
4809 * parameters is used, or in C++ when using an operator:
4810 * \code
4811 * [object doSomething:here withValue:there]; // Objective-C
4812 * return some_vector[1]; // C++
4813 * \endcode
4814 */
4817
4818/**
4819 * @}
4820 */
4821
4822/**
4823 * \defgroup CINDEX_LEX Token extraction and manipulation
4824 *
4825 * The routines in this group provide access to the tokens within a
4826 * translation unit, along with a semantic mapping of those tokens to
4827 * their corresponding cursors.
4828 *
4829 * @{
4830 */
4831
4832/**
4833 * Describes a kind of token.
4834 */
4835typedef enum CXTokenKind {
4836 /**
4837 * A token that contains some kind of punctuation.
4838 */
4840
4841 /**
4842 * A language keyword.
4843 */
4845
4846 /**
4847 * An identifier (that is not a keyword).
4848 */
4850
4851 /**
4852 * A numeric, string, or character literal.
4853 */
4855
4856 /**
4857 * A comment.
4858 */
4861
4862/**
4863 * Describes a single preprocessing token.
4864 */
4865typedef struct {
4866 unsigned int_data[4];
4868} CXToken;
4869
4870/**
4871 * Get the raw lexical token starting with the given location.
4872 *
4873 * \param TU the translation unit whose text is being tokenized.
4874 *
4875 * \param Location the source location with which the token starts.
4876 *
4877 * \returns The token starting with the given location or NULL if no such token
4878 * exist. The returned pointer must be freed with clang_disposeTokens before the
4879 * translation unit is destroyed.
4880 */
4882 CXSourceLocation Location);
4883
4884/**
4885 * Determine the kind of the given token.
4886 */
4888
4889/**
4890 * Determine the spelling of the given token.
4891 *
4892 * The spelling of a token is the textual representation of that token, e.g.,
4893 * the text of an identifier or keyword.
4894 */
4896
4897/**
4898 * Retrieve the source location of the given token.
4899 */
4901 CXToken);
4902
4903/**
4904 * Retrieve a source range that covers the given token.
4905 */
4907
4908/**
4909 * Tokenize the source code described by the given range into raw
4910 * lexical tokens.
4911 *
4912 * \param TU the translation unit whose text is being tokenized.
4913 *
4914 * \param Range the source range in which text should be tokenized. All of the
4915 * tokens produced by tokenization will fall within this source range,
4916 *
4917 * \param Tokens this pointer will be set to point to the array of tokens
4918 * that occur within the given source range. The returned pointer must be
4919 * freed with clang_disposeTokens() before the translation unit is destroyed.
4920 *
4921 * \param NumTokens will be set to the number of tokens in the \c *Tokens
4922 * array.
4923 *
4924 */
4926 CXToken **Tokens, unsigned *NumTokens);
4927
4928/**
4929 * Annotate the given set of tokens by providing cursors for each token
4930 * that can be mapped to a specific entity within the abstract syntax tree.
4931 *
4932 * This token-annotation routine is equivalent to invoking
4933 * clang_getCursor() for the source locations of each of the
4934 * tokens. The cursors provided are filtered, so that only those
4935 * cursors that have a direct correspondence to the token are
4936 * accepted. For example, given a function call \c f(x),
4937 * clang_getCursor() would provide the following cursors:
4938 *
4939 * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
4940 * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
4941 * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
4942 *
4943 * Only the first and last of these cursors will occur within the
4944 * annotate, since the tokens "f" and "x' directly refer to a function
4945 * and a variable, respectively, but the parentheses are just a small
4946 * part of the full syntax of the function call expression, which is
4947 * not provided as an annotation.
4948 *
4949 * \param TU the translation unit that owns the given tokens.
4950 *
4951 * \param Tokens the set of tokens to annotate.
4952 *
4953 * \param NumTokens the number of tokens in \p Tokens.
4954 *
4955 * \param Cursors an array of \p NumTokens cursors, whose contents will be
4956 * replaced with the cursors corresponding to each token.
4957 */
4959 unsigned NumTokens, CXCursor *Cursors);
4960
4961/**
4962 * Free the given set of tokens.
4963 */
4965 unsigned NumTokens);
4966
4967/**
4968 * @}
4969 */
4970
4971/**
4972 * \defgroup CINDEX_DEBUG Debugging facilities
4973 *
4974 * These routines are used for testing and debugging, only, and should not
4975 * be relied upon.
4976 *
4977 * @{
4978 */
4979
4980/* for debug/testing */
4983 CXCursor, const char **startBuf, const char **endBuf, unsigned *startLine,
4984 unsigned *startColumn, unsigned *endLine, unsigned *endColumn);
4986CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void *), void *user_data,
4987 unsigned stack_size);
4988
4989/**
4990 * @}
4991 */
4992
4993/**
4994 * \defgroup CINDEX_CODE_COMPLET Code completion
4995 *
4996 * Code completion involves taking an (incomplete) source file, along with
4997 * knowledge of where the user is actively editing that file, and suggesting
4998 * syntactically- and semantically-valid constructs that the user might want to
4999 * use at that particular point in the source code. These data structures and
5000 * routines provide support for code completion.
5001 *
5002 * @{
5003 */
5004
5005/**
5006 * A semantic string that describes a code-completion result.
5007 *
5008 * A semantic string that describes the formatting of a code-completion
5009 * result as a single "template" of text that should be inserted into the
5010 * source buffer when a particular code-completion result is selected.
5011 * Each semantic string is made up of some number of "chunks", each of which
5012 * contains some text along with a description of what that text means, e.g.,
5013 * the name of the entity being referenced, whether the text chunk is part of
5014 * the template, or whether it is a "placeholder" that the user should replace
5015 * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
5016 * description of the different kinds of chunks.
5017 */
5019
5020/**
5021 * A single result of code completion.
5022 */
5023typedef struct {
5024 /**
5025 * The kind of entity that this completion refers to.
5026 *
5027 * The cursor kind will be a macro, keyword, or a declaration (one of the
5028 * *Decl cursor kinds), describing the entity that the completion is
5029 * referring to.
5030 *
5031 * \todo In the future, we would like to provide a full cursor, to allow
5032 * the client to extract additional information from declaration.
5033 */
5035
5036 /**
5037 * The code-completion string that describes how to insert this
5038 * code-completion result into the editing buffer.
5039 */
5042
5043/**
5044 * Describes a single piece of text within a code-completion string.
5045 *
5046 * Each "chunk" within a code-completion string (\c CXCompletionString) is
5047 * either a piece of text with a specific "kind" that describes how that text
5048 * should be interpreted by the client or is another completion string.
5049 */
5051 /**
5052 * A code-completion string that describes "optional" text that
5053 * could be a part of the template (but is not required).
5054 *
5055 * The Optional chunk is the only kind of chunk that has a code-completion
5056 * string for its representation, which is accessible via
5057 * \c clang_getCompletionChunkCompletionString(). The code-completion string
5058 * describes an additional part of the template that is completely optional.
5059 * For example, optional chunks can be used to describe the placeholders for
5060 * arguments that match up with defaulted function parameters, e.g. given:
5061 *
5062 * \code
5063 * void f(int x, float y = 3.14, double z = 2.71828);
5064 * \endcode
5065 *
5066 * The code-completion string for this function would contain:
5067 * - a TypedText chunk for "f".
5068 * - a LeftParen chunk for "(".
5069 * - a Placeholder chunk for "int x"
5070 * - an Optional chunk containing the remaining defaulted arguments, e.g.,
5071 * - a Comma chunk for ","
5072 * - a Placeholder chunk for "float y"
5073 * - an Optional chunk containing the last defaulted argument:
5074 * - a Comma chunk for ","
5075 * - a Placeholder chunk for "double z"
5076 * - a RightParen chunk for ")"
5077 *
5078 * There are many ways to handle Optional chunks. Two simple approaches are:
5079 * - Completely ignore optional chunks, in which case the template for the
5080 * function "f" would only include the first parameter ("int x").
5081 * - Fully expand all optional chunks, in which case the template for the
5082 * function "f" would have all of the parameters.
5083 */
5085 /**
5086 * Text that a user would be expected to type to get this
5087 * code-completion result.
5088 *
5089 * There will be exactly one "typed text" chunk in a semantic string, which
5090 * will typically provide the spelling of a keyword or the name of a
5091 * declaration that could be used at the current code point. Clients are
5092 * expected to filter the code-completion results based on the text in this
5093 * chunk.
5094 */
5096 /**
5097 * Text that should be inserted as part of a code-completion result.
5098 *
5099 * A "text" chunk represents text that is part of the template to be
5100 * inserted into user code should this particular code-completion result
5101 * be selected.
5102 */
5104 /**
5105 * Placeholder text that should be replaced by the user.
5106 *
5107 * A "placeholder" chunk marks a place where the user should insert text
5108 * into the code-completion template. For example, placeholders might mark
5109 * the function parameters for a function declaration, to indicate that the
5110 * user should provide arguments for each of those parameters. The actual
5111 * text in a placeholder is a suggestion for the text to display before
5112 * the user replaces the placeholder with real code.
5113 */
5115 /**
5116 * Informative text that should be displayed but never inserted as
5117 * part of the template.
5118 *
5119 * An "informative" chunk contains annotations that can be displayed to
5120 * help the user decide whether a particular code-completion result is the
5121 * right option, but which is not part of the actual template to be inserted
5122 * by code completion.
5123 */
5125 /**
5126 * Text that describes the current parameter when code-completion is
5127 * referring to function call, message send, or template specialization.
5128 *
5129 * A "current parameter" chunk occurs when code-completion is providing
5130 * information about a parameter corresponding to the argument at the
5131 * code-completion point. For example, given a function
5132 *
5133 * \code
5134 * int add(int x, int y);
5135 * \endcode
5136 *
5137 * and the source code \c add(, where the code-completion point is after the
5138 * "(", the code-completion string will contain a "current parameter" chunk
5139 * for "int x", indicating that the current argument will initialize that
5140 * parameter. After typing further, to \c add(17, (where the code-completion
5141 * point is after the ","), the code-completion string will contain a
5142 * "current parameter" chunk to "int y".
5143 */
5145 /**
5146 * A left parenthesis ('('), used to initiate a function call or
5147 * signal the beginning of a function parameter list.
5148 */
5150 /**
5151 * A right parenthesis (')'), used to finish a function call or
5152 * signal the end of a function parameter list.
5153 */
5155 /**
5156 * A left bracket ('[').
5157 */
5159 /**
5160 * A right bracket (']').
5161 */
5163 /**
5164 * A left brace ('{').
5165 */
5167 /**
5168 * A right brace ('}').
5169 */
5171 /**
5172 * A left angle bracket ('<').
5173 */
5175 /**
5176 * A right angle bracket ('>').
5177 */
5179 /**
5180 * A comma separator (',').
5181 */
5183 /**
5184 * Text that specifies the result type of a given result.
5185 *
5186 * This special kind of informative chunk is not meant to be inserted into
5187 * the text buffer. Rather, it is meant to illustrate the type that an
5188 * expression using the given completion string would have.
5189 */
5191 /**
5192 * A colon (':').
5193 */
5195 /**
5196 * A semicolon (';').
5197 */
5199 /**
5200 * An '=' sign.
5201 */
5203 /**
5204 * Horizontal space (' ').
5205 */
5207 /**
5208 * Vertical space ('\\n'), after which it is generally a good idea to
5209 * perform indentation.
5210 */
5213
5214/**
5215 * Determine the kind of a particular chunk within a completion string.
5216 *
5217 * \param completion_string the completion string to query.
5218 *
5219 * \param chunk_number the 0-based index of the chunk in the completion string.
5220 *
5221 * \returns the kind of the chunk at the index \c chunk_number.
5222 */
5225 unsigned chunk_number);
5226
5227/**
5228 * Retrieve the text associated with a particular chunk within a
5229 * completion string.
5230 *
5231 * \param completion_string the completion string to query.
5232 *
5233 * \param chunk_number the 0-based index of the chunk in the completion string.
5234 *
5235 * \returns the text associated with the chunk at index \c chunk_number.
5236 */
5238 CXCompletionString completion_string, unsigned chunk_number);
5239
5240/**
5241 * Retrieve the completion string associated with a particular chunk
5242 * within a completion string.
5243 *
5244 * \param completion_string the completion string to query.
5245 *
5246 * \param chunk_number the 0-based index of the chunk in the completion string.
5247 *
5248 * \returns the completion string associated with the chunk at index
5249 * \c chunk_number.
5250 */
5252 CXCompletionString completion_string, unsigned chunk_number);
5253
5254/**
5255 * Retrieve the number of chunks in the given code-completion string.
5256 */
5257CINDEX_LINKAGE unsigned
5259
5260/**
5261 * Determine the priority of this code completion.
5262 *
5263 * The priority of a code completion indicates how likely it is that this
5264 * particular completion is the completion that the user will select. The
5265 * priority is selected by various internal heuristics.
5266 *
5267 * \param completion_string The completion string to query.
5268 *
5269 * \returns The priority of this completion string. Smaller values indicate
5270 * higher-priority (more likely) completions.
5271 */
5272CINDEX_LINKAGE unsigned
5274
5275/**
5276 * Determine the availability of the entity that this code-completion
5277 * string refers to.
5278 *
5279 * \param completion_string The completion string to query.
5280 *
5281 * \returns The availability of the completion string.
5282 */
5285
5286/**
5287 * Retrieve the number of annotations associated with the given
5288 * completion string.
5289 *
5290 * \param completion_string the completion string to query.
5291 *
5292 * \returns the number of annotations associated with the given completion
5293 * string.
5294 */
5295CINDEX_LINKAGE unsigned
5297
5298/**
5299 * Retrieve the annotation associated with the given completion string.
5300 *
5301 * \param completion_string the completion string to query.
5302 *
5303 * \param annotation_number the 0-based index of the annotation of the
5304 * completion string.
5305 *
5306 * \returns annotation string associated with the completion at index
5307 * \c annotation_number, or a NULL string if that annotation is not available.
5308 */
5310 CXCompletionString completion_string, unsigned annotation_number);
5311
5312/**
5313 * Retrieve the parent context of the given completion string.
5314 *
5315 * The parent context of a completion string is the semantic parent of
5316 * the declaration (if any) that the code completion represents. For example,
5317 * a code completion for an Objective-C method would have the method's class
5318 * or protocol as its context.
5319 *
5320 * \param completion_string The code completion string whose parent is
5321 * being queried.
5322 *
5323 * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
5324 *
5325 * \returns The name of the completion parent, e.g., "NSObject" if
5326 * the completion string represents a method in the NSObject class.
5327 */
5329 CXCompletionString completion_string, enum CXCursorKind *kind);
5330
5331/**
5332 * Retrieve the brief documentation comment attached to the declaration
5333 * that corresponds to the given completion string.
5334 */
5337
5338/**
5339 * Retrieve a completion string for an arbitrary declaration or macro
5340 * definition cursor.
5341 *
5342 * \param cursor The cursor to query.
5343 *
5344 * \returns A non-context-sensitive completion string for declaration and macro
5345 * definition cursors, or NULL for other kinds of cursors.
5346 */
5349
5350/**
5351 * Contains the results of code-completion.
5352 *
5353 * This data structure contains the results of code completion, as
5354 * produced by \c clang_codeCompleteAt(). Its contents must be freed by
5355 * \c clang_disposeCodeCompleteResults.
5356 */
5357typedef struct {
5358 /**
5359 * The code-completion results.
5360 */
5362
5363 /**
5364 * The number of code-completion results stored in the
5365 * \c Results array.
5366 */
5367 unsigned NumResults;
5369
5370/**
5371 * Retrieve the number of fix-its for the given completion index.
5372 *
5373 * Calling this makes sense only if CXCodeComplete_IncludeCompletionsWithFixIts
5374 * option was set.
5375 *
5376 * \param results The structure keeping all completion results
5377 *
5378 * \param completion_index The index of the completion
5379 *
5380 * \return The number of fix-its which must be applied before the completion at
5381 * completion_index can be applied
5382 */
5383CINDEX_LINKAGE unsigned
5385 unsigned completion_index);
5386
5387/**
5388 * Fix-its that *must* be applied before inserting the text for the
5389 * corresponding completion.
5390 *
5391 * By default, clang_codeCompleteAt() only returns completions with empty
5392 * fix-its. Extra completions with non-empty fix-its should be explicitly
5393 * requested by setting CXCodeComplete_IncludeCompletionsWithFixIts.
5394 *
5395 * For the clients to be able to compute position of the cursor after applying
5396 * fix-its, the following conditions are guaranteed to hold for
5397 * replacement_range of the stored fix-its:
5398 * - Ranges in the fix-its are guaranteed to never contain the completion
5399 * point (or identifier under completion point, if any) inside them, except
5400 * at the start or at the end of the range.
5401 * - If a fix-it range starts or ends with completion point (or starts or
5402 * ends after the identifier under completion point), it will contain at
5403 * least one character. It allows to unambiguously recompute completion
5404 * point after applying the fix-it.
5405 *
5406 * The intuition is that provided fix-its change code around the identifier we
5407 * complete, but are not allowed to touch the identifier itself or the
5408 * completion point. One example of completions with corrections are the ones
5409 * replacing '.' with '->' and vice versa:
5410 *
5411 * std::unique_ptr<std::vector<int>> vec_ptr;
5412 * In 'vec_ptr.^', one of the completions is 'push_back', it requires
5413 * replacing '.' with '->'.
5414 * In 'vec_ptr->^', one of the completions is 'release', it requires
5415 * replacing '->' with '.'.
5416 *
5417 * \param results The structure keeping all completion results
5418 *
5419 * \param completion_index The index of the completion
5420 *
5421 * \param fixit_index The index of the fix-it for the completion at
5422 * completion_index
5423 *
5424 * \param replacement_range The fix-it range that must be replaced before the
5425 * completion at completion_index can be applied
5426 *
5427 * \returns The fix-it string that must replace the code at replacement_range
5428 * before the completion at completion_index can be applied
5429 */
5431 CXCodeCompleteResults *results, unsigned completion_index,
5432 unsigned fixit_index, CXSourceRange *replacement_range);
5433
5434/**
5435 * Flags that can be passed to \c clang_codeCompleteAt() to
5436 * modify its behavior.
5437 *
5438 * The enumerators in this enumeration can be bitwise-OR'd together to
5439 * provide multiple options to \c clang_codeCompleteAt().
5440 */
5442 /**
5443 * Whether to include macros within the set of code
5444 * completions returned.
5445 */
5447
5448 /**
5449 * Whether to include code patterns for language constructs
5450 * within the set of code completions, e.g., for loops.
5451 */
5453
5454 /**
5455 * Whether to include brief documentation within the set of code
5456 * completions returned.
5457 */
5459
5460 /**
5461 * Whether to speed up completion by omitting top- or namespace-level entities
5462 * defined in the preamble. There's no guarantee any particular entity is
5463 * omitted. This may be useful if the headers are indexed externally.
5464 */
5466
5467 /**
5468 * Whether to include completions with small
5469 * fix-its, e.g. change '.' to '->' on member access, etc.
5470 */
5473
5474/**
5475 * Bits that represent the context under which completion is occurring.
5476 *
5477 * The enumerators in this enumeration may be bitwise-OR'd together if multiple
5478 * contexts are occurring simultaneously.
5479 */
5481 /**
5482 * The context for completions is unexposed, as only Clang results
5483 * should be included. (This is equivalent to having no context bits set.)
5484 */
5486
5487 /**
5488 * Completions for any possible type should be included in the results.
5489 */
5491
5492 /**
5493 * Completions for any possible value (variables, function calls, etc.)
5494 * should be included in the results.
5495 */
5497 /**
5498 * Completions for values that resolve to an Objective-C object should
5499 * be included in the results.
5500 */
5502 /**
5503 * Completions for values that resolve to an Objective-C selector
5504 * should be included in the results.
5505 */
5507 /**
5508 * Completions for values that resolve to a C++ class type should be
5509 * included in the results.
5510 */
5512
5513 /**
5514 * Completions for fields of the member being accessed using the dot
5515 * operator should be included in the results.
5516 */
5518 /**
5519 * Completions for fields of the member being accessed using the arrow
5520 * operator should be included in the results.
5521 */
5523 /**
5524 * Completions for properties of the Objective-C object being accessed
5525 * using the dot operator should be included in the results.
5526 */
5528
5529 /**
5530 * Completions for enum tags should be included in the results.
5531 */
5533 /**
5534 * Completions for union tags should be included in the results.
5535 */
5537 /**
5538 * Completions for struct tags should be included in the results.
5539 */
5541
5542 /**
5543 * Completions for C++ class names should be included in the results.
5544 */
5546 /**
5547 * Completions for C++ namespaces and namespace aliases should be
5548 * included in the results.
5549 */
5551 /**
5552 * Completions for C++ nested name specifiers should be included in
5553 * the results.
5554 */
5556
5557 /**
5558 * Completions for Objective-C interfaces (classes) should be included
5559 * in the results.
5560 */
5562 /**
5563 * Completions for Objective-C protocols should be included in
5564 * the results.
5565 */
5567 /**
5568 * Completions for Objective-C categories should be included in
5569 * the results.
5570 */
5572 /**
5573 * Completions for Objective-C instance messages should be included
5574 * in the results.
5575 */
5577 /**
5578 * Completions for Objective-C class messages should be included in
5579 * the results.
5580 */
5582 /**
5583 * Completions for Objective-C selector names should be included in
5584 * the results.
5585 */
5587
5588 /**
5589 * Completions for preprocessor macro names should be included in
5590 * the results.
5591 */
5593
5594 /**
5595 * Natural language completions should be included in the results.
5596 */
5598
5599 /**
5600 * #include file completions should be included in the results.
5601 */
5603
5604 /**
5605 * The current context is unknown, so set all contexts.
5606 */
5607 CXCompletionContext_Unknown = ((1 << 23) - 1)
5609
5610/**
5611 * Returns a default set of code-completion options that can be
5612 * passed to\c clang_codeCompleteAt().
5613 */
5615
5616/**
5617 * Perform code completion at a given location in a translation unit.
5618 *
5619 * This function performs code completion at a particular file, line, and
5620 * column within source code, providing results that suggest potential
5621 * code snippets based on the context of the completion. The basic model
5622 * for code completion is that Clang will parse a complete source file,
5623 * performing syntax checking up to the location where code-completion has
5624 * been requested. At that point, a special code-completion token is passed
5625 * to the parser, which recognizes this token and determines, based on the
5626 * current location in the C/Objective-C/C++ grammar and the state of
5627 * semantic analysis, what completions to provide. These completions are
5628 * returned via a new \c CXCodeCompleteResults structure.
5629 *
5630 * Code completion itself is meant to be triggered by the client when the
5631 * user types punctuation characters or whitespace, at which point the
5632 * code-completion location will coincide with the cursor. For example, if \c p
5633 * is a pointer, code-completion might be triggered after the "-" and then
5634 * after the ">" in \c p->. When the code-completion location is after the ">",
5635 * the completion results will provide, e.g., the members of the struct that
5636 * "p" points to. The client is responsible for placing the cursor at the
5637 * beginning of the token currently being typed, then filtering the results
5638 * based on the contents of the token. For example, when code-completing for
5639 * the expression \c p->get, the client should provide the location just after
5640 * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
5641 * client can filter the results based on the current token text ("get"), only
5642 * showing those results that start with "get". The intent of this interface
5643 * is to separate the relatively high-latency acquisition of code-completion
5644 * results from the filtering of results on a per-character basis, which must
5645 * have a lower latency.
5646 *
5647 * \param TU The translation unit in which code-completion should
5648 * occur. The source files for this translation unit need not be
5649 * completely up-to-date (and the contents of those source files may
5650 * be overridden via \p unsaved_files). Cursors referring into the
5651 * translation unit may be invalidated by this invocation.
5652 *
5653 * \param complete_filename The name of the source file where code
5654 * completion should be performed. This filename may be any file
5655 * included in the translation unit.
5656 *
5657 * \param complete_line The line at which code-completion should occur.
5658 *
5659 * \param complete_column The column at which code-completion should occur.
5660 * Note that the column should point just after the syntactic construct that
5661 * initiated code completion, and not in the middle of a lexical token.
5662 *
5663 * \param unsaved_files the Files that have not yet been saved to disk
5664 * but may be required for parsing or code completion, including the
5665 * contents of those files. The contents and name of these files (as
5666 * specified by CXUnsavedFile) are copied when necessary, so the
5667 * client only needs to guarantee their validity until the call to
5668 * this function returns.
5669 *
5670 * \param num_unsaved_files The number of unsaved file entries in \p
5671 * unsaved_files.
5672 *
5673 * \param options Extra options that control the behavior of code
5674 * completion, expressed as a bitwise OR of the enumerators of the
5675 * CXCodeComplete_Flags enumeration. The
5676 * \c clang_defaultCodeCompleteOptions() function returns a default set
5677 * of code-completion options.
5678 *
5679 * \returns If successful, a new \c CXCodeCompleteResults structure
5680 * containing code-completion results, which should eventually be
5681 * freed with \c clang_disposeCodeCompleteResults(). If code
5682 * completion fails, returns NULL.
5683 */
5686clang_codeCompleteAt(CXTranslationUnit TU, const char *complete_filename,
5687 unsigned complete_line, unsigned complete_column,
5688 struct CXUnsavedFile *unsaved_files,
5689 unsigned num_unsaved_files, unsigned options);
5690
5691/**
5692 * Sort the code-completion results in case-insensitive alphabetical
5693 * order.
5694 *
5695 * \param Results The set of results to sort.
5696 * \param NumResults The number of results in \p Results.
5697 */
5700 unsigned NumResults);
5701
5702/**
5703 * Free the given set of code-completion results.
5704 */
5707
5708/**
5709 * Determine the number of diagnostics produced prior to the
5710 * location where code completion was performed.
5711 */
5714
5715/**
5716 * Retrieve a diagnostic associated with the given code completion.
5717 *
5718 * \param Results the code completion results to query.
5719 * \param Index the zero-based diagnostic number to retrieve.
5720 *
5721 * \returns the requested diagnostic. This diagnostic must be freed
5722 * via a call to \c clang_disposeDiagnostic().
5723 */
5726 unsigned Index);
5727
5728/**
5729 * Determines what completions are appropriate for the context
5730 * the given code completion.
5731 *
5732 * \param Results the code completion results to query
5733 *
5734 * \returns the kinds of completions that are appropriate for use
5735 * along with the given code completion results.
5736 */
5738unsigned long long
5740
5741/**
5742 * Returns the cursor kind for the container for the current code
5743 * completion context. The container is only guaranteed to be set for
5744 * contexts where a container exists (i.e. member accesses or Objective-C
5745 * message sends); if there is not a container, this function will return
5746 * CXCursor_InvalidCode.
5747 *
5748 * \param Results the code completion results to query
5749 *
5750 * \param IsIncomplete on return, this value will be false if Clang has complete
5751 * information about the container. If Clang does not have complete
5752 * information, this value will be true.
5753 *
5754 * \returns the container kind, or CXCursor_InvalidCode if there is not a
5755 * container
5756 */
5758enum CXCursorKind
5760 unsigned *IsIncomplete);
5761
5762/**
5763 * Returns the USR for the container for the current code completion
5764 * context. If there is not a container for the current context, this
5765 * function will return the empty string.
5766 *
5767 * \param Results the code completion results to query
5768 *
5769 * \returns the USR for the container
5770 */
5773
5774/**
5775 * Returns the currently-entered selector for an Objective-C message
5776 * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
5777 * non-empty string for CXCompletionContext_ObjCInstanceMessage and
5778 * CXCompletionContext_ObjCClassMessage.
5779 *
5780 * \param Results the code completion results to query
5781 *
5782 * \returns the selector (or partial selector) that has been entered thus far
5783 * for an Objective-C message send.
5784 */
5787
5788/**
5789 * @}
5790 */
5791
5792/**
5793 * \defgroup CINDEX_MISC Miscellaneous utility functions
5794 *
5795 * @{
5796 */
5797
5798/**
5799 * Return a version string, suitable for showing to a user, but not
5800 * intended to be parsed (the format is not guaranteed to be stable).
5801 */
5803
5804/**
5805 * Enable/disable crash recovery.
5806 *
5807 * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero
5808 * value enables crash recovery, while 0 disables it.
5809 */
5811
5812/**
5813 * Visitor invoked for each file in a translation unit
5814 * (used with clang_getInclusions()).
5815 *
5816 * This visitor function will be invoked by clang_getInclusions() for each
5817 * file included (either at the top-level or by \#include directives) within
5818 * a translation unit. The first argument is the file being included, and
5819 * the second and third arguments provide the inclusion stack. The
5820 * array is sorted in order of immediate inclusion. For example,
5821 * the first element refers to the location that included 'included_file'.
5822 */
5823typedef void (*CXInclusionVisitor)(CXFile included_file,
5824 CXSourceLocation *inclusion_stack,
5825 unsigned include_len,
5826 CXClientData client_data);
5827
5828/**
5829 * Visit the set of preprocessor inclusions in a translation unit.
5830 * The visitor function is called with the provided data for every included
5831 * file. This does not include headers included by the PCH file (unless one
5832 * is inspecting the inclusions in the PCH file itself).
5833 */
5835 CXInclusionVisitor visitor,
5836 CXClientData client_data);
5837
5838typedef enum {
5845
5847
5849
5850/**
5851 * Evaluation result of a cursor
5852 */
5853typedef void *CXEvalResult;
5854
5855/**
5856 * If cursor is a statement declaration tries to evaluate the
5857 * statement and if its variable, tries to evaluate its initializer,
5858 * into its corresponding type.
5859 * If it's an expression, tries to evaluate the expression.
5860 */
5862
5863/**
5864 * Returns the kind of the evaluated result.
5865 */
5867
5868/**
5869 * Returns the evaluation result as integer if the
5870 * kind is Int.
5871 */
5873
5874/**
5875 * Returns the evaluation result as a long long integer if the
5876 * kind is Int. This prevents overflows that may happen if the result is
5877 * returned with clang_EvalResult_getAsInt.
5878 */
5880
5881/**
5882 * Returns a non-zero value if the kind is Int and the evaluation
5883 * result resulted in an unsigned integer.
5884 */
5886
5887/**
5888 * Returns the evaluation result as an unsigned integer if
5889 * the kind is Int and clang_EvalResult_isUnsignedInt is non-zero.
5890 */
5891CINDEX_LINKAGE unsigned long long
5893
5894/**
5895 * Returns the evaluation result as double if the
5896 * kind is double.
5897 */
5899
5900/**
5901 * Returns the evaluation result as a constant string if the
5902 * kind is other than Int or float. User must not free this pointer,
5903 * instead call clang_EvalResult_dispose on the CXEvalResult returned
5904 * by clang_Cursor_Evaluate.
5905 */
5907
5908/**
5909 * Disposes the created Eval memory.
5910 */
5912/**
5913 * @}
5914 */
5915
5916/** \defgroup CINDEX_HIGH Higher level API functions
5917 *
5918 * @{
5919 */
5920
5922
5924 void *context;
5927
5928typedef enum {
5929 /**
5930 * Function returned successfully.
5931 */
5933 /**
5934 * One of the parameters was invalid for the function.
5935 */
5937 /**
5938 * The function was terminated by a callback (e.g. it returned
5939 * CXVisit_Break)
5940 */
5942
5944
5945/**
5946 * Find references of a declaration in a specific file.
5947 *
5948 * \param cursor pointing to a declaration or a reference of one.
5949 *
5950 * \param file to search for references.
5951 *
5952 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5953 * each reference found.
5954 * The CXSourceRange will point inside the file; if the reference is inside
5955 * a macro (and not a macro argument) the CXSourceRange will be invalid.
5956 *
5957 * \returns one of the CXResult enumerators.
5958 */
5960 CXCursor cursor, CXFile file, CXCursorAndRangeVisitor visitor);
5961
5962/**
5963 * Find #import/#include directives in a specific file.
5964 *
5965 * \param TU translation unit containing the file to query.
5966 *
5967 * \param file to search for #import/#include directives.
5968 *
5969 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5970 * each directive found.
5971 *
5972 * \returns one of the CXResult enumerators.
5973 */
5976
5977#if __has_feature(blocks)
5980#else
5981typedef struct _CXCursorAndRangeVisitorBlock *CXCursorAndRangeVisitorBlock;
5982#endif
5983
5987
5991
5992/**
5993 * The client's data object that is associated with a CXFile.
5994 */
5995typedef void *CXIdxClientFile;
5996
5997/**
5998 * The client's data object that is associated with a semantic entity.
5999 */
6000typedef void *CXIdxClientEntity;
6001
6002/**
6003 * The client's data object that is associated with a semantic container
6004 * of entities.
6005 */
6007
6008/**
6009 * The client's data object that is associated with an AST file (PCH
6010 * or module).
6011 */
6013
6014/**
6015 * Source location passed to index callbacks.
6016 */
6017typedef struct {
6018 void *ptr_data[2];
6019 unsigned int_data;
6020} CXIdxLoc;
6021
6022/**
6023 * Data for ppIncludedFile callback.
6024 */
6025typedef struct {
6026 /**
6027 * Location of '#' in the \#include/\#import directive.
6028 */
6030 /**
6031 * Filename as written in the \#include/\#import directive.
6032 */
6033 const char *filename;
6034 /**
6035 * The actual file that the \#include/\#import directive resolved to.
6036 */
6040 /**
6041 * Non-zero if the directive was automatically turned into a module
6042 * import.
6043 */
6046
6047/**
6048 * Data for IndexerCallbacks#importedASTFile.
6049 */
6050typedef struct {
6051 /**
6052 * Top level AST file containing the imported PCH, module or submodule.
6053 */
6055 /**
6056 * The imported module or NULL if the AST file is a PCH.
6057 */
6059 /**
6060 * Location where the file is imported. Applicable only for modules.
6061 */
6063 /**
6064 * Non-zero if an inclusion directive was automatically turned into
6065 * a module import. Applicable only for modules.
6066 */
6068
6070
6071typedef enum {
6078
6082
6087
6091
6104
6106
6107typedef enum {
6114
6115/**
6116 * Extra C++ template information for an entity. This can apply to:
6117 * CXIdxEntity_Function
6118 * CXIdxEntity_CXXClass
6119 * CXIdxEntity_CXXStaticMethod
6120 * CXIdxEntity_CXXInstanceMethod
6121 * CXIdxEntity_CXXConstructor
6122 * CXIdxEntity_CXXConversionFunction
6123 * CXIdxEntity_CXXTypeAlias
6124 */
6125typedef enum {
6131
6132typedef enum {
6138
6139typedef struct {
6144
6145typedef struct {
6149 const char *name;
6150 const char *USR;
6155
6156typedef struct {
6159
6160typedef struct {
6166
6168
6169typedef struct {
6174 /**
6175 * Generally same as #semanticContainer but can be different in
6176 * cases like out-of-line C++ member functions.
6177 */
6183 /**
6184 * Whether the declaration exists in code or was created implicitly
6185 * by the compiler, e.g. implicit Objective-C methods for properties.
6186 */
6190
6191 unsigned flags;
6192
6194
6195typedef enum {
6200
6201typedef struct {
6205
6206typedef struct {
6211
6212typedef struct {
6217
6218typedef struct {
6222
6223typedef struct {
6228
6229typedef struct {
6236
6237typedef struct {
6242
6243typedef struct {
6246 unsigned numBases;
6248
6249/**
6250 * Data for IndexerCallbacks#indexEntityReference.
6251 *
6252 * This may be deprecated in a future version as this duplicates
6253 * the \c CXSymbolRole_Implicit bit in \c CXSymbolRole.
6254 */
6255typedef enum {
6256 /**
6257 * The entity is referenced directly in user's code.
6258 */
6260 /**
6261 * An implicit reference, e.g. a reference of an Objective-C method
6262 * via the dot syntax.
6263 */
6266
6267/**
6268 * Roles that are attributed to symbol occurrences.
6269 *
6270 * Internal: this currently mirrors low 9 bits of clang::index::SymbolRole with
6271 * higher bits zeroed. These high bits may be exposed in the future.
6272 */
6273typedef enum {
6283 CXSymbolRole_Implicit = 1 << 8
6285
6286/**
6287 * Data for IndexerCallbacks#indexEntityReference.
6288 */
6289typedef struct {
6291 /**
6292 * Reference cursor.
6293 */
6296 /**
6297 * The entity that gets referenced.
6298 */
6300 /**
6301 * Immediate "parent" of the reference. For example:
6302 *
6303 * \code
6304 * Foo *var;
6305 * \endcode
6306 *
6307 * The parent of reference of type 'Foo' is the variable 'var'.
6308 * For references inside statement bodies of functions/methods,
6309 * the parentEntity will be the function/method.
6310 */
6312 /**
6313 * Lexical container context of the reference.
6314 */
6316 /**
6317 * Sets of symbol roles of the reference.
6318 */
6321
6322/**
6323 * A group of callbacks used by #clang_indexSourceFile and
6324 * #clang_indexTranslationUnit.
6325 */
6326typedef struct {
6327 /**
6328 * Called periodically to check whether indexing should be aborted.
6329 * Should return 0 to continue, and non-zero to abort.
6330 */
6331 int (*abortQuery)(CXClientData client_data, void *reserved);
6332
6333 /**
6334 * Called at the end of indexing; passes the complete diagnostic set.
6335 */
6336 void (*diagnostic)(CXClientData client_data, CXDiagnosticSet, void *reserved);
6337
6338 CXIdxClientFile (*enteredMainFile)(CXClientData client_data, CXFile mainFile,
6339 void *reserved);
6340
6341 /**
6342 * Called when a file gets \#included/\#imported.
6343 */
6344 CXIdxClientFile (*ppIncludedFile)(CXClientData client_data,
6345 const CXIdxIncludedFileInfo *);
6346
6347 /**
6348 * Called when a AST file (PCH or module) gets imported.
6349 *
6350 * AST files will not get indexed (there will not be callbacks to index all
6351 * the entities in an AST file). The recommended action is that, if the AST
6352 * file is not already indexed, to initiate a new indexing job specific to
6353 * the AST file.
6354 */
6355 CXIdxClientASTFile (*importedASTFile)(CXClientData client_data,
6356 const CXIdxImportedASTFileInfo *);
6357
6358 /**
6359 * Called at the beginning of indexing a translation unit.
6360 */
6361 CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data,
6362 void *reserved);
6363
6364 void (*indexDeclaration)(CXClientData client_data, const CXIdxDeclInfo *);
6365
6366 /**
6367 * Called to index a reference of an entity.
6368 */
6369 void (*indexEntityReference)(CXClientData client_data,
6370 const CXIdxEntityRefInfo *);
6371
6373
6377
6380
6384
6387
6390
6393
6396
6397/**
6398 * For retrieving a custom CXIdxClientContainer attached to a
6399 * container.
6400 */
6403
6404/**
6405 * For setting a custom CXIdxClientContainer attached to a
6406 * container.
6407 */
6410
6411/**
6412 * For retrieving a custom CXIdxClientEntity attached to an entity.
6413 */
6416
6417/**
6418 * For setting a custom CXIdxClientEntity attached to an entity.
6419 */
6422
6423/**
6424 * An indexing action/session, to be applied to one or multiple
6425 * translation units.
6426 */
6427typedef void *CXIndexAction;
6428
6429/**
6430 * An indexing action/session, to be applied to one or multiple
6431 * translation units.
6432 *
6433 * \param CIdx The index object with which the index action will be associated.
6434 */
6436
6437/**
6438 * Destroy the given index action.
6439 *
6440 * The index action must not be destroyed until all of the translation units
6441 * created within that index action have been destroyed.
6442 */
6444
6445typedef enum {
6446 /**
6447 * Used to indicate that no special indexing options are needed.
6448 */
6450
6451 /**
6452 * Used to indicate that IndexerCallbacks#indexEntityReference should
6453 * be invoked for only one reference of an entity per source file that does
6454 * not also include a declaration/definition of the entity.
6455 */
6457
6458 /**
6459 * Function-local symbols should be indexed. If this is not set
6460 * function-local symbols will be ignored.
6461 */
6463
6464 /**
6465 * Implicit function/class template instantiations should be indexed.
6466 * If this is not set, implicit instantiations will be ignored.
6467 */
6469
6470 /**
6471 * Suppress all compiler warnings when parsing for indexing.
6472 */
6474
6475 /**
6476 * Skip a function/method body that was already parsed during an
6477 * indexing session associated with a \c CXIndexAction object.
6478 * Bodies in system headers are always skipped.
6479 */
6481
6483
6484/**
6485 * Index the given source file and the translation unit corresponding
6486 * to that file via callbacks implemented through #IndexerCallbacks.
6487 *
6488 * \param client_data pointer data supplied by the client, which will
6489 * be passed to the invoked callbacks.
6490 *
6491 * \param index_callbacks Pointer to indexing callbacks that the client
6492 * implements.
6493 *
6494 * \param index_callbacks_size Size of #IndexerCallbacks structure that gets
6495 * passed in index_callbacks.
6496 *
6497 * \param index_options A bitmask of options that affects how indexing is
6498 * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags.
6499 *
6500 * \param[out] out_TU pointer to store a \c CXTranslationUnit that can be
6501 * reused after indexing is finished. Set to \c NULL if you do not require it.
6502 *
6503 * \returns 0 on success or if there were errors from which the compiler could
6504 * recover. If there is a failure from which there is no recovery, returns
6505 * a non-zero \c CXErrorCode.
6506 *
6507 * The rest of the parameters are the same as #clang_parseTranslationUnit.
6508 */
6510 CXIndexAction, CXClientData client_data, IndexerCallbacks *index_callbacks,
6511 unsigned index_callbacks_size, unsigned index_options,
6512 const char *source_filename, const char *const *command_line_args,
6513 int num_command_line_args, struct CXUnsavedFile *unsaved_files,
6514 unsigned num_unsaved_files, CXTranslationUnit *out_TU, unsigned TU_options);
6515
6516/**
6517 * Same as clang_indexSourceFile but requires a full command line
6518 * for \c command_line_args including argv[0]. This is useful if the standard
6519 * library paths are relative to the binary.
6520 */
6522 CXIndexAction, CXClientData client_data, IndexerCallbacks *index_callbacks,
6523 unsigned index_callbacks_size, unsigned index_options,
6524 const char *source_filename, const char *const *command_line_args,
6525 int num_command_line_args, struct CXUnsavedFile *unsaved_files,
6526 unsigned num_unsaved_files, CXTranslationUnit *out_TU, unsigned TU_options);
6527
6528/**
6529 * Index the given translation unit via callbacks implemented through
6530 * #IndexerCallbacks.
6531 *
6532 * The order of callback invocations is not guaranteed to be the same as
6533 * when indexing a source file. The high level order will be:
6534 *
6535 * -Preprocessor callbacks invocations
6536 * -Declaration/reference callbacks invocations
6537 * -Diagnostic callback invocations
6538 *
6539 * The parameters are the same as #clang_indexSourceFile.
6540 *
6541 * \returns If there is a failure from which there is no recovery, returns
6542 * non-zero, otherwise returns 0.
6543 */
6545 CXIndexAction, CXClientData client_data, IndexerCallbacks *index_callbacks,
6546 unsigned index_callbacks_size, unsigned index_options, CXTranslationUnit);
6547
6548/**
6549 * Retrieve the CXIdxFile, file, line, column, and offset represented by
6550 * the given CXIdxLoc.
6551 *
6552 * If the location refers into a macro expansion, retrieves the
6553 * location of the macro expansion and if it refers into a macro argument
6554 * retrieves the location of the argument.
6555 */
6557 CXIdxClientFile *indexFile,
6558 CXFile *file, unsigned *line,
6559 unsigned *column,
6560 unsigned *offset);
6561
6562/**
6563 * Retrieve the CXSourceLocation represented by the given CXIdxLoc.
6564 */
6567
6568/**
6569 * Visitor invoked for each field found by a traversal.
6570 *
6571 * This visitor function will be invoked for each field found by
6572 * \c clang_Type_visitFields. Its first argument is the cursor being
6573 * visited, its second argument is the client data provided to
6574 * \c clang_Type_visitFields.
6575 *
6576 * The visitor should return one of the \c CXVisitorResult values
6577 * to direct \c clang_Type_visitFields.
6578 */
6579typedef enum CXVisitorResult (*CXFieldVisitor)(CXCursor C,
6580 CXClientData client_data);
6581
6582/**
6583 * Visit the fields of a particular type.
6584 *
6585 * This function visits all the direct fields of the given cursor,
6586 * invoking the given \p visitor function with the cursors of each
6587 * visited field. The traversal may be ended prematurely, if
6588 * the visitor returns \c CXFieldVisit_Break.
6589 *
6590 * \param T the record type whose field may be visited.
6591 *
6592 * \param visitor the visitor function that will be invoked for each
6593 * field of \p T.
6594 *
6595 * \param client_data pointer data supplied by the client, which will
6596 * be passed to the visitor each time it is invoked.
6597 *
6598 * \returns a non-zero value if the traversal was terminated
6599 * prematurely by the visitor returning \c CXFieldVisit_Break.
6600 */
6602 CXClientData client_data);
6603
6604/**
6605 * Visit the base classes of a type.
6606 *
6607 * This function visits all the direct base classes of a the given cursor,
6608 * invoking the given \p visitor function with the cursors of each
6609 * visited base. The traversal may be ended prematurely, if
6610 * the visitor returns \c CXFieldVisit_Break.
6611 *
6612 * \param T the record type whose field may be visited.
6613 *
6614 * \param visitor the visitor function that will be invoked for each
6615 * field of \p T.
6616 *
6617 * \param client_data pointer data supplied by the client, which will
6618 * be passed to the visitor each time it is invoked.
6619 *
6620 * \returns a non-zero value if the traversal was terminated
6621 * prematurely by the visitor returning \c CXFieldVisit_Break.
6622 */
6624 CXFieldVisitor visitor,
6625 CXClientData client_data);
6626
6627/**
6628 * Describes the kind of binary operators.
6629 */
6631 /** This value describes cursors which are not binary operators. */
6633 /** C++ Pointer - to - member operator. */
6635 /** C++ Pointer - to - member operator. */
6637 /** Multiplication operator. */
6639 /** Division operator. */
6641 /** Remainder operator. */
6643 /** Addition operator. */
6645 /** Subtraction operator. */
6647 /** Bitwise shift left operator. */
6649 /** Bitwise shift right operator. */
6651 /** C++ three-way comparison (spaceship) operator. */
6653 /** Less than operator. */
6655 /** Greater than operator. */
6657 /** Less or equal operator. */
6659 /** Greater or equal operator. */
6661 /** Equal operator. */
6663 /** Not equal operator. */
6665 /** Bitwise AND operator. */
6667 /** Bitwise XOR operator. */
6669 /** Bitwise OR operator. */
6671 /** Logical AND operator. */
6673 /** Logical OR operator. */
6675 /** Assignment operator. */
6677 /** Multiplication assignment operator. */
6679 /** Division assignment operator. */
6681 /** Remainder assignment operator. */
6683 /** Addition assignment operator. */
6685 /** Subtraction assignment operator. */
6687 /** Bitwise shift left assignment operator. */
6689 /** Bitwise shift right assignment operator. */
6691 /** Bitwise AND assignment operator. */
6693 /** Bitwise XOR assignment operator. */
6695 /** Bitwise OR assignment operator. */
6697 /** Comma operator. */
6700
6701/**
6702 * Retrieve the spelling of a given CXBinaryOperatorKind.
6703 */
6706
6707/**
6708 * Retrieve the binary operator kind of this cursor.
6709 *
6710 * If this cursor is not a binary operator then returns Invalid.
6711 */
6714
6715/**
6716 * Describes the kind of unary operators.
6717 */
6719 /** This value describes cursors which are not unary operators. */
6721 /** Postfix increment operator. */
6723 /** Postfix decrement operator. */
6725 /** Prefix increment operator. */
6727 /** Prefix decrement operator. */
6729 /** Address of operator. */
6731 /** Dereference operator. */
6733 /** Plus operator. */
6735 /** Minus operator. */
6737 /** Not operator. */
6739 /** LNot operator. */
6741 /** "__real expr" operator. */
6743 /** "__imag expr" operator. */
6745 /** __extension__ marker operator. */
6747 /** C++ co_await operator. */
6750
6751/**
6752 * Retrieve the spelling of a given CXUnaryOperatorKind.
6753 */
6756
6757/**
6758 * Retrieve the unary operator kind of this cursor.
6759 *
6760 * If this cursor is not a unary operator then returns Invalid.
6761 */
6764
6765/**
6766 * @}
6767 */
6768
6769/**
6770 * @}
6771 */
6772
6774
6775#endif
NodeId Parent
Definition: ASTDiff.cpp:191
static unsigned isEnabled(DiagnosticsEngine &D, unsigned diag)
CXErrorCode
Error codes returned by libclang routines.
Definition: CXErrorCode.h:28
enum clang::sema::@1704::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:5480
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:5050
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:5441
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:5018
@ CXCompletionContext_AnyValue
Completions for any possible value (variables, function calls, etc.) should be included in the result...
Definition: Index.h:5496
@ CXCompletionContext_ObjCSelectorName
Completions for Objective-C selector names should be included in the results.
Definition: Index.h:5586
@ CXCompletionContext_ObjCProtocol
Completions for Objective-C protocols should be included in the results.
Definition: Index.h:5566
@ CXCompletionContext_MacroName
Completions for preprocessor macro names should be included in the results.
Definition: Index.h:5592
@ CXCompletionContext_NaturalLanguage
Natural language completions should be included in the results.
Definition: Index.h:5597
@ CXCompletionContext_AnyType
Completions for any possible type should be included in the results.
Definition: Index.h:5490
@ CXCompletionContext_StructTag
Completions for struct tags should be included in the results.
Definition: Index.h:5540
@ CXCompletionContext_CXXClassTypeValue
Completions for values that resolve to a C++ class type should be included in the results.
Definition: Index.h:5511
@ CXCompletionContext_ObjCClassMessage
Completions for Objective-C class messages should be included in the results.
Definition: Index.h:5581
@ CXCompletionContext_Unexposed
The context for completions is unexposed, as only Clang results should be included.
Definition: Index.h:5485
@ CXCompletionContext_Unknown
The current context is unknown, so set all contexts.
Definition: Index.h:5607
@ CXCompletionContext_ArrowMemberAccess
Completions for fields of the member being accessed using the arrow operator should be included in th...
Definition: Index.h:5522
@ CXCompletionContext_ObjCObjectValue
Completions for values that resolve to an Objective-C object should be included in the results.
Definition: Index.h:5501
@ CXCompletionContext_UnionTag
Completions for union tags should be included in the results.
Definition: Index.h:5536
@ CXCompletionContext_DotMemberAccess
Completions for fields of the member being accessed using the dot operator should be included in the ...
Definition: Index.h:5517
@ CXCompletionContext_NestedNameSpecifier
Completions for C++ nested name specifiers should be included in the results.
Definition: Index.h:5555
@ CXCompletionContext_ObjCPropertyAccess
Completions for properties of the Objective-C object being accessed using the dot operator should be ...
Definition: Index.h:5527
@ CXCompletionContext_ObjCInstanceMessage
Completions for Objective-C instance messages should be included in the results.
Definition: Index.h:5576
@ CXCompletionContext_ObjCInterface
Completions for Objective-C interfaces (classes) should be included in the results.
Definition: Index.h:5561
@ CXCompletionContext_EnumTag
Completions for enum tags should be included in the results.
Definition: Index.h:5532
@ CXCompletionContext_ClassTag
Completions for C++ class names should be included in the results.
Definition: Index.h:5545
@ CXCompletionContext_ObjCSelectorValue
Completions for values that resolve to an Objective-C selector should be included in the results.
Definition: Index.h:5506
@ CXCompletionContext_Namespace
Completions for C++ namespaces and namespace aliases should be included in the results.
Definition: Index.h:5550
@ CXCompletionContext_ObjCCategory
Completions for Objective-C categories should be included in the results.
Definition: Index.h:5571
@ CXCompletionContext_IncludedFile
#include file completions should be included in the results.
Definition: Index.h:5602
@ CXCompletionChunk_RightBracket
A right bracket (']').
Definition: Index.h:5162
@ CXCompletionChunk_RightBrace
A right brace ('}').
Definition: Index.h:5170
@ CXCompletionChunk_LeftBracket
A left bracket ('[').
Definition: Index.h:5158
@ CXCompletionChunk_CurrentParameter
Text that describes the current parameter when code-completion is referring to function call,...
Definition: Index.h:5144
@ CXCompletionChunk_Placeholder
Placeholder text that should be replaced by the user.
Definition: Index.h:5114
@ CXCompletionChunk_LeftAngle
A left angle bracket ('<').
Definition: Index.h:5174
@ CXCompletionChunk_Colon
A colon (':').
Definition: Index.h:5194
@ CXCompletionChunk_HorizontalSpace
Horizontal space (' ').
Definition: Index.h:5206
@ CXCompletionChunk_LeftParen
A left parenthesis ('('), used to initiate a function call or signal the beginning of a function para...
Definition: Index.h:5149
@ CXCompletionChunk_Informative
Informative text that should be displayed but never inserted as part of the template.
Definition: Index.h:5124
@ CXCompletionChunk_RightParen
A right parenthesis (')'), used to finish a function call or signal the end of a function parameter l...
Definition: Index.h:5154
@ CXCompletionChunk_SemiColon
A semicolon (';').
Definition: Index.h:5198
@ CXCompletionChunk_TypedText
Text that a user would be expected to type to get this code-completion result.
Definition: Index.h:5095
@ CXCompletionChunk_LeftBrace
A left brace ('{').
Definition: Index.h:5166
@ CXCompletionChunk_ResultType
Text that specifies the result type of a given result.
Definition: Index.h:5190
@ CXCompletionChunk_Text
Text that should be inserted as part of a code-completion result.
Definition: Index.h:5103
@ CXCompletionChunk_Comma
A comma separator (',').
Definition: Index.h:5182
@ CXCompletionChunk_Equal
An '=' sign.
Definition: Index.h:5202
@ CXCompletionChunk_Optional
A code-completion string that describes "optional" text that could be a part of the template (but is ...
Definition: Index.h:5084
@ CXCompletionChunk_VerticalSpace
Vertical space ('\n'), after which it is generally a good idea to perform indentation.
Definition: Index.h:5211
@ CXCompletionChunk_RightAngle
A right angle bracket ('>').
Definition: Index.h:5178
@ CXCodeComplete_IncludeCodePatterns
Whether to include code patterns for language constructs within the set of code completions,...
Definition: Index.h:5452
@ CXCodeComplete_IncludeBriefComments
Whether to include brief documentation within the set of code completions returned.
Definition: Index.h:5458
@ CXCodeComplete_SkipPreamble
Whether to speed up completion by omitting top- or namespace-level entities defined in the preamble.
Definition: Index.h:5465
@ CXCodeComplete_IncludeMacros
Whether to include macros within the set of code completions returned.
Definition: Index.h:5446
@ CXCodeComplete_IncludeCompletionsWithFixIts
Whether to include completions with small fix-its, e.g.
Definition: Index.h:5471
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:4792
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:4803
@ CXNameRange_WantSinglePiece
If the name is non-contiguous, return the full spanning range.
Definition: Index.h:4815
@ CXNameRange_WantQualifier
Include the nested-name-specifier, e.g.
Definition: Index.h:4797
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:2613
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:2629
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:2645
CXLinkageKind
Describe the linkage of the entity referred to by a cursor.
Definition: Index.h:2446
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:2469
CINDEX_LINKAGE unsigned clang_isInvalidDeclaration(CXCursor)
Determine whether the given declaration is invalid.
@ CXLanguage_CPlusPlus
Definition: Index.h:2617
@ CXLanguage_C
Definition: Index.h:2615
@ CXLanguage_Invalid
Definition: Index.h:2614
@ CXLanguage_ObjC
Definition: Index.h:2616
@ CXTLS_None
Definition: Index.h:2629
@ CXTLS_Static
Definition: Index.h:2629
@ CXTLS_Dynamic
Definition: Index.h:2629
@ CXLinkage_NoLinkage
This is the linkage for variables, parameters, and so on that have automatic storage.
Definition: Index.h:2454
@ CXLinkage_Invalid
This value indicates that no linkage information is available for a provided CXCursor.
Definition: Index.h:2449
@ CXLinkage_Internal
This is the linkage for static variables and static functions.
Definition: Index.h:2456
@ CXLinkage_External
This is the linkage for entities with true, external linkage.
Definition: Index.h:2461
@ CXLinkage_UniqueExternal
This is the linkage for entities with external linkage that live in C++ anonymous namespaces.
Definition: Index.h:2459
@ CXVisibility_Protected
Symbol seen by the linker but resolves to a symbol inside this object.
Definition: Index.h:2477
@ CXVisibility_Hidden
Symbol not seen by the linker.
Definition: Index.h:2475
@ CXVisibility_Default
Symbol seen by the linker and acts like a normal symbol.
Definition: Index.h:2479
@ CXVisibility_Invalid
This value indicates that no visibility information is available for a provided CXCursor.
Definition: Index.h:2472
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:4020
CXChildVisitResult
Describes how the traversal of the children of a particular cursor should proceed after visiting a pa...
Definition: Index.h:3948
enum CXChildVisitResult(* CXCursorVisitor)(CXCursor cursor, CXCursor parent, CXClientData client_data)
Visitor invoked for each cursor found by a traversal.
Definition: Index.h:3977
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:3952
@ CXChildVisit_Recurse
Recursively traverse the children of this cursor, using the same visitor and client data.
Definition: Index.h:3962
@ CXChildVisit_Continue
Continues the cursor traversal with the next sibling of the cursor just visited, without visiting its...
Definition: Index.h:3957
CXObjCDeclQualifierKind
'Qualifiers' written next to the return and parameter types in Objective-C method declarations.
Definition: Index.h:4367
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 CXString clang_getTypePrettyPrinted(CXType CT, CXPrintingPolicy cxPolicy)
Pretty-print the underlying type using a custom printing policy.
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:4118
CXObjCPropertyAttrKind
Property attributes for a CXCursor_ObjCPropertyDecl.
Definition: Index.h:4324
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:4125
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:4373
@ CXObjCDeclQualifier_Inout
Definition: Index.h:4370
@ CXObjCDeclQualifier_Bycopy
Definition: Index.h:4372
@ CXObjCDeclQualifier_In
Definition: Index.h:4369
@ CXObjCDeclQualifier_None
Definition: Index.h:4368
@ CXObjCDeclQualifier_Out
Definition: Index.h:4371
@ CXObjCDeclQualifier_Oneway
Definition: Index.h:4374
@ CXObjCPropertyAttr_assign
Definition: Index.h:4328
@ CXObjCPropertyAttr_retain
Definition: Index.h:4330
@ CXObjCPropertyAttr_strong
Definition: Index.h:4336
@ CXObjCPropertyAttr_atomic
Definition: Index.h:4334
@ CXObjCPropertyAttr_noattr
Definition: Index.h:4325
@ CXObjCPropertyAttr_weak
Definition: Index.h:4335
@ CXObjCPropertyAttr_copy
Definition: Index.h:4331
@ CXObjCPropertyAttr_readwrite
Definition: Index.h:4329
@ CXObjCPropertyAttr_setter
Definition: Index.h:4333
@ CXObjCPropertyAttr_nonatomic
Definition: Index.h:4332
@ CXObjCPropertyAttr_getter
Definition: Index.h:4327
@ CXObjCPropertyAttr_readonly
Definition: Index.h:4326
@ CXObjCPropertyAttr_class
Definition: Index.h:4338
@ CXObjCPropertyAttr_unsafe_unretained
Definition: Index.h:4337
@ CXPrintingPolicy_SuppressScope
Definition: Index.h:4130
@ CXPrintingPolicy_Bool
Definition: Index.h:4138
@ CXPrintingPolicy_Alignof
Definition: Index.h:4140
@ CXPrintingPolicy_ConstantArraySizeAsWritten
Definition: Index.h:4133
@ CXPrintingPolicy_Indentation
Definition: Index.h:4126
@ CXPrintingPolicy_SuppressImplicitBase
Definition: Index.h:4150
@ CXPrintingPolicy_IncludeTagDefinition
Definition: Index.h:4129
@ CXPrintingPolicy_MSWChar
Definition: Index.h:4146
@ CXPrintingPolicy_SuppressSpecifiers
Definition: Index.h:4127
@ CXPrintingPolicy_SuppressUnwrittenScope
Definition: Index.h:4131
@ CXPrintingPolicy_LastProperty
Definition: Index.h:4153
@ CXPrintingPolicy_FullyQualifiedName
Definition: Index.h:4151
@ CXPrintingPolicy_SuppressStrongLifetime
Definition: Index.h:4135
@ CXPrintingPolicy_ConstantsAsWritten
Definition: Index.h:4149
@ CXPrintingPolicy_MSVCFormatting
Definition: Index.h:4148
@ CXPrintingPolicy_SuppressInitializers
Definition: Index.h:4132
@ CXPrintingPolicy_SuppressTagKeyword
Definition: Index.h:4128
@ CXPrintingPolicy_TerseOutput
Definition: Index.h:4143
@ CXPrintingPolicy_AnonymousTagLocations
Definition: Index.h:4134
@ CXPrintingPolicy_Half
Definition: Index.h:4145
@ CXPrintingPolicy_Restrict
Definition: Index.h:4139
@ CXPrintingPolicy_PolishForDeclaration
Definition: Index.h:4144
@ CXPrintingPolicy_UnderscoreAlignof
Definition: Index.h:4141
@ CXPrintingPolicy_SuppressLifetimeQualifiers
Definition: Index.h:4136
@ CXPrintingPolicy_SuppressTemplateArgsInCXXConstructors
Definition: Index.h:4137
@ CXPrintingPolicy_IncludeNewlines
Definition: Index.h:4147
@ CXPrintingPolicy_UseVoidForZeroParams
Definition: Index.h:4142
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:5981
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:6006
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:6718
CXIdxObjCContainerKind
Definition: Index.h:6195
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:6255
CXVisitorResult
Definition: Index.h:5921
enum CXVisitorResult(* CXFieldVisitor)(CXCursor C, CXClientData client_data)
Visitor invoked for each field found by a traversal.
Definition: Index.h:6579
CXIdxEntityLanguage
Definition: Index.h:6107
CXResult
Definition: Index.h:5928
CINDEX_LINKAGE const CXIdxObjCCategoryDeclInfo * clang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *)
CXBinaryOperatorKind
Describes the kind of binary operators.
Definition: Index.h:6630
CINDEX_LINKAGE unsigned clang_visitCXXBaseClasses(CXType T, CXFieldVisitor visitor, CXClientData client_data)
Visit the base classes of a type.
void * CXIdxClientFile
The client's data object that is associated with a CXFile.
Definition: Index.h:5995
void * CXIdxClientASTFile
The client's data object that is associated with an AST file (PCH or module).
Definition: Index.h:6012
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:6445
CXSymbolRole
Roles that are attributed to symbol occurrences.
Definition: Index.h:6273
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:6000
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:6167
void * CXIndexAction
An indexing action/session, to be applied to one or multiple translation units.
Definition: Index.h:6427
CINDEX_LINKAGE CXIdxClientContainer clang_index_getClientContainer(const CXIdxContainerInfo *)
For retrieving a custom CXIdxClientContainer attached to a container.
CXIdxAttrKind
Definition: Index.h:6132
CINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind)
CINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo * clang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *)
CXIdxEntityKind
Definition: Index.h:6071
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:6125
@ CXUnaryOperator_Minus
Minus operator.
Definition: Index.h:6736
@ CXUnaryOperator_Coawait
C++ co_await operator.
Definition: Index.h:6748
@ CXUnaryOperator_PreInc
Prefix increment operator.
Definition: Index.h:6726
@ CXUnaryOperator_PostDec
Postfix decrement operator.
Definition: Index.h:6724
@ CXUnaryOperator_Plus
Plus operator.
Definition: Index.h:6734
@ CXUnaryOperator_PreDec
Prefix decrement operator.
Definition: Index.h:6728
@ CXUnaryOperator_AddrOf
Address of operator.
Definition: Index.h:6730
@ CXUnaryOperator_Deref
Dereference operator.
Definition: Index.h:6732
@ CXUnaryOperator_PostInc
Postfix increment operator.
Definition: Index.h:6722
@ CXUnaryOperator_Invalid
This value describes cursors which are not unary operators.
Definition: Index.h:6720
@ CXUnaryOperator_Extension
extension marker operator.
Definition: Index.h:6746
@ CXUnaryOperator_Not
Not operator.
Definition: Index.h:6738
@ CXUnaryOperator_LNot
LNot operator.
Definition: Index.h:6740
@ CXUnaryOperator_Real
"__real expr" operator.
Definition: Index.h:6742
@ CXUnaryOperator_Imag
"__imag expr" operator.
Definition: Index.h:6744
@ CXIdxObjCContainer_Interface
Definition: Index.h:6197
@ CXIdxObjCContainer_Implementation
Definition: Index.h:6198
@ CXIdxObjCContainer_ForwardRef
Definition: Index.h:6196
@ CXIdxEntityRef_Implicit
An implicit reference, e.g.
Definition: Index.h:6264
@ CXIdxEntityRef_Direct
The entity is referenced directly in user's code.
Definition: Index.h:6259
@ CXVisit_Break
Definition: Index.h:5921
@ CXVisit_Continue
Definition: Index.h:5921
@ CXIdxEntityLang_None
Definition: Index.h:6108
@ CXIdxEntityLang_CXX
Definition: Index.h:6111
@ CXIdxEntityLang_C
Definition: Index.h:6109
@ CXIdxEntityLang_ObjC
Definition: Index.h:6110
@ CXIdxEntityLang_Swift
Definition: Index.h:6112
@ CXResult_VisitBreak
The function was terminated by a callback (e.g.
Definition: Index.h:5941
@ CXResult_Success
Function returned successfully.
Definition: Index.h:5932
@ CXResult_Invalid
One of the parameters was invalid for the function.
Definition: Index.h:5936
@ CXBinaryOperator_XorAssign
Bitwise XOR assignment operator.
Definition: Index.h:6694
@ CXBinaryOperator_EQ
Equal operator.
Definition: Index.h:6662
@ CXBinaryOperator_Add
Addition operator.
Definition: Index.h:6644
@ CXBinaryOperator_Cmp
C++ three-way comparison (spaceship) operator.
Definition: Index.h:6652
@ CXBinaryOperator_AndAssign
Bitwise AND assignment operator.
Definition: Index.h:6692
@ CXBinaryOperator_Shr
Bitwise shift right operator.
Definition: Index.h:6650
@ CXBinaryOperator_Comma
Comma operator.
Definition: Index.h:6698
@ CXBinaryOperator_ShlAssign
Bitwise shift left assignment operator.
Definition: Index.h:6688
@ CXBinaryOperator_Sub
Subtraction operator.
Definition: Index.h:6646
@ CXBinaryOperator_LE
Less or equal operator.
Definition: Index.h:6658
@ CXBinaryOperator_PtrMemI
C++ Pointer - to - member operator.
Definition: Index.h:6636
@ CXBinaryOperator_LT
Less than operator.
Definition: Index.h:6654
@ CXBinaryOperator_NE
Not equal operator.
Definition: Index.h:6664
@ CXBinaryOperator_LOr
Logical OR operator.
Definition: Index.h:6674
@ CXBinaryOperator_And
Bitwise AND operator.
Definition: Index.h:6666
@ CXBinaryOperator_ShrAssign
Bitwise shift right assignment operator.
Definition: Index.h:6690
@ CXBinaryOperator_RemAssign
Remainder assignment operator.
Definition: Index.h:6682
@ CXBinaryOperator_Or
Bitwise OR operator.
Definition: Index.h:6670
@ CXBinaryOperator_Assign
Assignment operator.
Definition: Index.h:6676
@ CXBinaryOperator_Xor
Bitwise XOR operator.
Definition: Index.h:6668
@ CXBinaryOperator_LAnd
Logical AND operator.
Definition: Index.h:6672
@ CXBinaryOperator_Mul
Multiplication operator.
Definition: Index.h:6638
@ CXBinaryOperator_GE
Greater or equal operator.
Definition: Index.h:6660
@ CXBinaryOperator_MulAssign
Multiplication assignment operator.
Definition: Index.h:6678
@ CXBinaryOperator_Rem
Remainder operator.
Definition: Index.h:6642
@ CXBinaryOperator_PtrMemD
C++ Pointer - to - member operator.
Definition: Index.h:6634
@ CXBinaryOperator_SubAssign
Subtraction assignment operator.
Definition: Index.h:6686
@ CXBinaryOperator_AddAssign
Addition assignment operator.
Definition: Index.h:6684
@ CXBinaryOperator_Div
Division operator.
Definition: Index.h:6640
@ CXBinaryOperator_Shl
Bitwise shift left operator.
Definition: Index.h:6648
@ CXBinaryOperator_GT
Greater than operator.
Definition: Index.h:6656
@ CXBinaryOperator_Invalid
This value describes cursors which are not binary operators.
Definition: Index.h:6632
@ CXBinaryOperator_OrAssign
Bitwise OR assignment operator.
Definition: Index.h:6696
@ CXBinaryOperator_DivAssign
Division assignment operator.
Definition: Index.h:6680
@ CXIndexOpt_None
Used to indicate that no special indexing options are needed.
Definition: Index.h:6449
@ CXIndexOpt_SkipParsedBodiesInSession
Skip a function/method body that was already parsed during an indexing session associated with a CXIn...
Definition: Index.h:6480
@ CXIndexOpt_SuppressRedundantRefs
Used to indicate that IndexerCallbacks::indexEntityReference should be invoked for only one reference...
Definition: Index.h:6456
@ CXIndexOpt_SuppressWarnings
Suppress all compiler warnings when parsing for indexing.
Definition: Index.h:6473
@ CXIndexOpt_IndexImplicitTemplateInstantiations
Implicit function/class template instantiations should be indexed.
Definition: Index.h:6468
@ CXIndexOpt_IndexFunctionLocalSymbols
Function-local symbols should be indexed.
Definition: Index.h:6462
@ CXSymbolRole_Read
Definition: Index.h:6278
@ CXSymbolRole_Reference
Definition: Index.h:6277
@ CXSymbolRole_Write
Definition: Index.h:6279
@ CXSymbolRole_Definition
Definition: Index.h:6276
@ CXSymbolRole_Dynamic
Definition: Index.h:6281
@ CXSymbolRole_AddressOf
Definition: Index.h:6282
@ CXSymbolRole_Implicit
Definition: Index.h:6283
@ CXSymbolRole_None
Definition: Index.h:6274
@ CXSymbolRole_Call
Definition: Index.h:6280
@ CXSymbolRole_Declaration
Definition: Index.h:6275
@ CXIdxDeclFlag_Skipped
Definition: Index.h:6167
@ CXIdxAttr_IBOutlet
Definition: Index.h:6135
@ CXIdxAttr_Unexposed
Definition: Index.h:6133
@ CXIdxAttr_IBAction
Definition: Index.h:6134
@ CXIdxAttr_IBOutletCollection
Definition: Index.h:6136
@ CXIdxEntity_Field
Definition: Index.h:6076
@ CXIdxEntity_ObjCCategory
Definition: Index.h:6081
@ CXIdxEntity_CXXConversionFunction
Definition: Index.h:6100
@ CXIdxEntity_CXXNamespaceAlias
Definition: Index.h:6094
@ CXIdxEntity_CXXConcept
Definition: Index.h:6103
@ CXIdxEntity_CXXStaticVariable
Definition: Index.h:6095
@ CXIdxEntity_Function
Definition: Index.h:6074
@ CXIdxEntity_Enum
Definition: Index.h:6088
@ CXIdxEntity_CXXInstanceMethod
Definition: Index.h:6097
@ CXIdxEntity_CXXStaticMethod
Definition: Index.h:6096
@ CXIdxEntity_CXXTypeAlias
Definition: Index.h:6101
@ CXIdxEntity_Struct
Definition: Index.h:6089
@ CXIdxEntity_ObjCInstanceMethod
Definition: Index.h:6083
@ CXIdxEntity_EnumConstant
Definition: Index.h:6077
@ CXIdxEntity_Variable
Definition: Index.h:6075
@ CXIdxEntity_CXXClass
Definition: Index.h:6092
@ CXIdxEntity_ObjCIvar
Definition: Index.h:6086
@ CXIdxEntity_CXXInterface
Definition: Index.h:6102
@ CXIdxEntity_CXXConstructor
Definition: Index.h:6098
@ CXIdxEntity_ObjCClassMethod
Definition: Index.h:6084
@ CXIdxEntity_CXXNamespace
Definition: Index.h:6093
@ CXIdxEntity_ObjCClass
Definition: Index.h:6079
@ CXIdxEntity_ObjCProperty
Definition: Index.h:6085
@ CXIdxEntity_Typedef
Definition: Index.h:6073
@ CXIdxEntity_Union
Definition: Index.h:6090
@ CXIdxEntity_ObjCProtocol
Definition: Index.h:6080
@ CXIdxEntity_Unexposed
Definition: Index.h:6072
@ CXIdxEntity_CXXDestructor
Definition: Index.h:6099
@ CXIdxEntity_NonTemplate
Definition: Index.h:6126
@ CXIdxEntity_Template
Definition: Index.h:6127
@ CXIdxEntity_TemplatePartialSpecialization
Definition: Index.h:6128
@ CXIdxEntity_TemplateSpecialization
Definition: Index.h:6129
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:4835
@ CXToken_Identifier
An identifier (that is not a keyword).
Definition: Index.h:4849
@ CXToken_Punctuation
A token that contains some kind of punctuation.
Definition: Index.h:4839
@ CXToken_Comment
A comment.
Definition: Index.h:4859
@ CXToken_Keyword
A language keyword.
Definition: Index.h:4844
@ CXToken_Literal
A numeric, string, or character literal.
Definition: Index.h:4854
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:5823
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:5838
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:5853
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:5846
@ CXEval_Other
Definition: Index.h:5844
@ CXEval_Float
Definition: Index.h:5840
@ CXEval_Int
Definition: Index.h:5839
@ CXEval_CFStr
Definition: Index.h:5843
@ CXEval_StrLiteral
Definition: Index.h:5842
@ CXEval_ObjCStrLiteral
Definition: Index.h:5841
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:4473
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)
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:3811
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:3575
CX_BinaryOperatorKind
Represents a specific kind of binary operator which can appear at a cursor.
Definition: Index.h:3825
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:3791
CXRefQualifierKind
Definition: Index.h:3739
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:3035
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:2873
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:3618
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 long long clang_getOffsetOfBase(CXCursor Parent, CXCursor Base)
Returns the offset in bits of a CX_CXXBaseSpecifier relative to the parent class.
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:3171
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:3819
@ CX_SC_Static
Definition: Index.h:3815
@ CX_SC_Auto
Definition: Index.h:3818
@ CX_SC_PrivateExtern
Definition: Index.h:3816
@ CX_SC_OpenCLWorkGroupLocal
Definition: Index.h:3817
@ CX_SC_None
Definition: Index.h:3813
@ CX_SC_Extern
Definition: Index.h:3814
@ CX_SC_Invalid
Definition: Index.h:3812
@ CXTypeNullability_Nullable
Values of this type can be null.
Definition: Index.h:3583
@ CXTypeNullability_Invalid
Nullability is not applicable to this type.
Definition: Index.h:3594
@ CXTypeNullability_Unspecified
Whether values of this type can be null is (explicitly) unspecified.
Definition: Index.h:3590
@ CXTypeNullability_NonNull
Values of this type can never be null.
Definition: Index.h:3579
@ CXTypeNullability_NullableResult
Generally behaves like Nullable, except when used in a block parameter that was imported into a swift...
Definition: Index.h:3602
@ CX_BO_PtrMemD
Definition: Index.h:3827
@ CX_BO_GE
Definition: Index.h:3840
@ CX_BO_LOr
Definition: Index.h:3847
@ CX_BO_ShrAssign
Definition: Index.h:3855
@ CX_BO_SubAssign
Definition: Index.h:3853
@ CX_BO_Or
Definition: Index.h:3845
@ CX_BO_XorAssign
Definition: Index.h:3857
@ CX_BO_EQ
Definition: Index.h:3841
@ CX_BO_Invalid
Definition: Index.h:3826
@ CX_BO_PtrMemI
Definition: Index.h:3828
@ CX_BO_DivAssign
Definition: Index.h:3850
@ CX_BO_NE
Definition: Index.h:3842
@ CX_BO_Add
Definition: Index.h:3832
@ CX_BO_Mul
Definition: Index.h:3829
@ CX_BO_Xor
Definition: Index.h:3844
@ CX_BO_Comma
Definition: Index.h:3859
@ CX_BO_Rem
Definition: Index.h:3831
@ CX_BO_ShlAssign
Definition: Index.h:3854
@ CX_BO_AddAssign
Definition: Index.h:3852
@ CX_BO_OrAssign
Definition: Index.h:3858
@ CX_BO_Sub
Definition: Index.h:3833
@ CX_BO_Div
Definition: Index.h:3830
@ CX_BO_AndAssign
Definition: Index.h:3856
@ CX_BO_LE
Definition: Index.h:3839
@ CX_BO_LT
Definition: Index.h:3837
@ CX_BO_Assign
Definition: Index.h:3848
@ CX_BO_LAST
Definition: Index.h:3860
@ CX_BO_Shl
Definition: Index.h:3834
@ CX_BO_Cmp
Definition: Index.h:3836
@ CX_BO_RemAssign
Definition: Index.h:3851
@ CX_BO_MulAssign
Definition: Index.h:3849
@ CX_BO_LAnd
Definition: Index.h:3846
@ CX_BO_Shr
Definition: Index.h:3835
@ CX_BO_And
Definition: Index.h:3843
@ CX_BO_GT
Definition: Index.h:3838
@ CX_CXXPrivate
Definition: Index.h:3795
@ CX_CXXInvalidAccessSpecifier
Definition: Index.h:3792
@ CX_CXXProtected
Definition: Index.h:3794
@ CX_CXXPublic
Definition: Index.h:3793
@ CXRefQualifier_LValue
An lvalue ref-qualifier was provided (&).
Definition: Index.h:3743
@ CXRefQualifier_None
No ref-qualifier was provided.
Definition: Index.h:3741
@ CXRefQualifier_RValue
An rvalue ref-qualifier was provided (&&).
Definition: Index.h:3745
@ CXCallingConv_RISCVVectorCall
Definition: Index.h:3059
@ CXCallingConv_Swift
Definition: Index.h:3051
@ CXCallingConv_X86_64SysV
Definition: Index.h:3049
@ CXCallingConv_X86StdCall
Definition: Index.h:3038
@ CXCallingConv_PreserveNone
Definition: Index.h:3058
@ CXCallingConv_X86Pascal
Definition: Index.h:3041
@ CXCallingConv_Invalid
Definition: Index.h:3061
@ CXCallingConv_AAPCS
Definition: Index.h:3042
@ CXCallingConv_AAPCS_VFP
Definition: Index.h:3043
@ CXCallingConv_AArch64VectorCall
Definition: Index.h:3054
@ CXCallingConv_SwiftAsync
Definition: Index.h:3055
@ CXCallingConv_M68kRTD
Definition: Index.h:3057
@ CXCallingConv_IntelOclBicc
Definition: Index.h:3045
@ CXCallingConv_Default
Definition: Index.h:3036
@ CXCallingConv_X86ThisCall
Definition: Index.h:3040
@ CXCallingConv_X86VectorCall
Definition: Index.h:3050
@ CXCallingConv_X86_64Win64
Definition: Index.h:3048
@ CXCallingConv_Win64
Definition: Index.h:3046
@ CXCallingConv_PreserveAll
Definition: Index.h:3053
@ CXCallingConv_C
Definition: Index.h:3037
@ CXCallingConv_X86RegCall
Definition: Index.h:3044
@ CXCallingConv_X86FastCall
Definition: Index.h:3039
@ CXCallingConv_AArch64SVEPCS
Definition: Index.h:3056
@ CXCallingConv_Unexposed
Definition: Index.h:3062
@ CXCallingConv_PreserveMost
Definition: Index.h:3052
@ CXType_LongDouble
Definition: Index.h:2907
@ CXType_OCLImage2dMSAAWO
Definition: Index.h:2978
@ CXType_OCLImage2dArrayMSAARW
Definition: Index.h:2991
@ CXType_OCLImage2dArrayMSAADepthRO
Definition: Index.h:2969
@ CXType_VariableArray
Definition: Index.h:2943
@ CXType_OCLImage1dArrayRW
Definition: Index.h:2984
@ CXType_OCLImage2dMSAADepthWO
Definition: Index.h:2980
@ CXType_OCLImage2dMSAARW
Definition: Index.h:2990
@ CXType_OCLImage1dBufferWO
Definition: Index.h:2973
@ CXType_LValueReference
Definition: Index.h:2931
@ CXType_ShortAccum
Definition: Index.h:2917
@ CXType_Double
Definition: Index.h:2906
@ CXType_OCLImage2dArrayMSAAWO
Definition: Index.h:2979
@ CXType_OCLIntelSubgroupAVCImeResult
Definition: Index.h:3009
@ CXType_OCLIntelSubgroupAVCImeResultDualRefStreamout
Definition: Index.h:3019
@ CXType_ObjCSel
Definition: Index.h:2913
@ CXType_UShort
Definition: Index.h:2892
@ CXType_OCLImage2dArrayRW
Definition: Index.h:2987
@ CXType_Unexposed
A type whose specific kind is not exposed via this interface.
Definition: Index.h:2883
@ CXType_Pipe
Definition: Index.h:2956
@ CXType_OCLIntelSubgroupAVCImeSingleReferenceStreamin
Definition: Index.h:3014
@ CXType_ObjCId
Definition: Index.h:2911
@ CXType_OCLIntelSubgroupAVCImeResultSingleRefStreamout
Definition: Index.h:3018
@ CXType_Invalid
Represents an invalid type (e.g., where no type is available).
Definition: Index.h:2877
@ CXType_UAccum
Definition: Index.h:2921
@ CXType_UInt128
Definition: Index.h:2896
@ CXType_OCLImage2dWO
Definition: Index.h:2974
@ CXType_Float16
Definition: Index.h:2916
@ CXType_OCLIntelSubgroupAVCImeDualRefStreamin
Definition: Index.h:3021
@ CXType_Short
Definition: Index.h:2900
@ CXType_OCLImage2dRW
Definition: Index.h:2986
@ CXType_LongAccum
Definition: Index.h:2919
@ CXType_Float
Definition: Index.h:2905
@ CXType_WChar
Definition: Index.h:2899
@ CXType_LongLong
Definition: Index.h:2903
@ CXType_OCLIntelSubgroupAVCImeSingleRefStreamin
Definition: Index.h:3020
@ CXType_OCLImage2dArrayDepthRO
Definition: Index.h:2965
@ CXType_OCLImage2dArrayDepthWO
Definition: Index.h:2977
@ CXType_ConstantArray
Definition: Index.h:2940
@ CXType_Ibm128
Definition: Index.h:2924
@ CXType_OCLImage2dDepthRO
Definition: Index.h:2964
@ CXType_BFloat16
Definition: Index.h:2923
@ CXType_OCLImage1dArrayRO
Definition: Index.h:2960
@ CXType_OCLIntelSubgroupAVCSicResult
Definition: Index.h:3011
@ CXType_Enum
Definition: Index.h:2934
@ CXType_FunctionProto
Definition: Index.h:2939
@ CXType_OCLImage2dArrayMSAADepthRW
Definition: Index.h:2993
@ CXType_MemberPointer
Definition: Index.h:2945
@ CXType_OCLImage2dDepthRW
Definition: Index.h:2988
@ CXType_ULong
Definition: Index.h:2894
@ CXType_ULongLong
Definition: Index.h:2895
@ CXType_OCLImage2dArrayMSAARO
Definition: Index.h:2967
@ CXType_OCLImage2dMSAADepthRW
Definition: Index.h:2992
@ CXType_Typedef
Definition: Index.h:2935
@ CXType_Int
Definition: Index.h:2901
@ CXType_OCLImage2dArrayMSAADepthWO
Definition: Index.h:2981
@ CXType_OCLImage2dMSAADepthRO
Definition: Index.h:2968
@ CXType_Half
Definition: Index.h:2915
@ CXType_BlockPointer
Definition: Index.h:2930
@ CXType_OCLImage1dArrayWO
Definition: Index.h:2972
@ CXType_BTFTagAttributed
Definition: Index.h:3025
@ CXType_OCLImage2dArrayWO
Definition: Index.h:2975
@ CXType_OCLImage1dRO
Definition: Index.h:2959
@ CXType_Atomic
Definition: Index.h:3024
@ CXType_IncompleteArray
Definition: Index.h:2942
@ CXType_Overload
Definition: Index.h:2909
@ CXType_OCLIntelSubgroupAVCSicPayload
Definition: Index.h:3007
@ CXType_ExtVector
Definition: Index.h:3023
@ CXType_Float128
Definition: Index.h:2914
@ CXType_OCLIntelSubgroupAVCImeDualReferenceStreamin
Definition: Index.h:3015
@ CXType_OCLImage2dArrayDepthRW
Definition: Index.h:2989
@ CXType_Complex
Definition: Index.h:2928
@ CXType_OCLImage1dBufferRW
Definition: Index.h:2985
@ CXType_OCLImage1dRW
Definition: Index.h:2983
@ CXType_Long
Definition: Index.h:2902
@ CXType_Int128
Definition: Index.h:2904
@ CXType_UInt
Definition: Index.h:2893
@ CXType_OCLQueue
Definition: Index.h:2997
@ CXType_RValueReference
Definition: Index.h:2932
@ CXType_OCLImage3dRO
Definition: Index.h:2970
@ CXType_DependentSizedArray
Definition: Index.h:2944
@ CXType_NullPtr
Definition: Index.h:2908
@ CXType_ObjCInterface
Definition: Index.h:2936
@ CXType_ObjCClass
Definition: Index.h:2912
@ CXType_OCLImage1dBufferRO
Definition: Index.h:2961
@ CXType_OCLImage1dWO
Definition: Index.h:2971
@ CXType_OCLIntelSubgroupAVCRefPayload
Definition: Index.h:3006
@ CXType_Bool
Definition: Index.h:2887
@ CXType_ObjCObject
Definition: Index.h:3000
@ CXType_OCLImage2dDepthWO
Definition: Index.h:2976
@ CXType_Void
Definition: Index.h:2886
@ CXType_UShortAccum
Definition: Index.h:2920
@ CXType_Vector
Definition: Index.h:2941
@ CXType_LastBuiltin
Definition: Index.h:2926
@ CXType_OCLEvent
Definition: Index.h:2996
@ CXType_OCLImage2dMSAARO
Definition: Index.h:2966
@ CXType_Record
Definition: Index.h:2933
@ CXType_OCLIntelSubgroupAVCMceResult
Definition: Index.h:3008
@ CXType_HLSLResource
Definition: Index.h:3028
@ CXType_SChar
Definition: Index.h:2898
@ CXType_ObjCObjectPointer
Definition: Index.h:2937
@ CXType_OCLIntelSubgroupAVCImeResultSingleReferenceStreamout
Definition: Index.h:3012
@ CXType_HLSLAttributedResource
Definition: Index.h:3029
@ CXType_Char16
Definition: Index.h:2890
@ CXType_ObjCTypeParam
Definition: Index.h:3001
@ CXType_UChar
Definition: Index.h:2889
@ CXType_Pointer
Definition: Index.h:2929
@ CXType_FunctionNoProto
Definition: Index.h:2938
@ CXType_Char_S
Definition: Index.h:2897
@ CXType_Char_U
Definition: Index.h:2888
@ CXType_Accum
Definition: Index.h:2918
@ CXType_Auto
Definition: Index.h:2946
@ CXType_OCLIntelSubgroupAVCImePayload
Definition: Index.h:3005
@ CXType_OCLIntelSubgroupAVCImeResultDualReferenceStreamout
Definition: Index.h:3013
@ CXType_FirstBuiltin
Definition: Index.h:2925
@ CXType_OCLImage2dRO
Definition: Index.h:2962
@ CXType_OCLSampler
Definition: Index.h:2995
@ CXType_OCLIntelSubgroupAVCMcePayload
Definition: Index.h:3004
@ CXType_Char32
Definition: Index.h:2891
@ CXType_Attributed
Definition: Index.h:3002
@ CXType_OCLIntelSubgroupAVCRefResult
Definition: Index.h:3010
@ CXType_Elaborated
Represents a type that was referred to using an elaborated type keyword.
Definition: Index.h:2953
@ CXType_OCLReserveID
Definition: Index.h:2998
@ CXType_OCLImage3dRW
Definition: Index.h:2994
@ CXType_ULongAccum
Definition: Index.h:2922
@ CXType_OCLImage3dWO
Definition: Index.h:2982
@ CXType_Dependent
Definition: Index.h:2910
@ CXType_OCLImage2dArrayRO
Definition: Index.h:2963
@ CXTypeLayoutError_Incomplete
The type is an incomplete Type.
Definition: Index.h:3626
@ CXTypeLayoutError_Dependent
The type is a dependent Type.
Definition: Index.h:3630
@ CXTypeLayoutError_Undeduced
The type is undeduced.
Definition: Index.h:3642
@ CXTypeLayoutError_NotConstantSize
The type is not a constant size type.
Definition: Index.h:3634
@ CXTypeLayoutError_Invalid
Type is of kind CXType_Invalid.
Definition: Index.h:3622
@ CXTypeLayoutError_InvalidFieldName
The Field name is not valid for this record.
Definition: Index.h:3638
@ CXTemplateArgumentKind_NullPtr
Definition: Index.h:3175
@ CXTemplateArgumentKind_Expression
Definition: Index.h:3179
@ CXTemplateArgumentKind_Pack
Definition: Index.h:3180
@ CXTemplateArgumentKind_Declaration
Definition: Index.h:3174
@ CXTemplateArgumentKind_Type
Definition: Index.h:3173
@ CXTemplateArgumentKind_Null
Definition: Index.h:3172
@ CXTemplateArgumentKind_Integral
Definition: Index.h:3176
@ CXTemplateArgumentKind_Template
Definition: Index.h:3177
@ CXTemplateArgumentKind_TemplateExpansion
Definition: Index.h:3178
@ CXTemplateArgumentKind_Invalid
Definition: Index.h:3182
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:2252
@ 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:2250
@ 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:2238
@ 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:2253
@ CXCursor_ObjCRootClass
Definition: Index.h:2261
@ 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:2300
@ 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:2280
@ CXCursor_ObjCBoolLiteralExpr
Objective-c Boolean Literal.
Definition: Index.h:1640
@ CXCursor_MacroInstantiation
Definition: Index.h:2278
@ 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:2270
@ 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:2257
@ 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:2249
@ CXCursor_SizeOfPackExpr
Represents an expression that computes the length of a parameter pack.
Definition: Index.h:1622
@ CXCursor_LastPreprocessing
Definition: Index.h:2281
@ 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:2271
@ CXCursor_ParmDecl
A function or method parameter.
Definition: Index.h:1218
@ CXCursor_ObjCProtocolRef
Definition: Index.h:1284
@ CXCursor_AnnotateAttr
Definition: Index.h:2236
@ 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:2229
@ 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:2251
@ 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:2237
@ CXCursor_WarnUnusedAttr
Definition: Index.h:2269
@ CXCursor_ObjCSubclassingRestricted
Definition: Index.h:2262
@ 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_OpenACCUpdateConstruct
OpenACC update Construct.
Definition: Index.h:2207
@ 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:2277
@ CXCursor_ConstAttr
Definition: Index.h:2240
@ 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:2221
@ CXCursor_PreprocessingDirective
Definition: Index.h:2275
@ 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:2248
@ CXCursor_ClassTemplatePartialSpecialization
A C++ class template partial specialization.
Definition: Index.h:1262
@ CXCursor_LastStmt
Definition: Index.h:2213
@ 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:2235
@ 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:2231
@ CXCursor_NoDuplicateAttr
Definition: Index.h:2241
@ 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:2233
@ CXCursor_TypeRef
A reference to a type declaration.
Definition: Index.h:1301
@ CXCursor_CUDAGlobalAttr
Definition: Index.h:2244
@ CXCursor_IBOutletAttr
Definition: Index.h:2232
@ 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:2246
@ 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:2243
@ CXCursor_OpenACCAtomicConstruct
OpenACC atomic Construct.
Definition: Index.h:2211
@ CXCursor_OMPBarrierDirective
OpenMP barrier directive.
Definition: Index.h:1899
@ CXCursor_ObjCNSObject
Definition: Index.h:2256
@ 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:2288
@ 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:2263
@ CXCursor_NSConsumed
Definition: Index.h:2254
@ 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:2239
@ CXCursor_OMPParallelMasterTaskLoopSimdDirective
OpenMP parallel master taskloop simd directive.
Definition: Index.h:2059
@ CXCursor_LastExtraDecl
Definition: Index.h:2303
@ 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:2276
@ CXCursor_CUDAConstantAttr
Definition: Index.h:2242
@ 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:2224
@ 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:2302
@ 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:2268
@ 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:2292
@ CXCursor_ModuleImportDecl
A module import declaration.
Definition: Index.h:2287
@ 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:2255
@ 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:2264
@ CXCursor_Constructor
A C++ constructor.
Definition: Index.h:1246
@ CXCursor_WhileStmt
A while statement.
Definition: Index.h:1747
@ CXCursor_ObjCRuntimeVisible
Definition: Index.h:2265
@ CXCursor_OverloadCandidate
A code completion overload candidate.
Definition: Index.h:2308
@ 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:2296
@ CXCursor_ObjCRequiresSuper
Definition: Index.h:2260
@ CXCursor_BreakStmt
A break statement.
Definition: Index.h:1771
@ CXCursor_CXXFinalAttr
Definition: Index.h:2234
@ CXCursor_OMPDistributeSimdDirective
OpenMP distribute simd directive.
Definition: Index.h:1995
@ CXCursor_CUDAHostAttr
Definition: Index.h:2245
@ CXCursor_InclusionDirective
Definition: Index.h:2279
@ CXCursor_FlagEnum
Definition: Index.h:2267
@ 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:2272
@ CXCursor_ObjCBoxable
Definition: Index.h:2266
@ 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:2259
@ CXCursor_OpenACCShutdownConstruct
OpenACC shutdown Construct.
Definition: Index.h:2199
@ CXCursor_ObjCPreciseLifetime
Definition: Index.h:2258
@ CXCursor_VisibilityAttr
Definition: Index.h:2247
@ 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:5357
unsigned NumResults
The number of code-completion results stored in the Results array.
Definition: Index.h:5367
CXCompletionResult * Results
The code-completion results.
Definition: Index.h:5361
A single result of code completion.
Definition: Index.h:5023
CXCompletionString CompletionString
The code-completion string that describes how to insert this code-completion result into the editing ...
Definition: Index.h:5040
enum CXCursorKind CursorKind
The kind of entity that this completion refers to.
Definition: Index.h:5034
enum CXVisitorResult(* visit)(void *context, CXCursor, CXSourceRange)
Definition: Index.h:5925
A cursor representing some element in the abstract syntax tree for a translation unit.
Definition: Index.h:2329
int xdata
Definition: Index.h:2331
enum CXCursorKind kind
Definition: Index.h:2330
CXIdxLoc loc
Definition: Index.h:6142
CXIdxAttrKind kind
Definition: Index.h:6140
CXCursor cursor
Definition: Index.h:6141
const CXIdxEntityInfo * base
Definition: Index.h:6207
CXCursor cursor
Definition: Index.h:6208
CXIdxLoc loc
Definition: Index.h:6209
const CXIdxDeclInfo * declInfo
Definition: Index.h:6244
const CXIdxBaseClassInfo *const * bases
Definition: Index.h:6245
unsigned numBases
Definition: Index.h:6246
CXCursor cursor
Definition: Index.h:6157
int isImplicit
Whether the declaration exists in code or was created implicitly by the compiler, e....
Definition: Index.h:6187
const CXIdxContainerInfo * semanticContainer
Definition: Index.h:6173
unsigned flags
Definition: Index.h:6191
const CXIdxContainerInfo * declAsContainer
Definition: Index.h:6182
int isRedeclaration
Definition: Index.h:6179
CXIdxLoc loc
Definition: Index.h:6172
int isDefinition
Definition: Index.h:6180
const CXIdxEntityInfo * entityInfo
Definition: Index.h:6170
unsigned numAttributes
Definition: Index.h:6189
const CXIdxAttrInfo *const * attributes
Definition: Index.h:6188
CXCursor cursor
Definition: Index.h:6171
int isContainer
Definition: Index.h:6181
const CXIdxContainerInfo * lexicalContainer
Generally same as semanticContainer but can be different in cases like out-of-line C++ member functio...
Definition: Index.h:6178
const char * USR
Definition: Index.h:6150
const char * name
Definition: Index.h:6149
CXIdxEntityKind kind
Definition: Index.h:6146
CXCursor cursor
Definition: Index.h:6151
CXIdxEntityCXXTemplateKind templateKind
Definition: Index.h:6147
CXIdxEntityLanguage lang
Definition: Index.h:6148
unsigned numAttributes
Definition: Index.h:6153
const CXIdxAttrInfo *const * attributes
Definition: Index.h:6152
Data for IndexerCallbacks::indexEntityReference.
Definition: Index.h:6289
CXIdxEntityRefKind kind
Definition: Index.h:6290
CXCursor cursor
Reference cursor.
Definition: Index.h:6294
const CXIdxContainerInfo * container
Lexical container context of the reference.
Definition: Index.h:6315
CXSymbolRole role
Sets of symbol roles of the reference.
Definition: Index.h:6319
const CXIdxEntityInfo * referencedEntity
The entity that gets referenced.
Definition: Index.h:6299
CXIdxLoc loc
Definition: Index.h:6295
const CXIdxEntityInfo * parentEntity
Immediate "parent" of the reference.
Definition: Index.h:6311
const CXIdxAttrInfo * attrInfo
Definition: Index.h:6161
const CXIdxEntityInfo * objcClass
Definition: Index.h:6162
Data for IndexerCallbacks::importedASTFile.
Definition: Index.h:6050
CXIdxLoc loc
Location where the file is imported.
Definition: Index.h:6062
CXFile file
Top level AST file containing the imported PCH, module or submodule.
Definition: Index.h:6054
int isImplicit
Non-zero if an inclusion directive was automatically turned into a module import.
Definition: Index.h:6067
CXModule module
The imported module or NULL if the AST file is a PCH.
Definition: Index.h:6058
Data for ppIncludedFile callback.
Definition: Index.h:6025
CXIdxLoc hashLoc
Location of '#' in the #include/#import directive.
Definition: Index.h:6029
CXFile file
The actual file that the #include/#import directive resolved to.
Definition: Index.h:6037
int isModuleImport
Non-zero if the directive was automatically turned into a module import.
Definition: Index.h:6044
const char * filename
Filename as written in the #include/#import directive.
Definition: Index.h:6033
Source location passed to index callbacks.
Definition: Index.h:6017
unsigned int_data
Definition: Index.h:6019
const CXIdxEntityInfo * objcClass
Definition: Index.h:6231
const CXIdxObjCProtocolRefListInfo * protocols
Definition: Index.h:6234
const CXIdxObjCContainerDeclInfo * containerInfo
Definition: Index.h:6230
const CXIdxDeclInfo * declInfo
Definition: Index.h:6202
CXIdxObjCContainerKind kind
Definition: Index.h:6203
const CXIdxBaseClassInfo * superInfo
Definition: Index.h:6225
const CXIdxObjCContainerDeclInfo * containerInfo
Definition: Index.h:6224
const CXIdxObjCProtocolRefListInfo * protocols
Definition: Index.h:6226
const CXIdxEntityInfo * setter
Definition: Index.h:6240
const CXIdxEntityInfo * getter
Definition: Index.h:6239
const CXIdxDeclInfo * declInfo
Definition: Index.h:6238
const CXIdxEntityInfo * protocol
Definition: Index.h:6213
const CXIdxObjCProtocolRefInfo *const * protocols
Definition: Index.h:6219
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:2510
CXString Platform
A string that describes the platform for which this structure provides availability information.
Definition: Index.h:2517
CXVersion Obsoleted
The version number in which this entity was obsoleted, and therefore is no longer available.
Definition: Index.h:2531
CXString Message
An optional message to provide to a user of this API, e.g., to suggest replacement APIs.
Definition: Index.h:2540
int Unavailable
Whether the entity is unconditionally unavailable on this platform.
Definition: Index.h:2535
CXVersion Deprecated
The version number in which this entity was deprecated (but is still available).
Definition: Index.h:2526
CXVersion Introduced
The version number in which this entity was introduced.
Definition: Index.h:2521
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:4865
void * ptr_data
Definition: Index.h:4867
The type of an element in the abstract syntax tree.
Definition: Index.h:3069
enum CXTypeKind kind
Definition: Index.h:3070
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:6326