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