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

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