Index.h source code [llvm_projects/clang/include/clang-c/Index.h]

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

Browse the source code of llvm_projects/clang/include/clang-c/Index.h