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