Index.h revision 9ce5584553054d0cb934940586aca0186e87fa57
1d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek/*===-- clang-c/Index.h - Indexing Public C Interface -------------*- C -*-===*\ 2d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 3d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* The LLVM Compiler Infrastructure *| 4d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 5d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* This file is distributed under the University of Illinois Open Source *| 6d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* License. See LICENSE.TXT for details. *| 7d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 8d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|*===----------------------------------------------------------------------===*| 9d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 10d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* This header provides a public inferface to a Clang library for extracting *| 11d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* high-level symbol information from source files without exposing the full *| 12d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* Clang C++ API. *| 13d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 14d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek\*===----------------------------------------------------------------------===*/ 15d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 16d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifndef CLANG_C_INDEX_H 17d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#define CLANG_C_INDEX_H 18d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 1988145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff#include <sys/stat.h> 203d31560343856c573376a04558a7111e7afad4f7Chandler Carruth#include <time.h> 210a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor#include <stdio.h> 2288145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff 23d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifdef __cplusplus 24d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenekextern "C" { 25d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 26d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 2788145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff/* MSVC DLL import/export. */ 282e06fc877a633abea3b40a64950c7316dac29ca8John Thompson#ifdef _MSC_VER 292e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #ifdef _CINDEX_LIB_ 302e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #define CINDEX_LINKAGE __declspec(dllexport) 312e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #else 322e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #define CINDEX_LINKAGE __declspec(dllimport) 332e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #endif 342e06fc877a633abea3b40a64950c7316dac29ca8John Thompson#else 352e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #define CINDEX_LINKAGE 362e06fc877a633abea3b40a64950c7316dac29ca8John Thompson#endif 372e06fc877a633abea3b40a64950c7316dac29ca8John Thompson 3820d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor/** \defgroup CINDEX C Interface to Clang 3920d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * 401efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The C Interface to Clang provides a relatively small API that exposes 41f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * facilities for parsing source code into an abstract syntax tree (AST), 42f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * loading already-parsed ASTs, traversing the AST, associating 43f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * physical source locations with elements within the AST, and other 44f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * facilities that support Clang-based development tools. 45f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 461efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * This C interface to Clang will never provide all of the information 47f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * representation stored in Clang's C++ AST, nor should it: the intent is to 48f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * maintain an API that is relatively stable from one release to the next, 49f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * providing only the basic functionality needed to support development tools. 501efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 511efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * To avoid namespace pollution, data types are prefixed with "CX" and 52f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * functions are prefixed with "clang_". 5320d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * 5420d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * @{ 5520d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor */ 561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 577f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 587f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief An "index" that consists of a set of translation units that would 597f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * typically be linked together into an executable or library. 607f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 617f17376e0931a337d544b75d9030bc92763be287Douglas Gregortypedef void *CXIndex; 62600866cc7d6d9ec2e27d4b6d6ec461f6463b5ab6Steve Naroff 637f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 647f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief A single translation unit, which resides in an index. 657f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 660a90d32523bfe5fa63e11b648686c9699f786d15Ted Kremenektypedef struct CXTranslationUnitImpl *CXTranslationUnit; 67600866cc7d6d9ec2e27d4b6d6ec461f6463b5ab6Steve Naroff 687f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 69c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Opaque pointer representing client data that will be passed through 70c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to various callbacks and visitors. 717f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 72c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregortypedef void *CXClientData; 731efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 74735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor/** 75735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * \brief Provides the contents of a file that has not yet been saved to disk. 76735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * 77735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * Each CXUnsavedFile instance provides the name of a file on the 78735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * system along with the current contents of that file that have not 79735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * yet been saved to disk. 80735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 81735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregorstruct CXUnsavedFile { 821efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 831efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief The file whose contents have not yet been saved. 84735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * 85735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * This file must already exist in the file system. 86735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 87735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor const char *Filename; 88735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor 891efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 90c8dfe5ece04e683106eb96c58a2999f70b53ac21Douglas Gregor * \brief A buffer containing the unsaved contents of this file. 91735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 92735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor const char *Contents; 93735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor 94735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor /** 95c8dfe5ece04e683106eb96c58a2999f70b53ac21Douglas Gregor * \brief The length of the unsaved contents of this buffer. 96735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 97735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor unsigned long Length; 98735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor}; 99735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor 100076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne/** 101076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief Describes the availability of a particular entity, which indicates 102076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * whether the use of this entity will result in a warning or error due to 103076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * it being deprecated or unavailable. 104076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 10558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorenum CXAvailabilityKind { 106076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne /** 107076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief The entity is available. 108076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 10958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailability_Available, 110076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne /** 111076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief The entity is available, but has been deprecated (and its use is 112076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * not recommended). 113076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 11458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailability_Deprecated, 115076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne /** 116076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief The entity is not available; any use of it will be an error. 117076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 11858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailability_NotAvailable 11958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor}; 12058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 1217f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1227f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \defgroup CINDEX_STRING String manipulation routines 1237f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * 1247f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * @{ 1257f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 1261efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1277f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1287f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief A character string. 1297f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * 1307f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * The \c CXString type is used to return strings from the interface when 1317f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * the ownership of that string might different from one call to the next. 1327f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * Use \c clang_getCString() to retrieve the string data and, once finished 1337f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * with the string data, call \c clang_disposeString() to free the string. 134ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff */ 135ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Narofftypedef struct { 136a60ed47da13393796d8552b9fdca12abbb3eea42Ted Kremenek void *data; 137ed122735639d83c10f18c28c7fd117bfcd0f62cbTed Kremenek unsigned private_flags; 138ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff} CXString; 139ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff 1407f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1417f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief Retrieve the character data associated with the given string. 1427f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 143ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve NaroffCINDEX_LINKAGE const char *clang_getCString(CXString string); 144ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff 1457f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1467f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief Free the given string, 1477f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 148ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve NaroffCINDEX_LINKAGE void clang_disposeString(CXString string); 149ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff 1507f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1517f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * @} 1527f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 1531efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1541efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 155e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * \brief clang_createIndex() provides a shared context for creating 156e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * translation units. It provides two options: 157e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * 158e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local" 159e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * declarations (when loading any new translation units). A "local" declaration 1601efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * is one that belongs in the translation unit itself and not in a precompiled 161e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * header that was used by the translation unit. If zero, all declarations 162e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * will be enumerated. 163e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * 164b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * Here is an example: 165b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 1660a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * // excludeDeclsFromPCH = 1, displayDiagnostics=1 1670a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * Idx = clang_createIndex(1, 1); 168b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 169b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // IndexTest.pch was produced with the following command: 170b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch" 171b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * TU = clang_createTranslationUnit(Idx, "IndexTest.pch"); 172b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 173b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // This will load all the symbols from 'IndexTest.pch' 1741efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * clang_visitChildren(clang_getTranslationUnitCursor(TU), 175002a528ab0189fc60cfbf9328962c96ccbe567eeDouglas Gregor * TranslationUnitVisitor, 0); 176b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * clang_disposeTranslationUnit(TU); 177b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 178b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // This will load all the symbols from 'IndexTest.c', excluding symbols 179b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // from 'IndexTest.pch'. 180fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" }; 181fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args, 182fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * 0, 0); 183b2cd48756119f4d8d2a865b4b3e0e8efd02e26a0Douglas Gregor * clang_visitChildren(clang_getTranslationUnitCursor(TU), 184b2cd48756119f4d8d2a865b4b3e0e8efd02e26a0Douglas Gregor * TranslationUnitVisitor, 0); 185b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * clang_disposeTranslationUnit(TU); 186b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 187b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * This process of creating the 'pch', loading it separately, and using it (via 188b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks 189b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * (which gives the indexer the same performance benefit as the compiler). 190e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff */ 1910a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH, 1920a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor int displayDiagnostics); 193896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1940087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor/** 1950087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * \brief Destroy the given index. 1960087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * 1970087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * The index must not be destroyed until all of the translation units created 1980087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * within that index have been destroyed. 1990087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor */ 2008506dde586459887b7e14e23a30af8ac5be5adb6Daniel DunbarCINDEX_LINKAGE void clang_disposeIndex(CXIndex index); 2011efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2021efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 203c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_FILES File manipulation routines 204f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 205f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @{ 206f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 2071efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 208f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 209f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief A particular source file that is part of a translation unit. 210f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 211f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregortypedef void *CXFile; 2121efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 213f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor 214f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 215f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief Retrieve the complete file and path name of the given file. 21688145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff */ 21774844072411bae91d5dbb89955d200cbe1e0a1c8Ted KremenekCINDEX_LINKAGE CXString clang_getFileName(CXFile SFile); 2181efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 219f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 220f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief Retrieve the last modification time of the given file. 221f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 22208b0e8daeb683686b876d72674962ad96df21d45Douglas GregorCINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile); 22388145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff 2243c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor/** 225b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a file handle within the given translation unit. 226b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 227b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \param tu the translation unit 2281efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 229b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \param file_name the name of the file. 230b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 231b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns the file handle for the named file in the translation unit \p tu, 232b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * or a NULL file handle if the file was not a part of this translation unit. 233b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 2341efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu, 235b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor const char *file_name); 2361efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 237b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 238f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @} 239f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 240f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor 241f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 242f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \defgroup CINDEX_LOCATIONS Physical source locations 243f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 244f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * Clang represents physical source locations in its abstract syntax tree in 245f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * great detail, with file, line, and column information for the majority of 246f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * the tokens parsed in the source code. These data types and functions are 247f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * used to represent source location information, either for a particular 248f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * point in the program or for a range of points in the program, and extract 249f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * specific location information from those data types. 250f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 251f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @{ 252f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 2531efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 254f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 2551db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * \brief Identifies a specific source location within a translation 2561db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * unit. 2571db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 258a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * Use clang_getInstantiationLocation() or clang_getSpellingLocation() 259a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * to map a source location to a particular file, line, and column. 2603c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor */ 2613c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregortypedef struct { 2625352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor void *ptr_data[2]; 2631db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned int_data; 2643c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor} CXSourceLocation; 265fe6fd3d41a7f48317d6856c9327b6cead32c3498Ted Kremenek 2663c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor/** 267d52864bd33c66aacc84133460d8c9c0dfcdd5c18Daniel Dunbar * \brief Identifies a half-open character range in the source code. 2683c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor * 2691db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the 2701db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * starting and end locations from a source range, respectively. 2713c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor */ 2723c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregortypedef struct { 2735352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor void *ptr_data[2]; 2741db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned begin_int_data; 2751db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned end_int_data; 2763c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor} CXSourceRange; 277fe6fd3d41a7f48317d6856c9327b6cead32c3498Ted Kremenek 2781db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor/** 279b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a NULL (invalid) source location. 280b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 281b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getNullLocation(); 2821efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 283b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 284b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \determine Determine whether two source locations, which must refer into 2851efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * the same translation unit, refer to exactly the same point in the source 286b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * code. 287b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 288b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns non-zero if the source locations refer to the same location, zero 289b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * if they refer to different locations. 290b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 291b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1, 292b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXSourceLocation loc2); 2931efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 294b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 2951efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieves the source location associated with a given file/line/column 2961efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * in a particular translation unit. 297b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 298b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu, 299b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXFile file, 300b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor unsigned line, 301b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor unsigned column); 30283889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall/** 30383889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall * \brief Retrieves the source location associated with a given character offset 30483889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall * in a particular translation unit. 30583889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall */ 30683889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid ChisnallCINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu, 30783889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall CXFile file, 30883889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall unsigned offset); 3091efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 310b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 3115352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve a NULL (invalid) source range. 3125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 3135352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXSourceRange clang_getNullRange(); 314896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 316b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a source range given the beginning and ending source 317b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * locations. 318b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 319b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin, 320b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXSourceLocation end); 3211efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 322b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 32346766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * \brief Retrieve the file, line, column, and offset represented by 32446766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * the given source location. 3251db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 326a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * If the location refers into a macro instantiation, retrieves the 327a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * location of the macro instantiation. 328a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 3291efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param location the location within a source file that will be decomposed 3301efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * into its parts. 3311db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3321efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param file [out] if non-NULL, will be set to the file to which the given 3331db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * source location points. 3341db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3351efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param line [out] if non-NULL, will be set to the line to which the given 3361db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * source location points. 3371db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3381efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param column [out] if non-NULL, will be set to the column to which the given 3391efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source location points. 34046766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * 34146766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * \param offset [out] if non-NULL, will be set to the offset into the 34246766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * buffer to which the given source location points. 3431db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 3441db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location, 3451db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor CXFile *file, 3461db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned *line, 34746766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor unsigned *column, 34846766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor unsigned *offset); 349e69517ce61638f12c9abe4605753a45275ac4e37Douglas Gregor 350e69517ce61638f12c9abe4605753a45275ac4e37Douglas Gregor/** 351a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \brief Retrieve the file, line, column, and offset represented by 352a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * the given source location. 353a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 354a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * If the location refers into a macro instantiation, return where the 355a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * location was originally spelled in the source file. 356a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 357a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param location the location within a source file that will be decomposed 358a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * into its parts. 359a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 360a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param file [out] if non-NULL, will be set to the file to which the given 361a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 362a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 363a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param line [out] if non-NULL, will be set to the line to which the given 364a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 365a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 366a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param column [out] if non-NULL, will be set to the column to which the given 367a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 368a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 369a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param offset [out] if non-NULL, will be set to the offset into the 370a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * buffer to which the given source location points. 371a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor */ 372a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas GregorCINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location, 373a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor CXFile *file, 374a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *line, 375a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *column, 376a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *offset); 377a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor 378a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor/** 3791efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve a source location representing the first character within a 3801efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source range. 3811db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 3821db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range); 3831db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor 3841db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor/** 3851efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve a source location representing the last character within a 3861efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source range. 3871db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 3881db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range); 3891db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor 390f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 391f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @} 392f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 393c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 394c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 3955352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \defgroup CINDEX_DIAG Diagnostic reporting 3965352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 3975352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @{ 3985352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 3995352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4005352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 4015352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Describes the severity of a particular diagnostic. 4025352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4035352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorenum CXDiagnosticSeverity { 4045352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 405896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief A diagnostic that has been suppressed, e.g., by a command-line 4065352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * option. 4075352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4085352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Ignored = 0, 409896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 4105352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 4115352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic is a note that should be attached to the 4125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * previous (non-note) diagnostic. 4135352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4145352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Note = 1, 4155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4165352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 4175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates suspicious code that may not be 4185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * wrong. 4195352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Warning = 2, 4215352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4225352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 4235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates that the code is ill-formed. 4245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4255352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Error = 3, 4265352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 4285352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates that the code is ill-formed such 4295352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * that future parser recovery is unlikely to produce useful 4305352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * results. 4315352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4325352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Fatal = 4 4335352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor}; 4345352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4355352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 4365352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief A single diagnostic, containing the diagnostic's severity, 4375352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * location, text, source ranges, and fix-it hints. 4385352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4395352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregortypedef void *CXDiagnostic; 4405352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4415352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 442a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced for the given 443a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * translation unit. 444a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 445a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit); 446a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 447a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 448a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given translation unit. 4495352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 450a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Unit the translation unit to query. 451a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 4525352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 453a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 454a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 4555352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 456a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit, 457a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 458a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 459a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 460a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Destroy a diagnostic. 461a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 462a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic); 4635352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4645352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 4650a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Options to control the display of diagnostics. 4660a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4670a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * The values in this enum are meant to be combined to customize the 4680a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * behavior of \c clang_displayDiagnostic(). 4690a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 4700a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregorenum CXDiagnosticDisplayOptions { 4710a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 4720a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Display the source-location information where the 4730a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic was located. 4740a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4750a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * When set, diagnostics will be prefixed by the file, line, and 4760a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * (optionally) column to which the diagnostic refers. For example, 4770a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4780a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \code 4790a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * test.c:28: warning: extra tokens at end of #endif directive 4800a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \endcode 4810a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4820a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-source-location. 4830a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 4840a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplaySourceLocation = 0x01, 4850a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 4860a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 4870a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 4880a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include the column number. 4890a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4900a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-column. 4910a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 4920a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplayColumn = 0x02, 4930a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 4940a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 4950a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 4960a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include information about source ranges in a 4970a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * machine-parsable format. 4980a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 499896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * This option corresponds to the clang flag 5000a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \c -fdiagnostics-print-source-range-info. 5010a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 502aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplaySourceRanges = 0x04, 503aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 504aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 505aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the option name associated with this diagnostic, if any. 506aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 507aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The option name displayed (e.g., -Wconversion) will be placed in brackets 508aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * after the diagnostic text. This option corresponds to the clang flag 509aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-option. 510aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 511aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayOption = 0x08, 512aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 513aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 514aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the category number associated with this diagnostic, if any. 515aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 516aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The category number is displayed within brackets after the diagnostic text. 517aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * This option corresponds to the clang flag 518aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-category=id. 519aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 520aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayCategoryId = 0x10, 521aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 522aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 523aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the category name associated with this diagnostic, if any. 524aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 525aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The category name is displayed within brackets after the diagnostic text. 526aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * This option corresponds to the clang flag 527aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-category=name. 528aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 529aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayCategoryName = 0x20 5300a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor}; 5310a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 5320a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 533274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \brief Format the given diagnostic in a manner that is suitable for display. 5340a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 535274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * This routine will format the given diagnostic to a string, rendering 536896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the diagnostic according to the various options given. The 537896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \c clang_defaultDiagnosticDisplayOptions() function returns the set of 5380a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * options that most closely mimics the behavior of the clang compiler. 5390a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 5400a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \param Diagnostic The diagnostic to print. 5410a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 542896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Options A set of options that control the diagnostic display, 5430a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * created by combining \c CXDiagnosticDisplayOptions values. 544274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * 545274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \returns A new string containing for formatted diagnostic. 5460a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 547274f1906f12ebf8fcc179701deeda6d3271120c1Douglas GregorCINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic, 548274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor unsigned Options); 5490a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 5500a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 5510a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Retrieve the set of display options most similar to the 5520a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * default behavior of the clang compiler. 5530a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 5540a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \returns A set of display options suitable for use with \c 5550a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * clang_displayDiagnostic(). 5560a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 5570a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void); 5580a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 5590a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 5605352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the severity of the given diagnostic. 5615352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 562896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE enum CXDiagnosticSeverity 5635352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getDiagnosticSeverity(CXDiagnostic); 5645352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5655352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5665352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the source location of the given diagnostic. 5675352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 5685352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * This location is where Clang would print the caret ('^') when 5695352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * displaying the diagnostic on the command line. 5705352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5715352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic); 5725352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5735352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5745352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the text of the given diagnostic. 5755352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5765352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic); 577a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor 578a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor/** 579aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the name of the command-line option that enabled this 580aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostic. 581aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 582aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Diag The diagnostic to be queried. 583aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 584aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Disable If non-NULL, will be set to the option that disables this 585aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostic (if any). 586aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 587aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns A string that contains the command-line option used to enable this 588aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * warning, such as "-Wconversion" or "-pedantic". 589aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 590aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag, 591aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXString *Disable); 592aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 593aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 594aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the category number for this diagnostic. 595aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 596aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * Diagnostics can be categorized into groups along with other, related 597aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostics (e.g., diagnostics under the same warning flag). This routine 598aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * retrieves the category number for the given diagnostic. 599aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 600aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns The number of the category that contains this diagnostic, or zero 601aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * if this diagnostic is uncategorized. 602aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 603aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic); 604aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 605aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 606aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the name of a particular diagnostic category. 607aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 608aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Category A diagnostic category number, as returned by 609aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c clang_getDiagnosticCategory(). 610aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 611aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns The name of the given diagnostic category. 612aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 613aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticCategoryName(unsigned Category); 614aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 615aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 616a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Determine the number of source ranges associated with the given 617a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * diagnostic. 618a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor */ 619a3890baf1256ff26081306c7fef70202f8223f41Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic); 620896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 6215352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 622a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Retrieve a source range associated with the diagnostic. 6235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 624a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * A diagnostic's source ranges highlight important elements in the source 6255352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * code. On the command line, Clang displays source ranges by 626896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * underlining them with '~' characters. 6275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 628a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \param Diagnostic the diagnostic whose range is being extracted. 6295352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 630896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Range the zero-based index specifying which range to 6315352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 632a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \returns the requested source range. 6335352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 634896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic, 635a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor unsigned Range); 6365352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6375352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6385352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the number of fix-it hints associated with the 6395352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * given diagnostic. 6405352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 6415352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic); 6425352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6435352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 644473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \brief Retrieve the replacement information for a given fix-it. 6455352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 646473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * Fix-its are described in terms of a source range whose contents 647473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * should be replaced by a string. This approach generalizes over 648473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * three kinds of operations: removal of source code (the range covers 649473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * the code to be removed and the replacement string is empty), 650473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replacement of source code (the range covers the code to be 651473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced and the replacement string provides the new code), and 652473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion (both the start and end of the range point at the 653473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion location, and the replacement string provides the text to 654473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insert). 6555352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 656473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param Diagnostic The diagnostic whose fix-its are being queried. 6575352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 658473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param FixIt The zero-based index of the fix-it. 6595352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 660473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param ReplacementRange The source range whose contents will be 661473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced with the returned replacement string. Note that source 662473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * ranges are half-open ranges [a, b), so the source code should be 663473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced from a and up to (but not including) b. 6645352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 665473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \returns A string containing text that should be replace the source 666473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * code indicated by the \c ReplacementRange. 6675352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 668896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic, 669473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor unsigned FixIt, 670473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor CXSourceRange *ReplacementRange); 6715352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6725352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6735352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 6745352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 6755352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6765352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6775352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation 6785352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6795352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * The routines in this group provide the ability to create and destroy 6805352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * translation units from files, either by parsing the contents of the files or 6815352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * by reading in a serialized representation of a translation unit. 6825352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6835352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @{ 6845352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 685896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 6865352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6875352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Get the original translation unit source file name. 6885352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 6895352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString 6905352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getTranslationUnitSpelling(CXTranslationUnit CTUnit); 6915352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6925352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6935352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Return the CXTranslationUnit for a given source file and the provided 6945352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * command line arguments one would pass to the compiler. 6955352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6965352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: The 'source_filename' argument is optional. If the caller provides a 6975352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * NULL pointer, the name of the source file is expected to reside in the 6985352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * specified command line arguments. 6995352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7005352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: When encountered in 'clang_command_line_args', the following options 7015352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * are ignored: 7025352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7035352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-c' 7045352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-emit-ast' 7055352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-fsyntax-only' 7065352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-o <output file>' (both '-o' and '<output file>' are ignored) 7075352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7081ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param CIdx The index object with which the translation unit will be 7091ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * associated. 7105352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7115352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param source_filename - The name of the source file to load, or NULL if the 7121ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * source file is included in \p clang_command_line_args. 7131ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * 7141ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param num_clang_command_line_args The number of command-line arguments in 7151ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \p clang_command_line_args. 7161ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * 7171ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param clang_command_line_args The command-line arguments that would be 7181ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * passed to the \c clang executable if it were being invoked out-of-process. 7191ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * These command-line options will be parsed and will affect how the translation 7201ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * unit is parsed. Note that the following options are ignored: '-c', 7211ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'. 7225352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 7245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * unsaved_files. 7255352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7265352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 7275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * but may be required for code completion, including the contents of 728c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * those files. The contents and name of these files (as specified by 729c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * CXUnsavedFile) are copied when necessary, so the client only needs to 730c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * guarantee their validity until the call to this function returns. 7315352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 7325352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile( 7335352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXIndex CIdx, 7345352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor const char *source_filename, 7355352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor int num_clang_command_line_args, 7362ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *clang_command_line_args, 7375352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor unsigned num_unsaved_files, 738a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor struct CXUnsavedFile *unsaved_files); 739896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 7405352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7415352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Create a translation unit from an AST file (-emit-ast). 7425352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 743896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(CXIndex, 744a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const char *ast_filename); 7455352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 74644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor/** 74744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Flags that control the creation of translation units. 74844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 74944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * The enumerators in this enumeration type are meant to be bitwise 75044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * ORed together to specify which options should be used when 75144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * constructing the translation unit. 75244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 7535a43021ac491bf091494167127772a20d9a9bb48Douglas Gregorenum CXTranslationUnit_Flags { 7545a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 7555a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that no special translation-unit options are 7565a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * needed. 7575a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 7585a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor CXTranslationUnit_None = 0x0, 7595a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 7605a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 7615a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that the parser should construct a "detailed" 7625a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * preprocessing record, including all macro definitions and instantiations. 7635a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 7645a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * Constructing a detailed preprocessing record requires more memory 7655a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * and time to parse, since the information contained in the record 7665a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is usually not retained. However, it can be useful for 7675a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * applications that require more detailed information about the 7685a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * behavior of the preprocessor. 7695a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 77044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor CXTranslationUnit_DetailedPreprocessingRecord = 0x01, 77144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 77244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 773b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Used to indicate that the translation unit is incomplete. 77444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 775b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * When a translation unit is considered "incomplete", semantic 776b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * analysis that is typically performed at the end of the 777b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * translation unit will be suppressed. For example, this suppresses 778b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * the completion of tentative declarations in C and of 779b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * instantiation of implicitly-instantiation function templates in 780b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * C++. This option is typically used when parsing a header with the 781b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * intent of producing a precompiled header. 78244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 783b1c031be513705d924038f497279b9b599868ba1Douglas Gregor CXTranslationUnit_Incomplete = 0x02, 78444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 78544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 78644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Used to indicate that the translation unit should be built with an 78744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header for the preamble. 78844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 78944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * An implicit precompiled header is used as an optimization when a 79044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * particular translation unit is likely to be reparsed many times 79144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * when the sources aren't changing that often. In this case, an 79244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header will be built containing all of the 79344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * initial includes at the top of the main file (what we refer to as 79444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * the "preamble" of the file). In subsequent parses, if the 79544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * preamble or the files in it have not changed, \c 79644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * clang_reparseTranslationUnit() will re-use the implicit 79744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * precompiled header to improve parsing performance. 79844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 799e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXTranslationUnit_PrecompiledPreamble = 0x04, 800e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 801e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 802e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that the translation unit should cache some 803e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion results with each reparse of the source file. 804e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 805e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * Caching of code-completion results is a performance optimization that 806e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * introduces some overhead to reparsing but improves the performance of 807e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion operations. 808e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 80999ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CacheCompletionResults = 0x08, 81099ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 81199ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * \brief Enable precompiled preambles in C++. 81299ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 81399ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 81499ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * we are testing C++ precompiled preamble support. 81599ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 81699ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CXXPrecompiledPreamble = 0x10, 81799ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor 81899ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 81999ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * \brief Enabled chained precompiled preambles in C++. 82099ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 82199ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 82299ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * we are testing C++ precompiled preamble support. 82399ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 82499ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CXXChainedPCH = 0x20 8255a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor}; 8265a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 8275a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor/** 828b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Returns the set of flags that is suitable for parsing a translation 829b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * unit that is being edited. 830b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * 831b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * The set of flags returned provide options for \c clang_parseTranslationUnit() 832b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * to indicate that the translation unit is likely to be reparsed many times, 833b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly 834b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag 835b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set contains an unspecified set of optimizations (e.g., the precompiled 836b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * preamble) geared toward improving the performance of these routines. The 837b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set of optimizations enabled may change from one version to the next. 838b1c031be513705d924038f497279b9b599868ba1Douglas Gregor */ 839e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void); 840b1c031be513705d924038f497279b9b599868ba1Douglas Gregor 841b1c031be513705d924038f497279b9b599868ba1Douglas Gregor/** 8425a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Parse the given source file and the translation unit corresponding 8435a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * to that file. 8445a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8455a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * This routine is the main entry point for the Clang C API, providing the 8465a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * ability to parse a source file into a translation unit that can then be 8475a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * queried by other functions in the API. This routine accepts a set of 8485a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * command-line arguments so that the compilation can be configured in the same 8495a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * way that the compiler is configured on the command line. 8505a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8515a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param CIdx The index object with which the translation unit will be 8525a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * associated. 8535a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8545a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param source_filename The name of the source file to load, or NULL if the 8551ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * source file is included in \p command_line_args. 8565a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8575a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param command_line_args The command-line arguments that would be 8585a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * passed to the \c clang executable if it were being invoked out-of-process. 8595a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * These command-line options will be parsed and will affect how the translation 8605a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unit is parsed. Note that the following options are ignored: '-c', 8615a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'. 8625a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8635a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_command_line_args The number of command-line arguments in 8645a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \p command_line_args. 8655a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8665a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 8671abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing, including the contents of 8685a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * those files. The contents and name of these files (as specified by 8695a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 8705a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * guarantee their validity until the call to this function returns. 8715a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8725a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 8735a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unsaved_files. 8745a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8755a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param options A bitmask of options that affects how the translation unit 8765a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is managed but not its compilation. This should be a bitwise OR of the 8775a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXTranslationUnit_XXX flags. 8785a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8795a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \returns A new translation unit describing the parsed code and containing 8805a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * any diagnostics produced by the compiler. If there is a failure from which 8815a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * the compiler cannot recover, returns NULL. 8825a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 8835a43021ac491bf091494167127772a20d9a9bb48Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx, 8845a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor const char *source_filename, 8852ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *command_line_args, 8865a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor int num_command_line_args, 8875a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor struct CXUnsavedFile *unsaved_files, 8885a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned num_unsaved_files, 8895a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned options); 8905a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 8915352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 8921999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Flags that control how translation units are saved. 8931999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 8941999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 8951999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * ORed together to specify which options should be used when 8961999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * saving the translation unit. 8971999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 8981999844e7a18786e61e619e1dc6c789827541863Douglas Gregorenum CXSaveTranslationUnit_Flags { 8991999844e7a18786e61e619e1dc6c789827541863Douglas Gregor /** 9001999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Used to indicate that no special saving options are needed. 9011999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 9021999844e7a18786e61e619e1dc6c789827541863Douglas Gregor CXSaveTranslationUnit_None = 0x0 9031999844e7a18786e61e619e1dc6c789827541863Douglas Gregor}; 9041999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 9051999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 9061999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Returns the set of flags that is suitable for saving a translation 9071999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * unit. 9081999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 9091999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The set of flags returned provide options for 9101999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \c clang_saveTranslationUnit() by default. The returned flag 9111999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * set contains an unspecified set of options that save translation units with 9121999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * the most commonly-requested data. 9131999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 9141999844e7a18786e61e619e1dc6c789827541863Douglas GregorCINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU); 9151999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 9161999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 9177ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \brief Saves a translation unit into a serialized representation of 9187ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * that translation unit on disk. 9197ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 9207ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * Any translation unit that was parsed without error can be saved 9217ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * into a file. The translation unit can then be deserialized into a 9227ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * new \c CXTranslationUnit with \c clang_createTranslationUnit() or, 9237ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * if it is an incomplete translation unit that corresponds to a 9247ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * header, used as a precompiled header when parsing other translation 9257ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * units. 9267ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 9277ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param TU The translation unit to save. 9281999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 9297ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param FileName The file to which the translation unit will be saved. 9307ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 9311999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \param options A bitmask of options that affects how the translation unit 9321999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * is saved. This should be a bitwise OR of the 9331999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * CXSaveTranslationUnit_XXX flags. 9341999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 9357ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \returns Zero if the translation unit was saved successfully, a 9367ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * non-zero value otherwise. 9377ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor */ 9387ae2faafd30524ef5f863bb3b8701977888839bbDouglas GregorCINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU, 9391999844e7a18786e61e619e1dc6c789827541863Douglas Gregor const char *FileName, 9401999844e7a18786e61e619e1dc6c789827541863Douglas Gregor unsigned options); 9417ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 9427ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor/** 9435352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Destroy the specified CXTranslationUnit object. 9445352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 9455352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit); 946896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 9475352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 948e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Flags that control the reparsing of translation units. 949e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 950e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 951e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * ORed together to specify which options should be used when 952e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * reparsing the translation unit. 953e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 954e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregorenum CXReparse_Flags { 955e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 956e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that no special reparsing options are needed. 957e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 958e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXReparse_None = 0x0 959e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor}; 960e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 961e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 962e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Returns the set of flags that is suitable for reparsing a translation 963e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * unit. 964e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 965e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The set of flags returned provide options for 966e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \c clang_reparseTranslationUnit() by default. The returned flag 967e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * set contains an unspecified set of optimizations geared toward common uses 968e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * of reparsing. The set of optimizations enabled may change from one version 969e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * to the next. 970e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 971e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU); 972e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 973e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 974abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \brief Reparse the source files that produced this translation unit. 975abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 976abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * This routine can be used to re-parse the source files that originally 977abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * created the given translation unit, for example because those source files 978abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * have changed (either on disk or as passed via \p unsaved_files). The 979abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * source code will be reparsed with the same command-line options as it 980abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * was originally parsed. 981abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 982abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * Reparsing a translation unit invalidates all cursors and source locations 983abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * that refer into that translation unit. This makes reparsing a translation 984abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit semantically equivalent to destroying the translation unit and then 985abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * creating a new translation unit with the same command-line arguments. 986abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * However, it may be more efficient to reparse a translation 987abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit using this routine. 988abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 989abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param TU The translation unit whose contents will be re-parsed. The 990abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * translation unit must originally have been built with 991abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_createTranslationUnitFromSourceFile(). 992abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 993abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 994abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unsaved_files. 995abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 996abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param unsaved_files The files that have not yet been saved to disk 997abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * but may be required for parsing, including the contents of 998abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * those files. The contents and name of these files (as specified by 999abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 1000abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * guarantee their validity until the call to this function returns. 1001abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1002e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \param options A bitset of options composed of the flags in CXReparse_Flags. 1003e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The function \c clang_defaultReparseOptions() produces a default set of 1004e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * options recommended for most uses, based on the translation unit. 1005e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1006abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \returns 0 if the sources could be reparsed. A non-zero value will be 1007abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * returned if reparsing was impossible, such that the translation unit is 1008abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * invalid. In such cases, the only valid call for \p TU is 1009abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_disposeTranslationUnit(TU). 1010abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor */ 1011abc563f554951259bbe0315055cad92ee14d87e4Douglas GregorCINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU, 1012abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned num_unsaved_files, 1013e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor struct CXUnsavedFile *unsaved_files, 1014e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor unsigned options); 1015abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 1016abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor/** 10175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 10185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 1019896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 10205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 1021c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes the kind of entity that a cursor refers to. 1022c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1023c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXCursorKind { 1024c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Declarations */ 10251efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1026c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A declaration whose specific kind is not exposed via this 10271efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 1028c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1029c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed declarations have the same operations as any other kind 1030c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of declaration; one can extract their location information, 1031c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, find their definitions, etc. However, the specific kind 1032c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of the declaration is not reported. 1033c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1034c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedDecl = 1, 1035c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ struct. */ 10361efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_StructDecl = 2, 1037c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ union. */ 1038c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnionDecl = 3, 1039c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C++ class. */ 1040c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ClassDecl = 4, 1041c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumeration. */ 1042c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumDecl = 5, 10431efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1044c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A field (in C) or non-static data member (in C++) in a 1045c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * struct, union, or C++ class. 1046c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1047c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FieldDecl = 6, 1048c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumerator constant. */ 1049c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumConstantDecl = 7, 1050c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function. */ 1051c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FunctionDecl = 8, 1052c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A variable. */ 1053c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_VarDecl = 9, 1054c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function or method parameter. */ 1055c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ParmDecl = 10, 1056c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @interface. */ 1057c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInterfaceDecl = 11, 1058c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @interface for a category. */ 1059c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryDecl = 12, 1060c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @protocol declaration. */ 1061c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolDecl = 13, 1062c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @property declaration. */ 1063c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCPropertyDecl = 14, 1064c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance variable. */ 1065c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCIvarDecl = 15, 1066c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance method. */ 1067c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInstanceMethodDecl = 16, 1068c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C class method. */ 1069c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassMethodDecl = 17, 1070c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @implementation. */ 1071c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCImplementationDecl = 18, 1072c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @implementation for a category. */ 1073c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryImplDecl = 19, 1074c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A typedef */ 1075c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypedefDecl = 20, 10768bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek /** \brief A C++ class method. */ 10778bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek CXCursor_CXXMethod = 21, 10788f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek /** \brief A C++ namespace. */ 10798f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek CXCursor_Namespace = 22, 1080a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek /** \brief A linkage specification, e.g. 'extern "C"'. */ 1081a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek CXCursor_LinkageSpec = 23, 108201829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ constructor. */ 108301829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Constructor = 24, 108401829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ destructor. */ 108501829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Destructor = 25, 108601829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ conversion function. */ 108701829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_ConversionFunction = 26, 1088fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template type parameter. */ 1089fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTypeParameter = 27, 1090fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ non-type template parameter. */ 1091fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_NonTypeTemplateParameter = 28, 1092fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template template parameter. */ 1093fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTemplateParameter = 29, 1094fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ function template. */ 1095fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_FunctionTemplate = 30, 109639d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor /** \brief A C++ class template. */ 109739d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor CXCursor_ClassTemplate = 31, 109874dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor /** \brief A C++ class template partial specialization. */ 109974dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor CXCursor_ClassTemplatePartialSpecialization = 32, 11006931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** \brief A C++ namespace alias declaration. */ 11016931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceAlias = 33, 11020a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor /** \brief A C++ using directive. */ 11030a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor CXCursor_UsingDirective = 34, 11047e24256c95afb64b4d5abf201a0f9f0527cb4cf3Douglas Gregor /** \brief A using declaration. */ 11057e24256c95afb64b4d5abf201a0f9f0527cb4cf3Douglas Gregor CXCursor_UsingDeclaration = 35, 110650aa6acd0b8d40c8956372a69e0a73f0802a5494Ted Kremenek CXCursor_FirstDecl = CXCursor_UnexposedDecl, 11077e24256c95afb64b4d5abf201a0f9f0527cb4cf3Douglas Gregor CXCursor_LastDecl = CXCursor_UsingDeclaration, 11081efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1109c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* References */ 1110c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstRef = 40, /* Decl references */ 11111efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_ObjCSuperClassRef = 40, 1112c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolRef = 41, 1113c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassRef = 42, 1114c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1115c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A reference to a type declaration. 1116c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1117c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A type reference occurs anywhere where a type is named but not 1118c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * declared. For example, given: 1119c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1120c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \code 1121c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * typedef unsigned size_type; 1122c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * size_type size; 1123c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \endcode 1124c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1125c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The typedef is a declaration of size_type (CXCursor_TypedefDecl), 1126c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * while the type of the variable "size" is referenced. The cursor 1127c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * referenced by the type of size is the typedef for size_type. 1128c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1129c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypeRef = 43, 11303064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CXCursor_CXXBaseSpecifier = 44, 11310b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor /** 1132a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * \brief A reference to a class template, function template, template 1133a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * template parameter, or class template partial specialization. 11340b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor */ 11350b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor CXCursor_TemplateRef = 45, 11366931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** 11376931900f43cea558c6974075256c07728dbfecc6Douglas Gregor * \brief A reference to a namespace or namespace alias. 11386931900f43cea558c6974075256c07728dbfecc6Douglas Gregor */ 11396931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceRef = 46, 1140a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor /** 114136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a member of a struct, union, or class that occurs in 114236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * some non-expression context, e.g., a designated initializer. 1143a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor */ 1144a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor CXCursor_MemberRef = 47, 114536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** 114636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a labeled statement. 114736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 114836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the jump to "start_over" in the 114936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto statement in the following example: 115036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 115136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 115236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 115336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 115436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 115536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto start_over; 115636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 115736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 115836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * A label reference cursor refers to a label statement. 115936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 116036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelRef = 48, 116136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 11621f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor /** 11631f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief A reference to a set of overloaded functions or function templates 11641f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * that has not yet been resolved to a specific function or function template. 11651f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 11661f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * An overloaded declaration reference cursor occurs in C++ templates where 11671f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * a dependent name refers to a function. For example: 11681f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 11691f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \code 11701f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> void swap(T&, T&); 11711f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 11721f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct X { ... }; 11731f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(X&, X&); 11741f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 11751f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> 11761f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void reverse(T* first, T* last) { 11771f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * while (first < last - 1) { 11781f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * swap(*first, *--last); 11791f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * ++first; 11801f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 11811f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 11821f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 11831f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct Y { }; 11841f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(Y&, Y&); 11851f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \endcode 11861f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 11871f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * Here, the identifier "swap" is associated with an overloaded declaration 11881f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * reference. In the template definition, "swap" refers to either of the two 11891f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * "swap" functions declared above, so both results will be available. At 11901f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * instantiation time, "swap" may also refer to other functions found via 11911f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * argument-dependent lookup (e.g., the "swap" function at the end of the 11921f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * example). 11931f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 11941f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * The functions \c clang_getNumOverloadedDecls() and 11951f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c clang_getOverloadedDecl() can be used to retrieve the definitions 11961f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * referenced by this cursor. 11971f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 11981f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor CXCursor_OverloadedDeclRef = 49, 11991f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 12001f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor CXCursor_LastRef = CXCursor_OverloadedDeclRef, 12011efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1202c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Error conditions */ 1203c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstInvalid = 70, 1204c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_InvalidFile = 70, 1205c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NoDeclFound = 71, 1206c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NotImplemented = 72, 1207ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_InvalidCode = 73, 1208ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_LastInvalid = CXCursor_InvalidCode, 12091efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1210c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Expressions */ 1211c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstExpr = 100, 12121efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1213c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1214c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression whose specific kind is not exposed via this 12151efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 1216c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1217c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed expressions have the same operations as any other kind 1218c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of expression; one can extract their location information, 1219c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, children, etc. However, the specific kind of the 1220c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * expression is not reported. 1221c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1222c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedExpr = 100, 12231efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1224c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1225c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to some value declaration, such 1226c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * as a function, varible, or enumerator. 1227c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1228c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_DeclRefExpr = 101, 12291efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1230c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1231c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to a member of a struct, union, 1232c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * class, Objective-C class, etc. 1233c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1234c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_MemberRefExpr = 102, 12351efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1236c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that calls a function. */ 1237c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_CallExpr = 103, 12381efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1239c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that sends a message to an Objective-C 1240c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor object or class. */ 1241c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCMessageExpr = 104, 12421ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 12431ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek /** \brief An expression that represents a block literal. */ 12441ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek CXCursor_BlockExpr = 105, 12451ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 12461ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek CXCursor_LastExpr = 105, 12471efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1248c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Statements */ 1249c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstStmt = 200, 1250c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1251c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A statement whose specific kind is not exposed via this 1252c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * interface. 1253c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1254c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed statements have the same operations as any other kind of 1255c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * statement; one can extract their location information, spelling, 1256c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * children, etc. However, the specific kind of the statement is not 1257c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reported. 1258c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1259c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedStmt = 200, 126036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 126136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** \brief A labelled statement in a function. 126236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 126336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the "start_over:" label statement in 126436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * the following example: 126536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 126636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 126736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 126836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 126936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 127036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 127136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 127236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelStmt = 201, 127336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 127436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LastStmt = CXCursor_LabelStmt, 12751efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1276c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1277c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Cursor that represents the translation unit itself. 1278c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1279c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor exists primarily to act as the root 1280c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor for traversing the contents of a translation unit. 1281c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1282e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_TranslationUnit = 300, 1283e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1284e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /* Attributes */ 1285e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_FirstAttr = 400, 1286e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /** 1287e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * \brief An attribute whose specific kind is not exposed via this 1288e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * interface. 1289e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek */ 1290e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_UnexposedAttr = 400, 1291e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1292e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBActionAttr = 401, 1293e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBOutletAttr = 402, 1294857e918a8a40deb128840308a318bf623d68295fTed Kremenek CXCursor_IBOutletCollectionAttr = 403, 1295857e918a8a40deb128840308a318bf623d68295fTed Kremenek CXCursor_LastAttr = CXCursor_IBOutletCollectionAttr, 12969f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 12979f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor /* Preprocessing */ 12989f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_PreprocessingDirective = 500, 1299572feb2a190b5e8b04fb06c4ac50ee0f61e93ff0Douglas Gregor CXCursor_MacroDefinition = 501, 1300572feb2a190b5e8b04fb06c4ac50ee0f61e93ff0Douglas Gregor CXCursor_MacroInstantiation = 502, 1301ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_InclusionDirective = 503, 13029f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective, 1303ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_LastPreprocessing = CXCursor_InclusionDirective 1304c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 1305c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1306c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1307c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A cursor representing some element in the abstract syntax tree for 1308c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a translation unit. 1309c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 13101efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor abstraction unifies the different kinds of entities in a 1311c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * program--declaration, statements, expressions, references to declarations, 1312c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * etc.--under a single "cursor" abstraction with a common set of operations. 1313c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Common operation for a cursor include: getting the physical location in 1314c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a source file where the cursor points, getting the name associated with a 1315c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor, and retrieving cursors for any child nodes of a particular cursor. 1316c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1317c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors can be produced in two specific ways. 1318c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_getTranslationUnitCursor() produces a cursor for a translation unit, 1319c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * from which one can use clang_visitChildren() to explore the rest of the 1320c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * translation unit. clang_getCursor() maps from a physical source location 1321c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to the entity that resides at that location, allowing one to map from the 1322c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * source code into the AST. 1323c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1324c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregortypedef struct { 1325c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor enum CXCursorKind kind; 1326c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor void *data[3]; 13271efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar} CXCursor; 1328c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1329c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1330c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations 1331c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1332c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 1333c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 13341efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1335c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1336c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the NULL cursor, which represents no entity. 1337c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1338c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getNullCursor(void); 13391efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1340c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1341c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the cursor that represents the given translation unit. 1342c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1343c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor can be used to start traversing the 1344c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * various declarations within the given translation unit. 1345c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1346c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit); 1347c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1348c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1349c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether two cursors are equivalent. 1350c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1351c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor); 13521efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1353c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 13549ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor * \brief Compute a hash value for the given cursor. 13559ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor */ 13569ce5584553054d0cb934940586aca0186e87fa57Douglas GregorCINDEX_LINKAGE unsigned clang_hashCursor(CXCursor); 13579ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor 13589ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor/** 1359c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the kind of the given cursor. 1360c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1361c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor); 1362c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1363c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1364c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a declaration. 1365c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1366c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind); 1367c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1368c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1369c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a simple 1370c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reference. 1371c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1372c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Note that other kinds of cursors (such as expressions) can also refer to 1373c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * other cursors. Use clang_getCursorReferenced() to determine whether a 1374c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * particular cursor refers to another entity. 1375c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1376c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind); 1377c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1378c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1379c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents an expression. 1380c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1381c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind); 1382c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1383c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1384c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a statement. 1385c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1386c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind); 1387c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1388c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 13891efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents an invalid 1390c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor. 13911efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar */ 1392c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind); 1393c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1394c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 13951efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents a translation 13961efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unit. 1397c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1398c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind); 13991efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1400ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek/*** 14019f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * \brief Determine whether the given cursor represents a preprocessing 14029f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * element, such as a preprocessor directive or macro instantiation. 14039f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor */ 14049f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas GregorCINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind); 14059f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 14069f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor/*** 1407ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * \brief Determine whether the given cursor represents a currently 1408ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt). 1409ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek */ 1410ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted KremenekCINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind); 1411ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek 1412c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 141316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief Describe the linkage of the entity referred to by a cursor. 141416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 141516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenekenum CXLinkageKind { 141616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This value indicates that no linkage information is available 141716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * for a provided CXCursor. */ 141816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Invalid, 141916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** 142016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief This is the linkage for variables, parameters, and so on that 142116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * have automatic storage. This covers normal (non-extern) local variables. 142216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 142316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_NoLinkage, 142416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for static variables and static functions. */ 142516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Internal, 142616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with external linkage that live 142716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * in C++ anonymous namespaces.*/ 142816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_UniqueExternal, 142916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with true, external linkage. */ 143016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_External 143116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek}; 143216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 143316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 143445e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the linkage of the entity referred to by a given cursor. 143516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 143616b4259aecaa22b642d35d36fd89965ed700c1e0Ted KremenekCINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor); 143716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 143816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 143958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \brief Determine the availability of the entity that this cursor refers to. 144058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 144158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param cursor The cursor to query. 144258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 144358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the cursor. 144458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 144558ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 144658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCursorAvailability(CXCursor cursor); 144758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 144858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 144945e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Describe the "language" of the entity referred to by a cursor. 145045e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 145145e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind { 14526cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_Invalid = 0, 145345e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_C, 145445e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_ObjC, 14556cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_CPlusPlus 145645e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek}; 145745e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 145845e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 145945e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the "language" of the entity referred to by a given cursor. 146045e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 146145e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor); 146245e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 14632be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor 14642be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 14652be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the semantic parent of the given cursor. 14662be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 14672be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The semantic parent of a cursor is the cursor that semantically contains 14682be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the given \p cursor. For many declarations, the lexical and semantic parents 14692be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the lexical parent is returned by 14702be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorLexicalParent()). They diverge when declarations or 14712be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 14722be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 14732be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 14742be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 14752be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 14762be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 14772be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 14782be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 14792be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 14802be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 14812be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 14822be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 14832be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 14842be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 14852be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 14862be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 14872be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 14882be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 14892be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 14902be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 14912be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 14922be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 14932be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 14942be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 14952be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor); 14962be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor 14972be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 14982be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the lexical parent of the given cursor. 14992be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 15002be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The lexical parent of a cursor is the cursor in which the given \p cursor 15012be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * was actually written. For many declarations, the lexical and semantic parents 15022be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the semantic parent is returned by 15032be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorSemanticParent()). They diverge when declarations or 15042be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 15052be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 15062be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 15072be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 15082be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 15092be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 15102be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 15112be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 15122be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 15132be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 15142be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 15152be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 15162be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 15172be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 15182be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 15192be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 15202be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 15212be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 15222be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 15232be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 15242be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 15252be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 15262be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 15272be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 15282be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor); 15299f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 15309f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 15319f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Determine the set of methods that are overridden by the given 15329f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. 15339f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 15349f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In both Objective-C and C++, a method (aka virtual member function, 15359f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * in C++) can override a virtual method in a base class. For 15369f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * Objective-C, a method is said to override any method in the class's 15379f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * interface (if we're coming from an implementation), its protocols, 15389f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * or its categories, that has the same selector and is of the same 15399f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * kind (class or instance). If no such method exists, the search 15409f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * continues to the class's superclass, its protocols, and its 15419f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * categories, and so on. 15429f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 15439f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * For C++, a virtual member function overrides any virtual member 15449f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * function with the same signature that occurs in its base 15459f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * classes. With multiple inheritance, a virtual member function can 15469f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * override several virtual member functions coming from different 15479f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * base classes. 15489f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 15499f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In all cases, this function determines the immediate overridden 15509f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method, rather than all of the overridden methods. For example, if 15519f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * a method is originally declared in a class A, then overridden in B 15529f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * (which in inherits from A) and also in C (which inherited from B), 15539f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * then the only overridden method returned from this function when 15549f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoked on C's method will be B's method. The client may then 15559f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoke this function again, given the previously-found overridden 15569f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods, to map out the complete method-override set. 15579f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 15589f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param cursor A cursor representing an Objective-C or C++ 15599f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. This routine will compute the set of methods that this 15609f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method overrides. 15619f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 15629f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param overridden A pointer whose pointee will be replaced with a 15639f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * pointer to an array of cursors, representing the set of overridden 15649f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods. If there are no overridden methods, the pointee will be 15659f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * set to NULL. The pointee must be freed via a call to 15669f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \c clang_disposeOverriddenCursors(). 15679f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 15689f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param num_overridden A pointer to the number of overridden 15699f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * functions, will be set to the number of overridden functions in the 15709f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * array pointed to by \p overridden. 15719f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 15729f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor, 15739f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor CXCursor **overridden, 15749f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor unsigned *num_overridden); 15759f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 15769f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 15779f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Free the set of overridden cursors returned by \c 15789f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * clang_getOverriddenCursors(). 15799f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 15809f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden); 15819f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 158245e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 1583ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * \brief Retrieve the file that is included by the given inclusion directive 1584ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * cursor. 1585ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor */ 1586ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas GregorCINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor); 1587ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor 1588ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor/** 1589c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 1590c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 15911efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1592c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1593c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code 1594c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1595c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors represent a location within the Abstract Syntax Tree (AST). These 1596c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines help map between cursors and the physical locations where the 1597c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * described entities occur in the source code. The mapping is provided in 1598c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * both directions, so one can map from source code to the AST and back. 1599c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1600c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 160150398199fb10e196a8d92fbf7a062dbe42ed88fdSteve Naroff */ 16021efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 16036a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff/** 1604b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Map a source location to the cursor that describes the entity at that 1605b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * location in the source code. 1606b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 1607b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() maps an arbitrary source location within a translation 1608b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * unit down to the most specific cursor that describes the entity at that 16091efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * location. For example, given an expression \c x + y, invoking 1610b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() with a source location pointing to "x" will return the 16111efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * cursor for "x"; similarly for "y". If the cursor points anywhere between 1612b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor() 1613b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * will return a cursor referring to the "+" expression. 1614b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 1615b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns a cursor representing the entity at the given source location, or 1616b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * a NULL cursor if no such entity can be found. 16176a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff */ 1618b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation); 16191efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 162098258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor/** 162198258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * \brief Retrieve the physical location of the source constructor referenced 162298258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * by the given cursor. 162398258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * 162498258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * The location of a declaration is typically the location of the name of that 16251efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * declaration, where the name of that declaration would occur if it is 16261efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unnamed, or some keyword that introduces that particular declaration. 16271efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The location of a reference is where that reference occurs within the 162898258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * source code. 162998258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor */ 163098258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor); 1631c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1632b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor/** 1633b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Retrieve the physical extent of the source construct referenced by 1634a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the given cursor. 1635a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * 1636a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * The extent of a cursor starts with the file/line/column pointing at the 1637a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * first character within the source construct that the cursor refers to and 16381efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * ends with the last character withinin that source construct. For a 1639a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * declaration, the extent covers the declaration itself. For a reference, 1640a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the extent covers the location of the reference (e.g., where the referenced 1641a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * entity was actually used). 1642a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor */ 1643a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas GregorCINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor); 1644c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor 1645c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1646c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 1647c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 164895f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 1649c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 16508e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \defgroup CINDEX_TYPES Type information for CXCursors 16518e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 16528e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @{ 16538e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 16548e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 16558e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 16568e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Describes the kind of type 16578e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 16588e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenekenum CXTypeKind { 16598e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 16608e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Reprents an invalid type (e.g., where no type is available). 16618e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 16628e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Invalid = 0, 16638e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 16648e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 16658e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief A type whose specific kind is not exposed via this 16668e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * interface. 16678e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 16688e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Unexposed = 1, 16698e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 16708e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /* Builtin types */ 16718e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Void = 2, 16728e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Bool = 3, 16738e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_U = 4, 16748e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UChar = 5, 16758e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char16 = 6, 16768e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char32 = 7, 16778e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UShort = 8, 16788e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt = 9, 16798e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULong = 10, 16808e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULongLong = 11, 16818e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt128 = 12, 16828e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_S = 13, 16838e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_SChar = 14, 16848e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_WChar = 15, 16858e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Short = 16, 16868e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int = 17, 16878e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Long = 18, 16888e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongLong = 19, 16898e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int128 = 20, 16908e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Float = 21, 16918e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Double = 22, 16928e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongDouble = 23, 16938e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_NullPtr = 24, 16948e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Overload = 25, 16958e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Dependent = 26, 16968e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCId = 27, 16978e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCClass = 28, 16988e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCSel = 29, 16998e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_FirstBuiltin = CXType_Void, 17008e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LastBuiltin = CXType_ObjCSel, 17018e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 17028e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Complex = 100, 17038e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Pointer = 101, 17048e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_BlockPointer = 102, 17058e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LValueReference = 103, 17068e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_RValueReference = 104, 17078e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Record = 105, 17088e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Enum = 106, 17098e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Typedef = 107, 17108e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCInterface = 108, 171104c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_ObjCObjectPointer = 109, 171204c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_FunctionNoProto = 110, 171304c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_FunctionProto = 111 17148e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek}; 17158e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 17168e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 17178e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief The type of an element in the abstract syntax tree. 17188e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 17198e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 17208e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenektypedef struct { 17218e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek enum CXTypeKind kind; 17228e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek void *data[2]; 17238e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek} CXType; 17248e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 17258e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 17268e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the type of a CXCursor (if any). 17278e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 17288e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCursorType(CXCursor C); 17298e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 17308e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 17318e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \determine Determine whether two CXTypes represent the same type. 17328e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 17338e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \returns non-zero if the CXTypes represent the same type and 17348e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek zero otherwise. 17358e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 17368e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B); 17378e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 17388e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 17398e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the canonical type for a CXType. 17408e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 17418e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * Clang's type system explicitly models typedefs and all the ways 17428e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * a specific type can be represented. The canonical type is the underlying 17438e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * type with all the "sugar" removed. For example, if 'T' is a typedef 17448e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * for 'int', the canonical type for 'T' would be 'int'. 17458e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 17468e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCanonicalType(CXType T); 17478e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 17488e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 17498e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief For pointer types, returns the type of the pointee. 17508e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 17518e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 17528e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getPointeeType(CXType T); 17538e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 17548e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 17558e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the cursor for the declaration of the given type. 17568e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 17578e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T); 17588e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 17598e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 17608e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 17618e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the spelling of a given CXTypeKind. 17628e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 17638e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K); 17648e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 17658e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 17669a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * \brief Retrieve the result type associated with a function type. 176704c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek */ 176804c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted KremenekCINDEX_LINKAGE CXType clang_getResultType(CXType T); 176904c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek 177004c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek/** 17719a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * \brief Retrieve the result type associated with a given cursor. This only 17729a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * returns a valid type of the cursor refers to a function or method. 17739a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek */ 17749a140845438c2fc31e7d48a6dedbc695f4c83c68Ted KremenekCINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C); 17759a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek 17769a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek/** 17773ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * \brief Return 1 if the CXType is a POD (plain old data) type, and 0 17783ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * otherwise. 17793ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek */ 17803ce9e7d270e7df86c09c8126b4412d55be7c123bTed KremenekCINDEX_LINKAGE unsigned clang_isPODType(CXType T); 17813ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek 17823ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek/** 17833064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns 1 if the base class specified by the cursor with kind 17843064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * CX_CXXBaseSpecifier is virtual. 17853064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 17863064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor); 17873064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 17883064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 17893064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Represents the C++ access control level to a base class for a 17903064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * cursor with kind CX_CXXBaseSpecifier. 17913064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 17923064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenekenum CX_CXXAccessSpecifier { 17933064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXInvalidAccessSpecifier, 17943064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPublic, 17953064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXProtected, 17963064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPrivate 17973064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek}; 17983064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 17993064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 18003064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns the access control level for the C++ base specifier 18013064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * represented by a cursor with kind CX_CXXBaseSpecifier. 18023064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 18033064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor); 18043064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 18053064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 18061f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Determine the number of overloaded declarations referenced by a 18071f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c CXCursor_OverloadedDeclRef cursor. 18081f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 18091f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 18101f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 18111f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns The number of overloaded declarations referenced by \c cursor. If it 18121f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0. 18131f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 18141f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor); 18151f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 18161f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 18171f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Retrieve a cursor for one of the overloaded declarations referenced 18181f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * by a \c CXCursor_OverloadedDeclRef cursor. 18191f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 18201f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 18211f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 18221f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param index The zero-based index into the set of overloaded declarations in 18231f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * the cursor. 18241f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 18251f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns A cursor representing the declaration referenced by the given 18261f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c cursor at the specified \c index. If the cursor does not have an 18271f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * associated set of overloaded declarations, or if the index is out of bounds, 18281f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * returns \c clang_getNullCursor(); 18291f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 18301f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor, 18311f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor unsigned index); 18321f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 18331f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 18348e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @} 18358e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 183695f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 183795f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 1838ad72f4dad4cf0fd2b71eb8f4704d2fe7ac58fb44Ted Kremenek * \defgroup CINDEX_ATTRIBUTES Information for attributes 183995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 184095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @{ 184195f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 184295f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 184395f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 184495f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 184595f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * \brief For cursors representing an iboutletcollection attribute, 184695f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * this function returns the collection element type. 184795f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 184895f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 184995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted KremenekCINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor); 185095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 185195f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 185295f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @} 185395f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 18548e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 18558e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 1856c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors 1857c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1858c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines provide the ability to traverse the abstract syntax tree 1859c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * using cursors. 1860c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1861c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 1862c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 18631efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1864c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1865c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes how the traversal of the children of a particular 1866c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor should proceed after visiting a particular child cursor. 1867c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1868c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A value of this enumeration type should be returned by each 1869c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXCursorVisitor to indicate how clang_visitChildren() proceed. 1870c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1871c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXChildVisitResult { 1872c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 18731efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Terminates the cursor traversal. 1874c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1875c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Break, 18761efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1877c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Continues the cursor traversal with the next sibling of 1878c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the cursor just visited, without visiting its children. 1879c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1880c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Continue, 1881c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1882c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Recursively traverse the children of this cursor, using 1883c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the same visitor and client data. 1884c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1885c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Recurse 1886c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 1887c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1888c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1889c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visitor invoked for each cursor found by a traversal. 1890c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1891c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This visitor function will be invoked for each cursor found by 1892c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). Its first argument is the cursor being 1893c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited, its second argument is the parent visitor for that cursor, 1894c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and its third argument is the client data provided to 1895c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). 1896c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1897c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The visitor should return one of the \c CXChildVisitResult values 1898c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to direct clang_visitCursorChildren(). 1899c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 19001efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbartypedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor, 19011efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor parent, 1902c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 1903c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1904c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1905c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visit the children of a particular cursor. 1906c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1907c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This function visits all the direct children of the given cursor, 1908c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * invoking the given \p visitor function with the cursors of each 1909c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited child. The traversal may be recursive, if the visitor returns 1910c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if 1911c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the visitor returns \c CXChildVisit_Break. 1912c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1913c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param parent the cursor whose child may be visited. All kinds of 1914a57259e9d7b30bcce93f0a62eee0488738026172Daniel Dunbar * cursors can be visited, including invalid cursors (which, by 1915c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * definition, have no children). 1916c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1917c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param visitor the visitor function that will be invoked for each 1918c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * child of \p parent. 1919c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1920c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param client_data pointer data supplied by the client, which will 1921c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be passed to the visitor each time it is invoked. 1922c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1923c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \returns a non-zero value if the traversal was terminated 1924c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * prematurely by the visitor returning \c CXChildVisit_Break. 1925c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 19261efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent, 1927c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursorVisitor visitor, 1928c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 19293387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#ifdef __has_feature 19303387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# if __has_feature(blocks) 19313387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 19323387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * \brief Visitor invoked for each cursor found by a traversal. 19333387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 19343387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * This visitor block will be invoked for each cursor found by 19353387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * clang_visitChildrenWithBlock(). Its first argument is the cursor being 19363387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * visited, its second argument is the parent visitor for that cursor. 19373387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 19383387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * The visitor should return one of the \c CXChildVisitResult values 19393387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * to direct clang_visitChildrenWithBlock(). 19403387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 19413387c65a094a02b2a94c05111d035a97d3d5c794David Chisnalltypedef enum CXChildVisitResult 19423387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent); 19433387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall 19443387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 19453387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * Visits the children of a cursor using the specified block. Behaves 19463387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * identically to clang_visitChildren() in all other respects. 19473387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 19483387c65a094a02b2a94c05111d035a97d3d5c794David Chisnallunsigned clang_visitChildrenWithBlock(CXCursor parent, 19493387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall CXCursorVisitorBlock block); 19503387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# endif 19513387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#endif 19521efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1953c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1954c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 1955c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 19561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1957c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1958c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST 1959c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 19601efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * These routines provide the ability to determine references within and 1961c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * across translation units, by providing the names of the entities referenced 1962c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by cursors, follow reference cursors to the declarations they reference, 1963c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and associate declarations with their definitions. 1964c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1965c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 1966c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 19671efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1968c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1969c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced 1970c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by the given cursor. 1971c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1972c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A Unified Symbol Resolution (USR) is a string that identifies a particular 1973c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * entity (function, class, variable, etc.) within a program. USRs can be 1974c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * compared across translation units to determine, e.g., when references in 1975c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * one translation refer to an entity defined in another translation unit. 1976c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1977c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor); 1978c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1979c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1980896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C class. 1981896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 1982896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name); 1983896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1984896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 1985896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C category. 1986896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 1987896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 198866ccaec73706f3623d2e7d191fe2c944feedcc2bTed Kremenek clang_constructUSR_ObjCCategory(const char *class_name, 1989896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek const char *category_name); 1990896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1991896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 1992896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C protocol. 1993896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 1994896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 1995896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek clang_constructUSR_ObjCProtocol(const char *protocol_name); 1996896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1997896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1998896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 1999896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C instance variable and 2000896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 2001896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2002896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name, 2003896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2004896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2005896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2006896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C method and 2007896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 2008896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2009896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name, 2010896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek unsigned isInstanceMethod, 2011896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2012896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2013896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2014896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C property and the USR 2015896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * for its containing class. 2016896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2017896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property, 2018896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2019896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2020896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2021c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a name for the entity referenced by this cursor. 2022c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2023c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor); 2024c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2025358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor/** 2026358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * \brief Retrieve the display name for the entity referenced by this cursor. 2027358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * 2028358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * The display name contains extra information that helps identify the cursor, 2029358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * such as the parameters of a function or template or the arguments of a 2030358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * class template specialization. 2031358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor */ 2032358559d8d7b458c5f64941842383a16e61f0828dDouglas GregorCINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor); 2033358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor 2034c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor/** \brief For a cursor that is a reference, retrieve a cursor representing the 2035c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * entity that it references. 2036c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * 2037c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Reference cursors refer to other entities in the AST. For example, an 2038c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Objective-C superclass reference cursor refers to an Objective-C class. 20391efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * This function produces the cursor for the Objective-C class from the 2040c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * cursor for the superclass reference. If the input cursor is a declaration or 2041c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * definition, it returns that declaration or definition unchanged. 20421efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Otherwise, returns the NULL cursor. 2043c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor */ 2044c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor); 2045b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 20461efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 2047b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief For a cursor that is either a reference to or a declaration 2048b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * of some entity, retrieve a cursor that describes the definition of 2049b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that entity. 2050b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2051b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * Some entities can be declared multiple times within a translation 2052b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * unit, but only one of those declarations can also be a 2053b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * definition. For example, given: 2054b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2055b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \code 2056b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 2057b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int g(int x, int y) { return f(x, y); } 2058b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int a, int b) { return a + b; } 2059b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 2060b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \endcode 2061b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2062b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * there are three declarations of the function "f", but only the 2063b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * second one is a definition. The clang_getCursorDefinition() 2064b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * function will take any cursor pointing to a declaration of "f" 2065b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * (the first or fourth lines of the example) or a cursor referenced 2066b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that uses "f" (the call to "f' inside "g") and will return a 2067b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration cursor pointing to the definition (the second "f" 2068b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration). 2069b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2070b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * If given a cursor for which there is no corresponding definition, 2071b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * e.g., because there is no definition of that entity within this 2072b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * translation unit, returns a NULL cursor. 2073b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 2074b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor); 2075b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 20761efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 2077b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Determine whether the declaration pointed to by this cursor 2078b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * is also a definition of that entity. 2079b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 2080b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor); 2081b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 2082c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 20831a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \brief Retrieve the canonical cursor corresponding to the given cursor. 20841a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 20851a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * In the C family of languages, many kinds of entities can be declared several 20861a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * times within a single translation unit. For example, a structure type can 20871a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * be forward-declared (possibly multiple times) and later defined: 20881a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 20891a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \code 20901a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X; 20911a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X; 20921a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X { 20931a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * int member; 20941a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * }; 20951a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \endcode 20961a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 20971a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * The declarations and the definition of \c X are represented by three 20981a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * different cursors, all of which are declarations of the same underlying 20991a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * entity. One of these cursor is considered the "canonical" cursor, which 21001a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * is effectively the representative for the underlying entity. One can 21011a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * determine if two cursors are declarations of the same underlying entity by 21021a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * comparing their canonical cursors. 21031a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 21041a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \returns The canonical cursor for the entity referred to by the given cursor. 21051a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor */ 21061a9d0503b67a499797141af0fd6d315d5045f0eaDouglas GregorCINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor); 21071a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor 21081a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor/** 2109c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2110c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 21111efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2112c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 21139ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * \defgroup CINDEX_CPP C++ AST introspection 21149ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 21159ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * The routines in this group provide access information in the ASTs specific 21169ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * to C++ language features. 21179ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 21189ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @{ 21199ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 21209ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 21219ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 212249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Determine if a C++ member function or member function template is 212349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared 'static'. 21249ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 21259ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed KremenekCINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C); 21269ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 21279ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 212849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Given a cursor that represents a template, determine 212949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the cursor kind of the specializations would be generated by instantiating 213049f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the template. 213149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 213249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * This routine can be used to determine what flavor of function template, 213349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * class template, or class template partial specialization is stored in the 213449f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * cursor. For example, it can describe whether a class template cursor is 213549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared with "struct", "class" or "union". 213649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 213749f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \param C The cursor to query. This cursor should represent a template 213849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declaration. 213949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 214049f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \returns The cursor kind of the specializations that would be generated 214149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * by instantiating the template \p C. If \p C is not a template, returns 214249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \c CXCursor_NoDeclFound. 214349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor */ 214449f6f5489483beaffc7ce48dfc000af4e65b9216Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C); 214549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor 214649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor/** 2147e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \brief Given a cursor that may represent a specialization or instantiation 2148e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template, retrieve the cursor that represents the template that it 2149e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializes or from which it was instantiated. 2150e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2151e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * This routine determines the template involved both for explicit 2152e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializations of templates and for implicit instantiations of the template, 2153e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * both of which are referred to as "specializations". For a class template 2154e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specialization (e.g., \c std::vector<bool>), this routine will return 2155e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * either the primary template (\c std::vector) or, if the specialization was 2156e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * instantiated from a class template partial specialization, the class template 2157e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * partial specialization. For a class template partial specialization and a 2158e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * function template specialization (including instantiations), this 2159e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * this routine will return the specialized template. 2160e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2161e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * For members of a class template (e.g., member functions, member classes, or 2162e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * static data members), returns the specialized or instantiated member. 2163e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * Although not strictly "templates" in the C++ language, members of class 2164e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates have the same notions of specializations and instantiations that 2165e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates do, so this routine treats them similarly. 2166e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2167e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \param C A cursor that may be a specialization of a template or a member 2168e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template. 2169e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2170e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \returns If the given cursor is a specialization or instantiation of a 2171e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * template or a member thereof, the template or member that it specializes or 2172e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * from which it was instantiated. Otherwise, returns a NULL cursor. 2173e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor */ 2174e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas GregorCINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C); 2175e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor 2176e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor/** 21779ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @} 21789ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 21799ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 21809ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 21810045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \defgroup CINDEX_LEX Token extraction and manipulation 21820045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 21830045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * The routines in this group provide access to the tokens within a 21840045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * translation unit, along with a semantic mapping of those tokens to 21850045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * their corresponding cursors. 2186fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2187fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @{ 2188fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2189fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2190fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2191fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a kind of token. 2192fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2193fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef enum CXTokenKind { 2194fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2195fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A token that contains some kind of punctuation. 2196fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2197fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Punctuation, 2198896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2199fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 22000045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \brief A language keyword. 2201fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2202fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Keyword, 2203896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2204fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2205fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief An identifier (that is not a keyword). 2206fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2207fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Identifier, 2208896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2209fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2210fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A numeric, string, or character literal. 2211fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2212fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Literal, 2213896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2214fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2215fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A comment. 2216fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2217fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Comment 2218fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXTokenKind; 2219fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2220fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2221fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a single preprocessing token. 2222fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2223fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef struct { 2224fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor unsigned int_data[4]; 2225fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor void *ptr_data; 2226fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXToken; 2227fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2228fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2229fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the kind of the given token. 2230fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2231fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken); 2232896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2233fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2234fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the spelling of the given token. 2235fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2236fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * The spelling of a token is the textual representation of that token, e.g., 2237fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * the text of an identifier or keyword. 2238fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2239fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken); 2240896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2241fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2242fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve the source location of the given token. 2243fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2244896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit, 2245fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken); 2246896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2247fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2248fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve a source range that covers the given token. 2249fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2250fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken); 2251fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2252fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2253fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Tokenize the source code described by the given range into raw 2254fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * lexical tokens. 2255fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2256fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit whose text is being tokenized. 2257fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2258fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Range the source range in which text should be tokenized. All of the 2259fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * tokens produced by tokenization will fall within this source range, 2260fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2261fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens this pointer will be set to point to the array of tokens 2262fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that occur within the given source range. The returned pointer must be 2263fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * freed with clang_disposeTokens() before the translation unit is destroyed. 2264fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2265fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens will be set to the number of tokens in the \c *Tokens 2266fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * array. 2267fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2268fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2269fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range, 2270fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken **Tokens, unsigned *NumTokens); 2271896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2272fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2273fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Annotate the given set of tokens by providing cursors for each token 2274fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that can be mapped to a specific entity within the abstract syntax tree. 2275fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 22760045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * This token-annotation routine is equivalent to invoking 22770045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() for the source locations of each of the 22780045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * tokens. The cursors provided are filtered, so that only those 22790045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * cursors that have a direct correspondence to the token are 22800045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * accepted. For example, given a function call \c f(x), 22810045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() would provide the following cursors: 22820045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 22830045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'. 22840045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'. 22850045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'. 22860045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 22870045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * Only the first and last of these cursors will occur within the 22880045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * annotate, since the tokens "f" and "x' directly refer to a function 22890045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * and a variable, respectively, but the parentheses are just a small 22900045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * part of the full syntax of the function call expression, which is 22910045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * not provided as an annotation. 2292fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2293fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit that owns the given tokens. 2294fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2295fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens the set of tokens to annotate. 2296fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2297fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens the number of tokens in \p Tokens. 2298fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2299fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Cursors an array of \p NumTokens cursors, whose contents will be 2300fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * replaced with the cursors corresponding to each token. 2301fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2302fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU, 2303fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens, 2304fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXCursor *Cursors); 2305896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2306fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2307fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Free the given set of tokens. 2308fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2309896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU, 2310fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens); 2311896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2312fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2313fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @} 2314fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2315896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2316fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2317c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_DEBUG Debugging facilities 2318c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2319c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines are used for testing and debugging, only, and should not 2320c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be relied upon. 2321c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2322c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2323c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 23241efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 23254ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff/* for debug/testing */ 2326e68fff6fc083c6270d835216a3de0b82c6ef0310Ted KremenekCINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind); 23271efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor, 23281efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar const char **startBuf, 23294ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff const char **endBuf, 23304ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startLine, 23314ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startColumn, 23324ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endLine, 23334ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endColumn); 23340a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE void clang_enableStackTraces(void); 2335995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel DunbarCINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data, 2336995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar unsigned stack_size); 2337995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar 23380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 2339c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2340c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 23411efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2342c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2343c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CODE_COMPLET Code completion 2344c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2345c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Code completion involves taking an (incomplete) source file, along with 2346c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * knowledge of where the user is actively editing that file, and suggesting 2347c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * syntactically- and semantically-valid constructs that the user might want to 2348c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * use at that particular point in the source code. These data structures and 2349c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines provide support for code completion. 2350c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2351c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2352c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 23531efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2354c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 23550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A semantic string that describes a code-completion result. 23560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 23570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A semantic string that describes the formatting of a code-completion 23580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * result as a single "template" of text that should be inserted into the 23590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * source buffer when a particular code-completion result is selected. 23600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * Each semantic string is made up of some number of "chunks", each of which 23610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * contains some text along with a description of what that text means, e.g., 23620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the name of the entity being referenced, whether the text chunk is part of 23630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the template, or whether it is a "placeholder" that the user should replace 23640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * with actual code,of a specific kind. See \c CXCompletionChunkKind for a 23651efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * description of the different kinds of chunks. 23660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef void *CXCompletionString; 23681efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 23690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 23700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A single result of code completion. 23710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef struct { 23730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 23741efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief The kind of entity that this completion refers to. 23750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 23761efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor kind will be a macro, keyword, or a declaration (one of the 23770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * *Decl cursor kinds), describing the entity that the completion is 23780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to. 23790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 23800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \todo In the future, we would like to provide a full cursor, to allow 23810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the client to extract additional information from declaration. 23820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor enum CXCursorKind CursorKind; 23841efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 23851efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 23860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief The code-completion string that describes how to insert this 23870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion result into the editing buffer. 23880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionString CompletionString; 23900c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor} CXCompletionResult; 23910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 23920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 23930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Describes a single piece of text within a code-completion string. 23940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 23951efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Each "chunk" within a code-completion string (\c CXCompletionString) is 23961efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * either a piece of text with a specific "kind" that describes how that text 23970c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * should be interpreted by the client or is another completion string. 23980c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23990c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorenum CXCompletionChunkKind { 24000c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 24010c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A code-completion string that describes "optional" text that 24020c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * could be a part of the template (but is not required). 24030c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24040c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The Optional chunk is the only kind of chunk that has a code-completion 24051efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * string for its representation, which is accessible via 24060c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \c clang_getCompletionChunkCompletionString(). The code-completion string 24070c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * describes an additional part of the template that is completely optional. 24080c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * For example, optional chunks can be used to describe the placeholders for 24090c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * arguments that match up with defaulted function parameters, e.g. given: 24100c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24110c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 24120c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * void f(int x, float y = 3.14, double z = 2.71828); 24130c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 24140c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24150c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The code-completion string for this function would contain: 24160c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a TypedText chunk for "f". 24170c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a LeftParen chunk for "(". 24180c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "int x" 24190c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the remaining defaulted arguments, e.g., 24200c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 242171570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * - a Placeholder chunk for "float y" 24220c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the last defaulted argument: 24230c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 24240c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "double z" 24250c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a RightParen chunk for ")" 24260c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 242771570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * There are many ways to handle Optional chunks. Two simple approaches are: 24280c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Completely ignore optional chunks, in which case the template for the 24290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would only include the first parameter ("int x"). 24300c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Fully expand all optional chunks, in which case the template for the 24310c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would have all of the parameters. 24320c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 24330c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Optional, 24340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 24350c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that a user would be expected to type to get this 24361efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * code-completion result. 24370c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24381efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * There will be exactly one "typed text" chunk in a semantic string, which 24391efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * will typically provide the spelling of a keyword or the name of a 24400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * declaration that could be used at the current code point. Clients are 24410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * expected to filter the code-completion results based on the text in this 24420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * chunk. 24430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 24440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_TypedText, 24450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 24460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that should be inserted as part of a code-completion result. 24470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "text" chunk represents text that is part of the template to be 24490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * inserted into user code should this particular code-completion result 24500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * be selected. 24510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 24520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Text, 24530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 24540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Placeholder text that should be replaced by the user. 24550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "placeholder" chunk marks a place where the user should insert text 24570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * into the code-completion template. For example, placeholders might mark 24580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the function parameters for a function declaration, to indicate that the 24590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * user should provide arguments for each of those parameters. The actual 24600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * text in a placeholder is a suggestion for the text to display before 24610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the user replaces the placeholder with real code. 24620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 24630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Placeholder, 24640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 24650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Informative text that should be displayed but never inserted as 24660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * part of the template. 24671efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 24680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * An "informative" chunk contains annotations that can be displayed to 24690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * help the user decide whether a particular code-completion result is the 24700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * right option, but which is not part of the actual template to be inserted 24710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * by code completion. 24720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 24730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Informative, 24740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 24750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that describes the current parameter when code-completion is 24760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to function call, message send, or template specialization. 24770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "current parameter" chunk occurs when code-completion is providing 24790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * information about a parameter corresponding to the argument at the 24800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion point. For example, given a function 24810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 24830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * int add(int x, int y); 24840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 24850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * and the source code \c add(, where the code-completion point is after the 24870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "(", the code-completion string will contain a "current parameter" chunk 24880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * for "int x", indicating that the current argument will initialize that 24890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * parameter. After typing further, to \c add(17, (where the code-completion 24901efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * point is after the ","), the code-completion string will contain a 24910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "current paremeter" chunk to "int y". 24920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 24930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_CurrentParameter, 24940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 24950c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left parenthesis ('('), used to initiate a function call or 24960c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the beginning of a function parameter list. 24970c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 24980c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftParen, 24990c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 25000c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right parenthesis (')'), used to finish a function call or 25010c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the end of a function parameter list. 25020c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 25030c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightParen, 25040c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 25050c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left bracket ('['). 25060c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 25070c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBracket, 25080c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 25090c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right bracket (']'). 25100c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 25110c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBracket, 25120c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 25130c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left brace ('{'). 25140c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 25150c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBrace, 25160c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 25170c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right brace ('}'). 25180c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 25190c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBrace, 25200c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 25210c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left angle bracket ('<'). 25220c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 25230c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftAngle, 25240c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 25250c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right angle bracket ('>'). 25260c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 25270c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightAngle, 25280c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 25290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A comma separator (','). 25300c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 2531ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor CXCompletionChunk_Comma, 2532ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor /** 25331efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Text that specifies the result type of a given result. 2534ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * 2535ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * This special kind of informative chunk is not meant to be inserted into 25361efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * the text buffer. Rather, it is meant to illustrate the type that an 2537ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * expression using the given completion string would have. 2538ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor */ 253901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_ResultType, 254001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 254101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A colon (':'). 254201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 254301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Colon, 254401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 254501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A semicolon (';'). 254601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 254701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_SemiColon, 254801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 254901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief An '=' sign. 255001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 255101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Equal, 255201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 255301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Horizontal space (' '). 255401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 255501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_HorizontalSpace, 255601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 255701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Vertical space ('\n'), after which it is generally a good idea to 255801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * perform indentation. 255901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 256001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_VerticalSpace 25610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor}; 25621efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 25630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 25640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Determine the kind of a particular chunk within a completion string. 25650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 25660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 25670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 25680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 25690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 25700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the kind of the chunk at the index \c chunk_number. 25710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 25721efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE enum CXCompletionChunkKind 25730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkKind(CXCompletionString completion_string, 25740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 25751efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 25760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 25771efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the text associated with a particular chunk within a 25780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * completion string. 25790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 25800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 25810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 25820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 25830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 25840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the text associated with the chunk at index \c chunk_number. 25850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 25862ef6f8f5a35a60870594c5b04e0aa2bf22c6886fTed KremenekCINDEX_LINKAGE CXString 25870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkText(CXCompletionString completion_string, 25880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 25890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 25900c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 25911efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the completion string associated with a particular chunk 25920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * within a completion string. 25930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 25940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 25950c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 25960c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 25970c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 25980c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the completion string associated with the chunk at index 25990c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \c chunk_number, or NULL if that chunk is not represented by a completion 26000c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * string. 26010c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 26020c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE CXCompletionString 26030c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkCompletionString(CXCompletionString completion_string, 26040c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 26051efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 26060c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 26070c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Retrieve the number of chunks in the given code-completion string. 26080c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 26090c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE unsigned 26100c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getNumCompletionChunks(CXCompletionString completion_string); 26110c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 26120c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 261312e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \brief Determine the priority of this code completion. 261412e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 261512e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * The priority of a code completion indicates how likely it is that this 261612e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * particular completion is the completion that the user will select. The 261712e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * priority is selected by various internal heuristics. 261812e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 261912e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \param completion_string The completion string to query. 262012e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 262112e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \returns The priority of this completion string. Smaller values indicate 262212e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * higher-priority (more likely) completions. 262312e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor */ 262412e131385e892e3723483a1081a89bcad29c8a84Douglas GregorCINDEX_LINKAGE unsigned 262512e131385e892e3723483a1081a89bcad29c8a84Douglas Gregorclang_getCompletionPriority(CXCompletionString completion_string); 262612e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor 262712e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor/** 262858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \brief Determine the availability of the entity that this code-completion 262958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * string refers to. 263058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 263158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param completion_string The completion string to query. 263258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 263358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the completion string. 263458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 263558ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 263658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCompletionAvailability(CXCompletionString completion_string); 263758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 263858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 2639ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Contains the results of code-completion. 2640ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * 2641ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * This data structure contains the results of code completion, as 2642e0cc52ef8afc8d1cba9c534191b5f0ddaff1d694Douglas Gregor * produced by \c clang_codeCompleteAt(). Its contents must be freed by 2643ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c clang_disposeCodeCompleteResults. 2644ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 2645ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregortypedef struct { 2646ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 2647ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The code-completion results. 2648ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 2649ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor CXCompletionResult *Results; 2650ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 2651ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 2652ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The number of code-completion results stored in the 2653ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c Results array. 2654ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 2655ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor unsigned NumResults; 2656ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor} CXCodeCompleteResults; 2657ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 2658ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor/** 2659cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Flags that can be passed to \c clang_codeCompleteAt() to 2660cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * modify its behavior. 2661cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 2662cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * The enumerators in this enumeration can be bitwise-OR'd together to 2663cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * provide multiple options to \c clang_codeCompleteAt(). 2664cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 2665cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregorenum CXCodeComplete_Flags { 2666cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 2667cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include macros within the set of code 2668cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completions returned. 2669cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 2670cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor CXCodeComplete_IncludeMacros = 0x01, 2671cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 2672cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 2673cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include code patterns for language constructs 2674cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * within the set of code completions, e.g., for loops. 2675cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 2676cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor CXCodeComplete_IncludeCodePatterns = 0x02 2677cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor}; 2678cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 2679cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 2680cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Returns a default set of code-completion options that can be 2681cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * passed to\c clang_codeCompleteAt(). 2682cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 2683cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas GregorCINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void); 2684cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 2685cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 26861abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \brief Perform code completion at a given location in a translation unit. 26871abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 26881abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * This function performs code completion at a particular file, line, and 26891abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * column within source code, providing results that suggest potential 26901abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code snippets based on the context of the completion. The basic model 26911abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * for code completion is that Clang will parse a complete source file, 26921abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * performing syntax checking up to the location where code-completion has 26931abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * been requested. At that point, a special code-completion token is passed 26941abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * to the parser, which recognizes this token and determines, based on the 26951abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * current location in the C/Objective-C/C++ grammar and the state of 26961abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * semantic analysis, what completions to provide. These completions are 26971abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * returned via a new \c CXCodeCompleteResults structure. 26981abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 26991abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Code completion itself is meant to be triggered by the client when the 27001abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * user types punctuation characters or whitespace, at which point the 27011abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code-completion location will coincide with the cursor. For example, if \c p 27021abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is a pointer, code-completion might be triggered after the "-" and then 27031abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * after the ">" in \c p->. When the code-completion location is afer the ">", 27041abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the completion results will provide, e.g., the members of the struct that 27051abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * "p" points to. The client is responsible for placing the cursor at the 27061abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * beginning of the token currently being typed, then filtering the results 27071abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * based on the contents of the token. For example, when code-completing for 27081abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the expression \c p->get, the client should provide the location just after 27091abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the 27101abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client can filter the results based on the current token text ("get"), only 27111abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * showing those results that start with "get". The intent of this interface 27121abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is to separate the relatively high-latency acquisition of code-completion 27131abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * results from the filtering of results on a per-character basis, which must 27141abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * have a lower latency. 27151abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 27161abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param TU The translation unit in which code-completion should 27171abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * occur. The source files for this translation unit need not be 27181abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completely up-to-date (and the contents of those source files may 27191abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * be overridden via \p unsaved_files). Cursors referring into the 27201abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * translation unit may be invalidated by this invocation. 27211abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 27221abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_filename The name of the source file where code 27231abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion should be performed. This filename may be any file 27241abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * included in the translation unit. 27251abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 27261abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_line The line at which code-completion should occur. 27271abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 27281abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_column The column at which code-completion should occur. 27291abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Note that the column should point just after the syntactic construct that 27301abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * initiated code completion, and not in the middle of a lexical token. 27311abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 27321abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param unsaved_files the Tiles that have not yet been saved to disk 27331abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing or code completion, including the 27341abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * contents of those files. The contents and name of these files (as 27351abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * specified by CXUnsavedFile) are copied when necessary, so the 27361abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client only needs to guarantee their validity until the call to 27371abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * this function returns. 27381abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 27391abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 27401abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * unsaved_files. 27411abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 2742cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \param options Extra options that control the behavior of code 2743cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completion, expressed as a bitwise OR of the enumerators of the 2744cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * CXCodeComplete_Flags enumeration. The 2745cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \c clang_defaultCodeCompleteOptions() function returns a default set 2746cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * of code-completion options. 2747cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 27481abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \returns If successful, a new \c CXCodeCompleteResults structure 27491abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * containing code-completion results, which should eventually be 27501abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * freed with \c clang_disposeCodeCompleteResults(). If code 27511abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion fails, returns NULL. 27521abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor */ 27531abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCINDEX_LINKAGE 27541abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU, 27551abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor const char *complete_filename, 27561abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_line, 27571abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_column, 27581abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor struct CXUnsavedFile *unsaved_files, 2759cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned num_unsaved_files, 2760cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned options); 27611abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 27621abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor/** 27631e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \brief Sort the code-completion results in case-insensitive alphabetical 27641e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * order. 27651e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * 27661e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param Results The set of results to sort. 27671e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param NumResults The number of results in \p Results. 27681e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor */ 27691e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas GregorCINDEX_LINKAGE 27701e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregorvoid clang_sortCodeCompletionResults(CXCompletionResult *Results, 27711e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor unsigned NumResults); 27721e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor 27731e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor/** 2774ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Free the given set of code-completion results. 27750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27761efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE 2777ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregorvoid clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results); 277858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 277920d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor/** 2780a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced prior to the 2781a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * location where code completion was performed. 2782a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 2783896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 2784a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorunsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results); 2785a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 2786a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 2787a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given code completion. 2788a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 2789a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Result the code completion results to query. 2790a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 2791a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 2792a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 2793a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 2794a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 2795896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 2796a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results, 2797a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 2798a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 2799a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 280020d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * @} 280120d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor */ 28021efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 28031efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 280404bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek/** 280504bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * \defgroup CINDEX_MISC Miscellaneous utility functions 280604bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * 280704bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @{ 280804bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 280923e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek 281023e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek/** 281123e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * \brief Return a version string, suitable for showing to a user, but not 281223e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * intended to be parsed (the format is not guaranteed to be stable). 281323e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek */ 2814a2a9d6e4e5b6001b86b7dfc5db1ea296ce29a3d3Ted KremenekCINDEX_LINKAGE CXString clang_getClangVersion(); 281504bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek 281616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek /** 2817896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Visitor invoked for each file in a translation unit 281816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * (used with clang_getInclusions()). 281916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * 282016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * This visitor function will be invoked by clang_getInclusions() for each 282116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * file included (either at the top-level or by #include directives) within 282216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * a translation unit. The first argument is the file being included, and 282316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the second and third arguments provide the inclusion stack. The 282416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * array is sorted in order of immediate inclusion. For example, 282516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the first element refers to the location that included 'included_file'. 282616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 282716b55a71695a33c094383295cc7b7a2080e098daTed Kremenektypedef void (*CXInclusionVisitor)(CXFile included_file, 282816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXSourceLocation* inclusion_stack, 282916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek unsigned include_len, 283016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 283116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 283216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 283316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * \brief Visit the set of preprocessor inclusions in a translation unit. 283416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * The visitor function is called with the provided data for every included 283516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * file. This does not include headers included by the PCH file (unless one 283616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * is inspecting the inclusions in the PCH file itself). 283716b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 283816b55a71695a33c094383295cc7b7a2080e098daTed KremenekCINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu, 283916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXInclusionVisitor visitor, 284016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 284116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 284216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 284304bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @} 284404bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 28451efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2846c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2847c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2848c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 28491efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2850d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifdef __cplusplus 2851d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek} 2852d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 2853d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 2854d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 2855