Index.h revision b5af843a20e237ad1a13ad66a867e200695b8c8e
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 3887fb9404cd962b78c98947d75d68be1691c4e737Douglas Gregor/** \defgroup CINDEX libclang: 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/** 225dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor * \brief Determine whether the given header is guarded against 226dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor * multiple inclusions, either with the conventional 227dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor * #ifndef/#define/#endif macro guards or with #pragma once. 228dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor */ 229dd3e5549e3c11e217078938aacf72f042eea5343Douglas GregorCINDEX_LINKAGE unsigned 230dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregorclang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file); 231dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor 232dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor/** 233b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a file handle within the given translation unit. 234b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 235b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \param tu the translation unit 2361efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 237b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \param file_name the name of the file. 238b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 239b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns the file handle for the named file in the translation unit \p tu, 240b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * or a NULL file handle if the file was not a part of this translation unit. 241b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 2421efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu, 243b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor const char *file_name); 2441efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 245b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 246f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @} 247f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 248f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor 249f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 250f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \defgroup CINDEX_LOCATIONS Physical source locations 251f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 252f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * Clang represents physical source locations in its abstract syntax tree in 253f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * great detail, with file, line, and column information for the majority of 254f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * the tokens parsed in the source code. These data types and functions are 255f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * used to represent source location information, either for a particular 256f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * point in the program or for a range of points in the program, and extract 257f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * specific location information from those data types. 258f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 259f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @{ 260f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 2611efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 262f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 2631db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * \brief Identifies a specific source location within a translation 2641db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * unit. 2651db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 266a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * Use clang_getInstantiationLocation() or clang_getSpellingLocation() 267a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * to map a source location to a particular file, line, and column. 2683c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor */ 2693c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregortypedef struct { 2705352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor void *ptr_data[2]; 2711db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned int_data; 2723c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor} CXSourceLocation; 273fe6fd3d41a7f48317d6856c9327b6cead32c3498Ted Kremenek 2743c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor/** 275d52864bd33c66aacc84133460d8c9c0dfcdd5c18Daniel Dunbar * \brief Identifies a half-open character range in the source code. 2763c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor * 2771db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the 2781db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * starting and end locations from a source range, respectively. 2793c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor */ 2803c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregortypedef struct { 2815352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor void *ptr_data[2]; 2821db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned begin_int_data; 2831db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned end_int_data; 2843c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor} CXSourceRange; 285fe6fd3d41a7f48317d6856c9327b6cead32c3498Ted Kremenek 2861db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor/** 287b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a NULL (invalid) source location. 288b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 289b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getNullLocation(); 2901efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 291b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 292b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \determine Determine whether two source locations, which must refer into 2931efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * the same translation unit, refer to exactly the same point in the source 294b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * code. 295b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 296b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns non-zero if the source locations refer to the same location, zero 297b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * if they refer to different locations. 298b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 299b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1, 300b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXSourceLocation loc2); 3011efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 302b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 3031efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieves the source location associated with a given file/line/column 3041efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * in a particular translation unit. 305b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 306b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu, 307b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXFile file, 308b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor unsigned line, 309b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor unsigned column); 31083889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall/** 31183889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall * \brief Retrieves the source location associated with a given character offset 31283889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall * in a particular translation unit. 31383889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall */ 31483889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid ChisnallCINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu, 31583889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall CXFile file, 31683889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall unsigned offset); 3171efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 318b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 3195352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve a NULL (invalid) source range. 3205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 3215352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXSourceRange clang_getNullRange(); 322896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 324b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a source range given the beginning and ending source 325b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * locations. 326b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 327b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin, 328b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXSourceLocation end); 3291efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 330b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 331ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor * \brief Determine whether two ranges are equivalent. 332ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor * 333ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor * \returns non-zero if the ranges are the same, zero if they differ. 334ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor */ 335ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas GregorCINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1, 336ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor CXSourceRange range2); 337ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor 338ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor/** 33946766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * \brief Retrieve the file, line, column, and offset represented by 34046766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * the given source location. 3411db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 342a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * If the location refers into a macro instantiation, retrieves the 343a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * location of the macro instantiation. 344a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 3451efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param location the location within a source file that will be decomposed 3461efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * into its parts. 3471db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3481efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param file [out] if non-NULL, will be set to the file to which the given 3491db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * source location points. 3501db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3511efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param line [out] if non-NULL, will be set to the line to which the given 3521db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * source location points. 3531db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3541efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param column [out] if non-NULL, will be set to the column to which the given 3551efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source location points. 35646766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * 35746766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * \param offset [out] if non-NULL, will be set to the offset into the 35846766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * buffer to which the given source location points. 3591db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 3601db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location, 3611db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor CXFile *file, 3621db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned *line, 36346766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor unsigned *column, 36446766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor unsigned *offset); 365e69517ce61638f12c9abe4605753a45275ac4e37Douglas Gregor 366e69517ce61638f12c9abe4605753a45275ac4e37Douglas Gregor/** 367a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \brief Retrieve the file, line, column, and offset represented by 368a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * the given source location. 369a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 370a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * If the location refers into a macro instantiation, return where the 371a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * location was originally spelled in the source file. 372a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 373a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param location the location within a source file that will be decomposed 374a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * into its parts. 375a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 376a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param file [out] if non-NULL, will be set to the file to which the given 377a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 378a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 379a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param line [out] if non-NULL, will be set to the line to which the given 380a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 381a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 382a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param column [out] if non-NULL, will be set to the column to which the given 383a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 384a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 385a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param offset [out] if non-NULL, will be set to the offset into the 386a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * buffer to which the given source location points. 387a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor */ 388a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas GregorCINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location, 389a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor CXFile *file, 390a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *line, 391a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *column, 392a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *offset); 393a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor 394a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor/** 3951efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve a source location representing the first character within a 3961efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source range. 3971db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 3981db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range); 3991db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor 4001db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor/** 4011efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve a source location representing the last character within a 4021efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source range. 4031db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 4041db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range); 4051db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor 406f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 407f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @} 408f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 409c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 410c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 4115352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \defgroup CINDEX_DIAG Diagnostic reporting 4125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 4135352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @{ 4145352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4165352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 4175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Describes the severity of a particular diagnostic. 4185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4195352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorenum CXDiagnosticSeverity { 4205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 421896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief A diagnostic that has been suppressed, e.g., by a command-line 4225352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * option. 4235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Ignored = 0, 425896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 4265352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 4275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic is a note that should be attached to the 4285352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * previous (non-note) diagnostic. 4295352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4305352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Note = 1, 4315352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4325352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 4335352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates suspicious code that may not be 4345352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * wrong. 4355352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4365352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Warning = 2, 4375352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4385352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 4395352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates that the code is ill-formed. 4405352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4415352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Error = 3, 4425352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4435352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 4445352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates that the code is ill-formed such 4455352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * that future parser recovery is unlikely to produce useful 4465352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * results. 4475352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4485352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Fatal = 4 4495352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor}; 4505352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4515352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 4525352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief A single diagnostic, containing the diagnostic's severity, 4535352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * location, text, source ranges, and fix-it hints. 4545352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4555352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregortypedef void *CXDiagnostic; 4565352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4575352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 458a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced for the given 459a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * translation unit. 460a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 461a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit); 462a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 463a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 464a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given translation unit. 4655352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 466a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Unit the translation unit to query. 467a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 4685352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 469a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 470a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 4715352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 472a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit, 473a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 474a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 475a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 476a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Destroy a diagnostic. 477a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 478a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic); 4795352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4805352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 4810a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Options to control the display of diagnostics. 4820a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4830a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * The values in this enum are meant to be combined to customize the 4840a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * behavior of \c clang_displayDiagnostic(). 4850a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 4860a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregorenum CXDiagnosticDisplayOptions { 4870a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 4880a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Display the source-location information where the 4890a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic was located. 4900a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4910a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * When set, diagnostics will be prefixed by the file, line, and 4920a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * (optionally) column to which the diagnostic refers. For example, 4930a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4940a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \code 4950a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * test.c:28: warning: extra tokens at end of #endif directive 4960a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \endcode 4970a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4980a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-source-location. 4990a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 5000a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplaySourceLocation = 0x01, 5010a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 5020a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 5030a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 5040a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include the column number. 5050a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 5060a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-column. 5070a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 5080a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplayColumn = 0x02, 5090a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 5100a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 5110a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 5120a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include information about source ranges in a 5130a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * machine-parsable format. 5140a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 515896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * This option corresponds to the clang flag 5160a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \c -fdiagnostics-print-source-range-info. 5170a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 518aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplaySourceRanges = 0x04, 519aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 520aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 521aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the option name associated with this diagnostic, if any. 522aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 523aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The option name displayed (e.g., -Wconversion) will be placed in brackets 524aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * after the diagnostic text. This option corresponds to the clang flag 525aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-option. 526aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 527aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayOption = 0x08, 528aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 529aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 530aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the category number associated with this diagnostic, if any. 531aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 532aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The category number is displayed within brackets after the diagnostic text. 533aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * This option corresponds to the clang flag 534aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-category=id. 535aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 536aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayCategoryId = 0x10, 537aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 538aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 539aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the category name associated with this diagnostic, if any. 540aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 541aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The category name is displayed within brackets after the diagnostic text. 542aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * This option corresponds to the clang flag 543aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-category=name. 544aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 545aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayCategoryName = 0x20 5460a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor}; 5470a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 5480a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 549274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \brief Format the given diagnostic in a manner that is suitable for display. 5500a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 551274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * This routine will format the given diagnostic to a string, rendering 552896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the diagnostic according to the various options given. The 553896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \c clang_defaultDiagnosticDisplayOptions() function returns the set of 5540a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * options that most closely mimics the behavior of the clang compiler. 5550a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 5560a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \param Diagnostic The diagnostic to print. 5570a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 558896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Options A set of options that control the diagnostic display, 5590a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * created by combining \c CXDiagnosticDisplayOptions values. 560274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * 561274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \returns A new string containing for formatted diagnostic. 5620a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 563274f1906f12ebf8fcc179701deeda6d3271120c1Douglas GregorCINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic, 564274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor unsigned Options); 5650a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 5660a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 5670a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Retrieve the set of display options most similar to the 5680a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * default behavior of the clang compiler. 5690a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 5700a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \returns A set of display options suitable for use with \c 5710a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * clang_displayDiagnostic(). 5720a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 5730a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void); 5740a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 5750a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 5765352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the severity of the given diagnostic. 5775352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 578896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE enum CXDiagnosticSeverity 5795352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getDiagnosticSeverity(CXDiagnostic); 5805352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5815352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5825352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the source location of the given diagnostic. 5835352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 5845352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * This location is where Clang would print the caret ('^') when 5855352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * displaying the diagnostic on the command line. 5865352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5875352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic); 5885352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5895352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5905352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the text of the given diagnostic. 5915352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5925352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic); 593a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor 594a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor/** 595aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the name of the command-line option that enabled this 596aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostic. 597aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 598aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Diag The diagnostic to be queried. 599aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 600aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Disable If non-NULL, will be set to the option that disables this 601aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostic (if any). 602aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 603aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns A string that contains the command-line option used to enable this 604aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * warning, such as "-Wconversion" or "-pedantic". 605aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 606aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag, 607aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXString *Disable); 608aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 609aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 610aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the category number for this diagnostic. 611aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 612aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * Diagnostics can be categorized into groups along with other, related 613aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostics (e.g., diagnostics under the same warning flag). This routine 614aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * retrieves the category number for the given diagnostic. 615aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 616aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns The number of the category that contains this diagnostic, or zero 617aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * if this diagnostic is uncategorized. 618aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 619aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic); 620aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 621aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 622aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the name of a particular diagnostic category. 623aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 624aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Category A diagnostic category number, as returned by 625aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c clang_getDiagnosticCategory(). 626aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 627aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns The name of the given diagnostic category. 628aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 629aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticCategoryName(unsigned Category); 630aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 631aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 632a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Determine the number of source ranges associated with the given 633a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * diagnostic. 634a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor */ 635a3890baf1256ff26081306c7fef70202f8223f41Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic); 636896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 6375352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 638a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Retrieve a source range associated with the diagnostic. 6395352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 640a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * A diagnostic's source ranges highlight important elements in the source 6415352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * code. On the command line, Clang displays source ranges by 642896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * underlining them with '~' characters. 6435352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 644a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \param Diagnostic the diagnostic whose range is being extracted. 6455352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 646896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Range the zero-based index specifying which range to 6475352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 648a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \returns the requested source range. 6495352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 650896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic, 651a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor unsigned Range); 6525352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6535352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6545352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the number of fix-it hints associated with the 6555352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * given diagnostic. 6565352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 6575352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic); 6585352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6595352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 660473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \brief Retrieve the replacement information for a given fix-it. 6615352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 662473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * Fix-its are described in terms of a source range whose contents 663473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * should be replaced by a string. This approach generalizes over 664473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * three kinds of operations: removal of source code (the range covers 665473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * the code to be removed and the replacement string is empty), 666473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replacement of source code (the range covers the code to be 667473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced and the replacement string provides the new code), and 668473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion (both the start and end of the range point at the 669473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion location, and the replacement string provides the text to 670473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insert). 6715352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 672473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param Diagnostic The diagnostic whose fix-its are being queried. 6735352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 674473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param FixIt The zero-based index of the fix-it. 6755352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 676473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param ReplacementRange The source range whose contents will be 677473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced with the returned replacement string. Note that source 678473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * ranges are half-open ranges [a, b), so the source code should be 679473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced from a and up to (but not including) b. 6805352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 681473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \returns A string containing text that should be replace the source 682473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * code indicated by the \c ReplacementRange. 6835352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 684896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic, 685473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor unsigned FixIt, 686473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor CXSourceRange *ReplacementRange); 6875352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6885352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6895352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 6905352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 6915352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6925352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6935352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation 6945352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6955352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * The routines in this group provide the ability to create and destroy 6965352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * translation units from files, either by parsing the contents of the files or 6975352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * by reading in a serialized representation of a translation unit. 6985352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6995352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @{ 7005352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 701896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 7025352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7035352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Get the original translation unit source file name. 7045352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 7055352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString 7065352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getTranslationUnitSpelling(CXTranslationUnit CTUnit); 7075352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 7085352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7095352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Return the CXTranslationUnit for a given source file and the provided 7105352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * command line arguments one would pass to the compiler. 7115352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: The 'source_filename' argument is optional. If the caller provides a 7135352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * NULL pointer, the name of the source file is expected to reside in the 7145352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * specified command line arguments. 7155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7165352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: When encountered in 'clang_command_line_args', the following options 7175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * are ignored: 7185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7195352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-c' 7205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-emit-ast' 7215352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-fsyntax-only' 7225352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-o <output file>' (both '-o' and '<output file>' are ignored) 7235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7241ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param CIdx The index object with which the translation unit will be 7251ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * associated. 7265352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param source_filename - The name of the source file to load, or NULL if the 7281ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * source file is included in \p clang_command_line_args. 7291ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * 7301ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param num_clang_command_line_args The number of command-line arguments in 7311ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \p clang_command_line_args. 7321ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * 7331ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param clang_command_line_args The command-line arguments that would be 7341ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * passed to the \c clang executable if it were being invoked out-of-process. 7351ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * These command-line options will be parsed and will affect how the translation 7361ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * unit is parsed. Note that the following options are ignored: '-c', 7371ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'. 7385352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7395352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 7405352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * unsaved_files. 7415352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7425352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 7435352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * but may be required for code completion, including the contents of 744c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * those files. The contents and name of these files (as specified by 745c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * CXUnsavedFile) are copied when necessary, so the client only needs to 746c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * guarantee their validity until the call to this function returns. 7475352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 7485352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile( 7495352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXIndex CIdx, 7505352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor const char *source_filename, 7515352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor int num_clang_command_line_args, 7522ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *clang_command_line_args, 7535352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor unsigned num_unsaved_files, 754a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor struct CXUnsavedFile *unsaved_files); 755896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 7565352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7575352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Create a translation unit from an AST file (-emit-ast). 7585352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 759896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(CXIndex, 760a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const char *ast_filename); 7615352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 76244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor/** 76344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Flags that control the creation of translation units. 76444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 76544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * The enumerators in this enumeration type are meant to be bitwise 76644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * ORed together to specify which options should be used when 76744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * constructing the translation unit. 76844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 7695a43021ac491bf091494167127772a20d9a9bb48Douglas Gregorenum CXTranslationUnit_Flags { 7705a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 7715a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that no special translation-unit options are 7725a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * needed. 7735a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 7745a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor CXTranslationUnit_None = 0x0, 7755a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 7765a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 7775a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that the parser should construct a "detailed" 7785a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * preprocessing record, including all macro definitions and instantiations. 7795a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 7805a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * Constructing a detailed preprocessing record requires more memory 7815a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * and time to parse, since the information contained in the record 7825a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is usually not retained. However, it can be useful for 7835a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * applications that require more detailed information about the 7845a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * behavior of the preprocessor. 7855a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 78644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor CXTranslationUnit_DetailedPreprocessingRecord = 0x01, 78744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 78844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 789b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Used to indicate that the translation unit is incomplete. 79044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 791b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * When a translation unit is considered "incomplete", semantic 792b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * analysis that is typically performed at the end of the 793b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * translation unit will be suppressed. For example, this suppresses 794b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * the completion of tentative declarations in C and of 795b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * instantiation of implicitly-instantiation function templates in 796b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * C++. This option is typically used when parsing a header with the 797b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * intent of producing a precompiled header. 79844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 799b1c031be513705d924038f497279b9b599868ba1Douglas Gregor CXTranslationUnit_Incomplete = 0x02, 80044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 80144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 80244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Used to indicate that the translation unit should be built with an 80344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header for the preamble. 80444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 80544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * An implicit precompiled header is used as an optimization when a 80644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * particular translation unit is likely to be reparsed many times 80744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * when the sources aren't changing that often. In this case, an 80844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header will be built containing all of the 80944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * initial includes at the top of the main file (what we refer to as 81044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * the "preamble" of the file). In subsequent parses, if the 81144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * preamble or the files in it have not changed, \c 81244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * clang_reparseTranslationUnit() will re-use the implicit 81344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * precompiled header to improve parsing performance. 81444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 815e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXTranslationUnit_PrecompiledPreamble = 0x04, 816e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 817e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 818e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that the translation unit should cache some 819e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion results with each reparse of the source file. 820e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 821e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * Caching of code-completion results is a performance optimization that 822e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * introduces some overhead to reparsing but improves the performance of 823e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion operations. 824e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 82599ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CacheCompletionResults = 0x08, 82699ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 827b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * \brief DEPRECATED: Enable precompiled preambles in C++. 82899ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 82999ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 830b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * we are testing C++ precompiled preamble support. It is deprecated. 83199ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 83299ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CXXPrecompiledPreamble = 0x10, 83399ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor 83499ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 835b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * \brief DEPRECATED: Enabled chained precompiled preambles in C++. 83699ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 83799ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 838b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * we are testing C++ precompiled preamble support. It is deprecated. 83999ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 840dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor CXTranslationUnit_CXXChainedPCH = 0x20, 841dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor 842dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor /** 843dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor * \brief Used to indicate that the "detailed" preprocessing record, 844fd14e91dc0ac5db175c4b30af98e7f8adabcb508Chandler Carruth * if requested, should also contain nested macro expansions. 845dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor * 846fd14e91dc0ac5db175c4b30af98e7f8adabcb508Chandler Carruth * Nested macro expansions (i.e., macro expansions that occur 847fd14e91dc0ac5db175c4b30af98e7f8adabcb508Chandler Carruth * inside another macro expansion) can, in some code bases, require 848dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor * a large amount of storage to due preprocessor metaprogramming. Moreover, 849dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor * its fairly rare that this information is useful for libclang clients. 850dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor */ 851ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth CXTranslationUnit_NestedMacroExpansions = 0x40, 852ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth 853ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth /** 854ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth * \brief Legacy name to indicate that the "detailed" preprocessing record, 855fd14e91dc0ac5db175c4b30af98e7f8adabcb508Chandler Carruth * if requested, should contain nested macro expansions. 856ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth * 857ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth * \see CXTranslationUnit_NestedMacroExpansions for the current name for this 858ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth * value, and its semantics. This is just an alias. 859ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth */ 860ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth CXTranslationUnit_NestedMacroInstantiations = 861ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth CXTranslationUnit_NestedMacroExpansions 8625a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor}; 8635a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 8645a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor/** 865b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Returns the set of flags that is suitable for parsing a translation 866b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * unit that is being edited. 867b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * 868b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * The set of flags returned provide options for \c clang_parseTranslationUnit() 869b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * to indicate that the translation unit is likely to be reparsed many times, 870b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly 871b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag 872b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set contains an unspecified set of optimizations (e.g., the precompiled 873b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * preamble) geared toward improving the performance of these routines. The 874b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set of optimizations enabled may change from one version to the next. 875b1c031be513705d924038f497279b9b599868ba1Douglas Gregor */ 876e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void); 877b1c031be513705d924038f497279b9b599868ba1Douglas Gregor 878b1c031be513705d924038f497279b9b599868ba1Douglas Gregor/** 8795a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Parse the given source file and the translation unit corresponding 8805a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * to that file. 8815a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8825a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * This routine is the main entry point for the Clang C API, providing the 8835a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * ability to parse a source file into a translation unit that can then be 8845a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * queried by other functions in the API. This routine accepts a set of 8855a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * command-line arguments so that the compilation can be configured in the same 8865a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * way that the compiler is configured on the command line. 8875a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8885a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param CIdx The index object with which the translation unit will be 8895a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * associated. 8905a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8915a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param source_filename The name of the source file to load, or NULL if the 8921ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * source file is included in \p command_line_args. 8935a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8945a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param command_line_args The command-line arguments that would be 8955a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * passed to the \c clang executable if it were being invoked out-of-process. 8965a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * These command-line options will be parsed and will affect how the translation 8975a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unit is parsed. Note that the following options are ignored: '-c', 8985a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'. 8995a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9005a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_command_line_args The number of command-line arguments in 9015a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \p command_line_args. 9025a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9035a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 9041abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing, including the contents of 9055a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * those files. The contents and name of these files (as specified by 9065a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 9075a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * guarantee their validity until the call to this function returns. 9085a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9095a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 9105a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unsaved_files. 9115a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9125a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param options A bitmask of options that affects how the translation unit 9135a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is managed but not its compilation. This should be a bitwise OR of the 9145a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXTranslationUnit_XXX flags. 9155a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9165a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \returns A new translation unit describing the parsed code and containing 9175a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * any diagnostics produced by the compiler. If there is a failure from which 9185a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * the compiler cannot recover, returns NULL. 9195a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 9205a43021ac491bf091494167127772a20d9a9bb48Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx, 9215a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor const char *source_filename, 9222ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *command_line_args, 9235a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor int num_command_line_args, 9245a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor struct CXUnsavedFile *unsaved_files, 9255a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned num_unsaved_files, 9265a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned options); 9275a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 9285352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 9291999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Flags that control how translation units are saved. 9301999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 9311999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 9321999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * ORed together to specify which options should be used when 9331999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * saving the translation unit. 9341999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 9351999844e7a18786e61e619e1dc6c789827541863Douglas Gregorenum CXSaveTranslationUnit_Flags { 9361999844e7a18786e61e619e1dc6c789827541863Douglas Gregor /** 9371999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Used to indicate that no special saving options are needed. 9381999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 9391999844e7a18786e61e619e1dc6c789827541863Douglas Gregor CXSaveTranslationUnit_None = 0x0 9401999844e7a18786e61e619e1dc6c789827541863Douglas Gregor}; 9411999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 9421999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 9431999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Returns the set of flags that is suitable for saving a translation 9441999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * unit. 9451999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 9461999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The set of flags returned provide options for 9471999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \c clang_saveTranslationUnit() by default. The returned flag 9481999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * set contains an unspecified set of options that save translation units with 9491999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * the most commonly-requested data. 9501999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 9511999844e7a18786e61e619e1dc6c789827541863Douglas GregorCINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU); 9521999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 9531999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 95439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Describes the kind of error that occurred (if any) in a call to 95539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \c clang_saveTranslationUnit(). 95639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 95739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregorenum CXSaveError { 95839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 95939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that no error occurred while saving a translation unit. 96039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 96139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_None = 0, 96239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 96339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 96439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that an unknown error occurred while attempting to save 96539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * the file. 96639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * 96739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * This error typically indicates that file I/O failed when attempting to 96839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * write the file. 96939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 97039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_Unknown = 1, 97139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 97239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 97339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that errors during translation prevented this attempt 97439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * to save the translation unit. 97539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * 97639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * Errors that prevent the translation unit from being saved can be 97739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic(). 97839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 97939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_TranslationErrors = 2, 98039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 98139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 98239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that the translation unit to be saved was somehow 98339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * invalid (e.g., NULL). 98439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 98539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_InvalidTU = 3 98639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor}; 98739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 98839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor/** 9897ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \brief Saves a translation unit into a serialized representation of 9907ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * that translation unit on disk. 9917ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 9927ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * Any translation unit that was parsed without error can be saved 9937ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * into a file. The translation unit can then be deserialized into a 9947ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * new \c CXTranslationUnit with \c clang_createTranslationUnit() or, 9957ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * if it is an incomplete translation unit that corresponds to a 9967ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * header, used as a precompiled header when parsing other translation 9977ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * units. 9987ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 9997ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param TU The translation unit to save. 10001999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 10017ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param FileName The file to which the translation unit will be saved. 10027ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 10031999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \param options A bitmask of options that affects how the translation unit 10041999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * is saved. This should be a bitwise OR of the 10051999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * CXSaveTranslationUnit_XXX flags. 10061999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 100739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \returns A value that will match one of the enumerators of the CXSaveError 100839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * enumeration. Zero (CXSaveError_None) indicates that the translation unit was 100939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * saved successfully, while a non-zero value indicates that a problem occurred. 10107ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor */ 10117ae2faafd30524ef5f863bb3b8701977888839bbDouglas GregorCINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU, 10121999844e7a18786e61e619e1dc6c789827541863Douglas Gregor const char *FileName, 10131999844e7a18786e61e619e1dc6c789827541863Douglas Gregor unsigned options); 10147ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 10157ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor/** 10165352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Destroy the specified CXTranslationUnit object. 10175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 10185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit); 1019896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 10205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 1021e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Flags that control the reparsing of translation units. 1022e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1023e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 1024e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * ORed together to specify which options should be used when 1025e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * reparsing the translation unit. 1026e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1027e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregorenum CXReparse_Flags { 1028e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 1029e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that no special reparsing options are needed. 1030e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1031e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXReparse_None = 0x0 1032e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor}; 1033e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 1034e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 1035e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Returns the set of flags that is suitable for reparsing a translation 1036e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * unit. 1037e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1038e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The set of flags returned provide options for 1039e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \c clang_reparseTranslationUnit() by default. The returned flag 1040e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * set contains an unspecified set of optimizations geared toward common uses 1041e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * of reparsing. The set of optimizations enabled may change from one version 1042e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * to the next. 1043e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1044e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU); 1045e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 1046e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 1047abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \brief Reparse the source files that produced this translation unit. 1048abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1049abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * This routine can be used to re-parse the source files that originally 1050abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * created the given translation unit, for example because those source files 1051abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * have changed (either on disk or as passed via \p unsaved_files). The 1052abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * source code will be reparsed with the same command-line options as it 1053abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * was originally parsed. 1054abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1055abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * Reparsing a translation unit invalidates all cursors and source locations 1056abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * that refer into that translation unit. This makes reparsing a translation 1057abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit semantically equivalent to destroying the translation unit and then 1058abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * creating a new translation unit with the same command-line arguments. 1059abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * However, it may be more efficient to reparse a translation 1060abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit using this routine. 1061abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1062abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param TU The translation unit whose contents will be re-parsed. The 1063abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * translation unit must originally have been built with 1064abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_createTranslationUnitFromSourceFile(). 1065abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1066abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 1067abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unsaved_files. 1068abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1069abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param unsaved_files The files that have not yet been saved to disk 1070abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * but may be required for parsing, including the contents of 1071abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * those files. The contents and name of these files (as specified by 1072abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 1073abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * guarantee their validity until the call to this function returns. 1074abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1075e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \param options A bitset of options composed of the flags in CXReparse_Flags. 1076e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The function \c clang_defaultReparseOptions() produces a default set of 1077e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * options recommended for most uses, based on the translation unit. 1078e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1079abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \returns 0 if the sources could be reparsed. A non-zero value will be 1080abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * returned if reparsing was impossible, such that the translation unit is 1081abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * invalid. In such cases, the only valid call for \p TU is 1082abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_disposeTranslationUnit(TU). 1083abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor */ 1084abc563f554951259bbe0315055cad92ee14d87e4Douglas GregorCINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU, 1085abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned num_unsaved_files, 1086e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor struct CXUnsavedFile *unsaved_files, 1087e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor unsigned options); 108859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 108959fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 109059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Categorizes how memory is being used by a translation unit. 109159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1092f787002478f09af1741fb0f82a562002e6799c49Ted Kremenekenum CXTUResourceUsageKind { 1093f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_AST = 1, 1094f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_Identifiers = 2, 1095f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_Selectors = 3, 1096f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_GlobalCompletionResults = 4, 1097457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek CXTUResourceUsage_SourceManagerContentCache = 5, 1098ba29bd25515fbd99e98ba0fedb9d93617b27609eTed Kremenek CXTUResourceUsage_AST_SideTables = 6, 1099f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7, 1100e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_SourceManager_Membuffer_MMap = 8, 1101e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9, 1102e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10, 11035e1db6a434d0e3fe0fbde0bca2ec44552818fb22Ted Kremenek CXTUResourceUsage_Preprocessor = 11, 11045e1db6a434d0e3fe0fbde0bca2ec44552818fb22Ted Kremenek CXTUResourceUsage_PreprocessingRecord = 12, 1105ca7dc2b755eb81ac95121ce1a1f1aa44a4a0fe12Ted Kremenek CXTUResourceUsage_SourceManager_DataStructures = 13, 1106d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Preprocessor_HeaderSearch = 14, 1107f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST, 1108f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_MEMORY_IN_BYTES_END = 1109d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Preprocessor_HeaderSearch, 1110f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek 1111f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_First = CXTUResourceUsage_AST, 1112d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch 111359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek}; 111459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 111559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 111659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Returns the human-readable null-terminated C string that represents 1117f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek * the name of the memory category. This string should never be freed. 111859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 111959fc1e55da9c856d1703d3d3ac14a36320d26b30Ted KremenekCINDEX_LINKAGE 1120f787002478f09af1741fb0f82a562002e6799c49Ted Kremenekconst char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind); 112159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1122f787002478f09af1741fb0f82a562002e6799c49Ted Kremenektypedef struct CXTUResourceUsageEntry { 112359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief The memory usage category. */ 1124f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek enum CXTUResourceUsageKind kind; 1125f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek /* \brief Amount of resources used. 1126f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek The units will depend on the resource kind. */ 112759fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek unsigned long amount; 1128f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek} CXTUResourceUsageEntry; 112959fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 113059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 113159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief The memory usage of a CXTranslationUnit, broken into categories. 113259fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1133f787002478f09af1741fb0f82a562002e6799c49Ted Kremenektypedef struct CXTUResourceUsage { 113459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief Private data member, used for queries. */ 113559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek void *data; 113659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 113759fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief The number of entries in the 'entries' array. */ 113859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek unsigned numEntries; 113959fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 114059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief An array of key-value pairs, representing the breakdown of memory 114159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek usage. */ 1142f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsageEntry *entries; 114359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1144f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek} CXTUResourceUsage; 114559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 114659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 114759fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Return the memory usage of a translation unit. This object 1148f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek * should be released with clang_disposeCXTUResourceUsage(). 114959fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1150f787002478f09af1741fb0f82a562002e6799c49Ted KremenekCINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU); 115159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1152f787002478f09af1741fb0f82a562002e6799c49Ted KremenekCINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage); 115359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1154abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor/** 11555352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 11565352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 1157896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 11585352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 1159c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes the kind of entity that a cursor refers to. 1160c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1161c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXCursorKind { 1162c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Declarations */ 11631efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1164c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A declaration whose specific kind is not exposed via this 11651efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 1166c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1167c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed declarations have the same operations as any other kind 1168c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of declaration; one can extract their location information, 1169c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, find their definitions, etc. However, the specific kind 1170c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of the declaration is not reported. 1171c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1172c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedDecl = 1, 1173c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ struct. */ 11741efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_StructDecl = 2, 1175c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ union. */ 1176c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnionDecl = 3, 1177c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C++ class. */ 1178c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ClassDecl = 4, 1179c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumeration. */ 1180c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumDecl = 5, 11811efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1182c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A field (in C) or non-static data member (in C++) in a 1183c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * struct, union, or C++ class. 1184c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1185c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FieldDecl = 6, 1186c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumerator constant. */ 1187c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumConstantDecl = 7, 1188c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function. */ 1189c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FunctionDecl = 8, 1190c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A variable. */ 1191c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_VarDecl = 9, 1192c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function or method parameter. */ 1193c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ParmDecl = 10, 1194c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @interface. */ 1195c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInterfaceDecl = 11, 1196c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @interface for a category. */ 1197c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryDecl = 12, 1198c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @protocol declaration. */ 1199c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolDecl = 13, 1200c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @property declaration. */ 1201c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCPropertyDecl = 14, 1202c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance variable. */ 1203c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCIvarDecl = 15, 1204c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance method. */ 1205c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInstanceMethodDecl = 16, 1206c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C class method. */ 1207c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassMethodDecl = 17, 1208c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @implementation. */ 1209c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCImplementationDecl = 18, 1210c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @implementation for a category. */ 1211c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryImplDecl = 19, 1212c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A typedef */ 1213c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypedefDecl = 20, 12148bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek /** \brief A C++ class method. */ 12158bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek CXCursor_CXXMethod = 21, 12168f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek /** \brief A C++ namespace. */ 12178f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek CXCursor_Namespace = 22, 1218a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek /** \brief A linkage specification, e.g. 'extern "C"'. */ 1219a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek CXCursor_LinkageSpec = 23, 122001829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ constructor. */ 122101829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Constructor = 24, 122201829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ destructor. */ 122301829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Destructor = 25, 122401829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ conversion function. */ 122501829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_ConversionFunction = 26, 1226fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template type parameter. */ 1227fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTypeParameter = 27, 1228fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ non-type template parameter. */ 1229fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_NonTypeTemplateParameter = 28, 1230fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template template parameter. */ 1231fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTemplateParameter = 29, 1232fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ function template. */ 1233fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_FunctionTemplate = 30, 123439d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor /** \brief A C++ class template. */ 123539d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor CXCursor_ClassTemplate = 31, 123674dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor /** \brief A C++ class template partial specialization. */ 123774dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor CXCursor_ClassTemplatePartialSpecialization = 32, 12386931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** \brief A C++ namespace alias declaration. */ 12396931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceAlias = 33, 12400a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor /** \brief A C++ using directive. */ 12410a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor CXCursor_UsingDirective = 34, 1242162e1c1b487352434552147967c3dd296ebee2f7Richard Smith /** \brief A C++ using declaration. */ 12437e24256c95afb64b4d5abf201a0f9f0527cb4cf3Douglas Gregor CXCursor_UsingDeclaration = 35, 1244162e1c1b487352434552147967c3dd296ebee2f7Richard Smith /** \brief A C++ alias declaration */ 1245162e1c1b487352434552147967c3dd296ebee2f7Richard Smith CXCursor_TypeAliasDecl = 36, 1246352697a87bca664356f21a838b162084013625eaDouglas Gregor /** \brief An Objective-C @synthesize definition. */ 1247352697a87bca664356f21a838b162084013625eaDouglas Gregor CXCursor_ObjCSynthesizeDecl = 37, 1248352697a87bca664356f21a838b162084013625eaDouglas Gregor /** \brief An Objective-C @dynamic definition. */ 1249352697a87bca664356f21a838b162084013625eaDouglas Gregor CXCursor_ObjCDynamicDecl = 38, 125050aa6acd0b8d40c8956372a69e0a73f0802a5494Ted Kremenek CXCursor_FirstDecl = CXCursor_UnexposedDecl, 1251352697a87bca664356f21a838b162084013625eaDouglas Gregor CXCursor_LastDecl = CXCursor_ObjCDynamicDecl, 12521efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1253c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* References */ 1254c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstRef = 40, /* Decl references */ 12551efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_ObjCSuperClassRef = 40, 1256c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolRef = 41, 1257c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassRef = 42, 1258c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1259c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A reference to a type declaration. 1260c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1261c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A type reference occurs anywhere where a type is named but not 1262c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * declared. For example, given: 1263c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1264c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \code 1265c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * typedef unsigned size_type; 1266c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * size_type size; 1267c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \endcode 1268c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1269c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The typedef is a declaration of size_type (CXCursor_TypedefDecl), 1270c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * while the type of the variable "size" is referenced. The cursor 1271c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * referenced by the type of size is the typedef for size_type. 1272c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1273c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypeRef = 43, 12743064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CXCursor_CXXBaseSpecifier = 44, 12750b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor /** 1276a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * \brief A reference to a class template, function template, template 1277a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * template parameter, or class template partial specialization. 12780b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor */ 12790b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor CXCursor_TemplateRef = 45, 12806931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** 12816931900f43cea558c6974075256c07728dbfecc6Douglas Gregor * \brief A reference to a namespace or namespace alias. 12826931900f43cea558c6974075256c07728dbfecc6Douglas Gregor */ 12836931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceRef = 46, 1284a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor /** 128536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a member of a struct, union, or class that occurs in 128636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * some non-expression context, e.g., a designated initializer. 1287a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor */ 1288a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor CXCursor_MemberRef = 47, 128936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** 129036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a labeled statement. 129136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 129236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the jump to "start_over" in the 129336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto statement in the following example: 129436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 129536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 129636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 129736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 129836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 129936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto start_over; 130036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 130136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 130236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * A label reference cursor refers to a label statement. 130336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 130436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelRef = 48, 130536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 13061f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor /** 13071f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief A reference to a set of overloaded functions or function templates 13081f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * that has not yet been resolved to a specific function or function template. 13091f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 13101f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * An overloaded declaration reference cursor occurs in C++ templates where 13111f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * a dependent name refers to a function. For example: 13121f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 13131f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \code 13141f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> void swap(T&, T&); 13151f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 13161f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct X { ... }; 13171f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(X&, X&); 13181f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 13191f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> 13201f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void reverse(T* first, T* last) { 13211f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * while (first < last - 1) { 13221f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * swap(*first, *--last); 13231f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * ++first; 13241f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 13251f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 13261f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 13271f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct Y { }; 13281f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(Y&, Y&); 13291f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \endcode 13301f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 13311f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * Here, the identifier "swap" is associated with an overloaded declaration 13321f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * reference. In the template definition, "swap" refers to either of the two 13331f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * "swap" functions declared above, so both results will be available. At 13341f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * instantiation time, "swap" may also refer to other functions found via 13351f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * argument-dependent lookup (e.g., the "swap" function at the end of the 13361f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * example). 13371f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 13381f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * The functions \c clang_getNumOverloadedDecls() and 13391f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c clang_getOverloadedDecl() can be used to retrieve the definitions 13401f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * referenced by this cursor. 13411f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 13421f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor CXCursor_OverloadedDeclRef = 49, 13431f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 13441f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor CXCursor_LastRef = CXCursor_OverloadedDeclRef, 13451efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1346c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Error conditions */ 1347c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstInvalid = 70, 1348c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_InvalidFile = 70, 1349c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NoDeclFound = 71, 1350c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NotImplemented = 72, 1351ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_InvalidCode = 73, 1352ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_LastInvalid = CXCursor_InvalidCode, 13531efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1354c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Expressions */ 1355c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstExpr = 100, 13561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1357c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1358c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression whose specific kind is not exposed via this 13591efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 1360c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1361c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed expressions have the same operations as any other kind 1362c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of expression; one can extract their location information, 1363c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, children, etc. However, the specific kind of the 1364c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * expression is not reported. 1365c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1366c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedExpr = 100, 13671efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1368c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1369c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to some value declaration, such 1370c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * as a function, varible, or enumerator. 1371c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1372c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_DeclRefExpr = 101, 13731efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1374c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1375c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to a member of a struct, union, 1376c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * class, Objective-C class, etc. 1377c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1378c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_MemberRefExpr = 102, 13791efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1380c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that calls a function. */ 1381c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_CallExpr = 103, 13821efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1383c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that sends a message to an Objective-C 1384c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor object or class. */ 1385c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCMessageExpr = 104, 13861ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 13871ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek /** \brief An expression that represents a block literal. */ 13881ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek CXCursor_BlockExpr = 105, 13891ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 13901ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek CXCursor_LastExpr = 105, 13911efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1392c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Statements */ 1393c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstStmt = 200, 1394c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1395c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A statement whose specific kind is not exposed via this 1396c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * interface. 1397c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1398c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed statements have the same operations as any other kind of 1399c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * statement; one can extract their location information, spelling, 1400c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * children, etc. However, the specific kind of the statement is not 1401c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reported. 1402c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1403c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedStmt = 200, 140436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 140536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** \brief A labelled statement in a function. 140636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 140736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the "start_over:" label statement in 140836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * the following example: 140936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 141036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 141136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 141236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 141336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 141436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 141536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 141636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelStmt = 201, 141736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 141836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LastStmt = CXCursor_LabelStmt, 14191efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1420c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1421c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Cursor that represents the translation unit itself. 1422c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1423c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor exists primarily to act as the root 1424c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor for traversing the contents of a translation unit. 1425c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1426e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_TranslationUnit = 300, 1427e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1428e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /* Attributes */ 1429e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_FirstAttr = 400, 1430e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /** 1431e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * \brief An attribute whose specific kind is not exposed via this 1432e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * interface. 1433e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek */ 1434e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_UnexposedAttr = 400, 1435e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1436e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBActionAttr = 401, 1437e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBOutletAttr = 402, 1438857e918a8a40deb128840308a318bf623d68295fTed Kremenek CXCursor_IBOutletCollectionAttr = 403, 1439857e918a8a40deb128840308a318bf623d68295fTed Kremenek CXCursor_LastAttr = CXCursor_IBOutletCollectionAttr, 14409f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 14419f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor /* Preprocessing */ 14429f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_PreprocessingDirective = 500, 1443572feb2a190b5e8b04fb06c4ac50ee0f61e93ff0Douglas Gregor CXCursor_MacroDefinition = 501, 14449b2a0ac970a077bdc0bf08c6c682f80ad733c892Chandler Carruth CXCursor_MacroExpansion = 502, 14459b2a0ac970a077bdc0bf08c6c682f80ad733c892Chandler Carruth CXCursor_MacroInstantiation = CXCursor_MacroExpansion, 1446ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_InclusionDirective = 503, 14479f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective, 1448ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_LastPreprocessing = CXCursor_InclusionDirective 1449c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 1450c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1451c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1452c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A cursor representing some element in the abstract syntax tree for 1453c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a translation unit. 1454c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 14551efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor abstraction unifies the different kinds of entities in a 1456c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * program--declaration, statements, expressions, references to declarations, 1457c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * etc.--under a single "cursor" abstraction with a common set of operations. 1458c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Common operation for a cursor include: getting the physical location in 1459c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a source file where the cursor points, getting the name associated with a 1460c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor, and retrieving cursors for any child nodes of a particular cursor. 1461c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1462c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors can be produced in two specific ways. 1463c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_getTranslationUnitCursor() produces a cursor for a translation unit, 1464c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * from which one can use clang_visitChildren() to explore the rest of the 1465c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * translation unit. clang_getCursor() maps from a physical source location 1466c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to the entity that resides at that location, allowing one to map from the 1467c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * source code into the AST. 1468c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1469c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregortypedef struct { 1470c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor enum CXCursorKind kind; 1471c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor void *data[3]; 14721efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar} CXCursor; 1473c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1474c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1475c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations 1476c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1477c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 1478c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 14791efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1480c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1481c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the NULL cursor, which represents no entity. 1482c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1483c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getNullCursor(void); 14841efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1485c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1486c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the cursor that represents the given translation unit. 1487c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1488c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor can be used to start traversing the 1489c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * various declarations within the given translation unit. 1490c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1491c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit); 1492c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1493c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1494c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether two cursors are equivalent. 1495c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1496c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor); 14971efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1498c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 14999ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor * \brief Compute a hash value for the given cursor. 15009ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor */ 15019ce5584553054d0cb934940586aca0186e87fa57Douglas GregorCINDEX_LINKAGE unsigned clang_hashCursor(CXCursor); 15029ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor 15039ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor/** 1504c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the kind of the given cursor. 1505c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1506c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor); 1507c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1508c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1509c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a declaration. 1510c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1511c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind); 1512c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1513c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1514c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a simple 1515c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reference. 1516c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1517c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Note that other kinds of cursors (such as expressions) can also refer to 1518c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * other cursors. Use clang_getCursorReferenced() to determine whether a 1519c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * particular cursor refers to another entity. 1520c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1521c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind); 1522c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1523c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1524c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents an expression. 1525c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1526c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind); 1527c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1528c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1529c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a statement. 1530c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1531c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind); 1532c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1533c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 15348be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor * \brief Determine whether the given cursor kind represents an attribute. 15358be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor */ 15368be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas GregorCINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind); 15378be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor 15388be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor/** 15391efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents an invalid 1540c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor. 15411efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar */ 1542c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind); 1543c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1544c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 15451efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents a translation 15461efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unit. 1547c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1548c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind); 15491efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1550ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek/*** 15519f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * \brief Determine whether the given cursor represents a preprocessing 15529f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * element, such as a preprocessor directive or macro instantiation. 15539f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor */ 15549f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas GregorCINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind); 15559f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 15569f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor/*** 1557ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * \brief Determine whether the given cursor represents a currently 1558ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt). 1559ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek */ 1560ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted KremenekCINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind); 1561ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek 1562c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 156316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief Describe the linkage of the entity referred to by a cursor. 156416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 156516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenekenum CXLinkageKind { 156616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This value indicates that no linkage information is available 156716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * for a provided CXCursor. */ 156816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Invalid, 156916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** 157016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief This is the linkage for variables, parameters, and so on that 157116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * have automatic storage. This covers normal (non-extern) local variables. 157216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 157316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_NoLinkage, 157416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for static variables and static functions. */ 157516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Internal, 157616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with external linkage that live 157716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * in C++ anonymous namespaces.*/ 157816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_UniqueExternal, 157916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with true, external linkage. */ 158016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_External 158116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek}; 158216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 158316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 158445e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the linkage of the entity referred to by a given cursor. 158516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 158616b4259aecaa22b642d35d36fd89965ed700c1e0Ted KremenekCINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor); 158716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 158816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 158958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \brief Determine the availability of the entity that this cursor refers to. 159058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 159158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param cursor The cursor to query. 159258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 159358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the cursor. 159458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 159558ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 159658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCursorAvailability(CXCursor cursor); 159758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 159858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 159945e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Describe the "language" of the entity referred to by a cursor. 160045e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 160145e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind { 16026cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_Invalid = 0, 160345e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_C, 160445e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_ObjC, 16056cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_CPlusPlus 160645e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek}; 160745e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 160845e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 160945e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the "language" of the entity referred to by a given cursor. 161045e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 161145e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor); 161245e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 1613eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 1614eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 1615eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief A fast container representing a set of CXCursors. 1616eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 1617eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenektypedef struct CXCursorSetImpl *CXCursorSet; 1618eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 1619eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 1620eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Creates an empty CXCursorSet. 1621eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 1622eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(); 1623eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 1624eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 1625eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Disposes a CXCursorSet and releases its associated memory. 1626eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 1627eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset); 1628eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 1629eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 1630eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Queries a CXCursorSet to see if it contains a specific CXCursor. 1631eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * 1632eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \returns non-zero if the set contains the specified cursor. 1633eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek*/ 1634eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset, 1635eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek CXCursor cursor); 1636eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 1637eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 1638eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Inserts a CXCursor into a CXCursorSet. 1639eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * 1640eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \returns zero if the CXCursor was already in the set, and non-zero otherwise. 1641eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek*/ 1642eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset, 1643eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek CXCursor cursor); 1644eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 16452be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 16462be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the semantic parent of the given cursor. 16472be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 16482be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The semantic parent of a cursor is the cursor that semantically contains 16492be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the given \p cursor. For many declarations, the lexical and semantic parents 16502be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the lexical parent is returned by 16512be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorLexicalParent()). They diverge when declarations or 16522be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 16532be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 16542be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 16552be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 16562be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 16572be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 16582be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 16592be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 16602be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 16612be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 16622be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 16632be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 16642be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 16652be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 16662be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 16672be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 16682be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 16692be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 16702be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 16712be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 16722be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 16732be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 16742be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 16753910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * 16763910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * For global declarations, the semantic parent is the translation unit. 16772be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 16782be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor); 16792be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor 16802be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 16812be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the lexical parent of the given cursor. 16822be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 16832be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The lexical parent of a cursor is the cursor in which the given \p cursor 16842be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * was actually written. For many declarations, the lexical and semantic parents 16852be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the semantic parent is returned by 16862be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorSemanticParent()). They diverge when declarations or 16872be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 16882be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 16892be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 16902be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 16912be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 16922be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 16932be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 16942be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 16952be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 16962be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 16972be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 16982be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 16992be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 17002be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 17012be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 17022be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 17032be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 17042be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 17052be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 17062be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 17072be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 17082be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 17092be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 17103910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * 17113910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * For declarations written in the global scope, the lexical parent is 17123910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * the translation unit. 17132be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 17142be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor); 17159f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 17169f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 17179f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Determine the set of methods that are overridden by the given 17189f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. 17199f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 17209f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In both Objective-C and C++, a method (aka virtual member function, 17219f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * in C++) can override a virtual method in a base class. For 17229f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * Objective-C, a method is said to override any method in the class's 17239f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * interface (if we're coming from an implementation), its protocols, 17249f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * or its categories, that has the same selector and is of the same 17259f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * kind (class or instance). If no such method exists, the search 17269f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * continues to the class's superclass, its protocols, and its 17279f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * categories, and so on. 17289f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 17299f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * For C++, a virtual member function overrides any virtual member 17309f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * function with the same signature that occurs in its base 17319f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * classes. With multiple inheritance, a virtual member function can 17329f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * override several virtual member functions coming from different 17339f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * base classes. 17349f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 17359f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In all cases, this function determines the immediate overridden 17369f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method, rather than all of the overridden methods. For example, if 17379f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * a method is originally declared in a class A, then overridden in B 17389f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * (which in inherits from A) and also in C (which inherited from B), 17399f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * then the only overridden method returned from this function when 17409f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoked on C's method will be B's method. The client may then 17419f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoke this function again, given the previously-found overridden 17429f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods, to map out the complete method-override set. 17439f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 17449f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param cursor A cursor representing an Objective-C or C++ 17459f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. This routine will compute the set of methods that this 17469f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method overrides. 17479f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 17489f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param overridden A pointer whose pointee will be replaced with a 17499f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * pointer to an array of cursors, representing the set of overridden 17509f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods. If there are no overridden methods, the pointee will be 17519f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * set to NULL. The pointee must be freed via a call to 17529f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \c clang_disposeOverriddenCursors(). 17539f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 17549f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param num_overridden A pointer to the number of overridden 17559f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * functions, will be set to the number of overridden functions in the 17569f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * array pointed to by \p overridden. 17579f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 17589f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor, 17599f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor CXCursor **overridden, 17609f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor unsigned *num_overridden); 17619f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 17629f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 17639f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Free the set of overridden cursors returned by \c 17649f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * clang_getOverriddenCursors(). 17659f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 17669f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden); 17679f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 176845e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 1769ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * \brief Retrieve the file that is included by the given inclusion directive 1770ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * cursor. 1771ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor */ 1772ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas GregorCINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor); 1773ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor 1774ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor/** 1775c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 1776c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 17771efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1778c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1779c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code 1780c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1781c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors represent a location within the Abstract Syntax Tree (AST). These 1782c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines help map between cursors and the physical locations where the 1783c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * described entities occur in the source code. The mapping is provided in 1784c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * both directions, so one can map from source code to the AST and back. 1785c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1786c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 178750398199fb10e196a8d92fbf7a062dbe42ed88fdSteve Naroff */ 17881efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 17896a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff/** 1790b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Map a source location to the cursor that describes the entity at that 1791b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * location in the source code. 1792b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 1793b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() maps an arbitrary source location within a translation 1794b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * unit down to the most specific cursor that describes the entity at that 17951efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * location. For example, given an expression \c x + y, invoking 1796b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() with a source location pointing to "x" will return the 17971efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * cursor for "x"; similarly for "y". If the cursor points anywhere between 1798b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor() 1799b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * will return a cursor referring to the "+" expression. 1800b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 1801b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns a cursor representing the entity at the given source location, or 1802b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * a NULL cursor if no such entity can be found. 18036a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff */ 1804b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation); 18051efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 180698258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor/** 180798258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * \brief Retrieve the physical location of the source constructor referenced 180898258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * by the given cursor. 180998258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * 181098258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * The location of a declaration is typically the location of the name of that 18111efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * declaration, where the name of that declaration would occur if it is 18121efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unnamed, or some keyword that introduces that particular declaration. 18131efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The location of a reference is where that reference occurs within the 181498258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * source code. 181598258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor */ 181698258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor); 1817c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1818b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor/** 1819b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Retrieve the physical extent of the source construct referenced by 1820a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the given cursor. 1821a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * 1822a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * The extent of a cursor starts with the file/line/column pointing at the 1823a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * first character within the source construct that the cursor refers to and 18241efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * ends with the last character withinin that source construct. For a 1825a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * declaration, the extent covers the declaration itself. For a reference, 1826a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the extent covers the location of the reference (e.g., where the referenced 1827a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * entity was actually used). 1828a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor */ 1829a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas GregorCINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor); 1830c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor 1831c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1832c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 1833c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 183495f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 1835c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 18368e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \defgroup CINDEX_TYPES Type information for CXCursors 18378e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 18388e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @{ 18398e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 18408e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 18418e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 18428e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Describes the kind of type 18438e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 18448e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenekenum CXTypeKind { 18458e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 18468e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Reprents an invalid type (e.g., where no type is available). 18478e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 18488e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Invalid = 0, 18498e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 18508e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 18518e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief A type whose specific kind is not exposed via this 18528e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * interface. 18538e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 18548e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Unexposed = 1, 18558e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 18568e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /* Builtin types */ 18578e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Void = 2, 18588e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Bool = 3, 18598e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_U = 4, 18608e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UChar = 5, 18618e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char16 = 6, 18628e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char32 = 7, 18638e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UShort = 8, 18648e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt = 9, 18658e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULong = 10, 18668e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULongLong = 11, 18678e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt128 = 12, 18688e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_S = 13, 18698e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_SChar = 14, 18708e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_WChar = 15, 18718e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Short = 16, 18728e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int = 17, 18738e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Long = 18, 18748e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongLong = 19, 18758e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int128 = 20, 18768e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Float = 21, 18778e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Double = 22, 18788e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongDouble = 23, 18798e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_NullPtr = 24, 18808e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Overload = 25, 18818e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Dependent = 26, 18828e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCId = 27, 18838e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCClass = 28, 18848e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCSel = 29, 18858e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_FirstBuiltin = CXType_Void, 18868e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LastBuiltin = CXType_ObjCSel, 18878e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 18888e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Complex = 100, 18898e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Pointer = 101, 18908e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_BlockPointer = 102, 18918e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LValueReference = 103, 18928e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_RValueReference = 104, 18938e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Record = 105, 18948e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Enum = 106, 18958e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Typedef = 107, 18968e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCInterface = 108, 189704c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_ObjCObjectPointer = 109, 189804c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_FunctionNoProto = 110, 189904c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_FunctionProto = 111 19008e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek}; 19018e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 19028e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 19038e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief The type of an element in the abstract syntax tree. 19048e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 19058e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 19068e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenektypedef struct { 19078e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek enum CXTypeKind kind; 19088e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek void *data[2]; 19098e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek} CXType; 19108e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 19118e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 19128e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the type of a CXCursor (if any). 19138e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 19148e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCursorType(CXCursor C); 19158e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 19168e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 19178e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \determine Determine whether two CXTypes represent the same type. 19188e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 19198e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \returns non-zero if the CXTypes represent the same type and 19208e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek zero otherwise. 19218e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 19228e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B); 19238e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 19248e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 19258e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the canonical type for a CXType. 19268e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 19278e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * Clang's type system explicitly models typedefs and all the ways 19288e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * a specific type can be represented. The canonical type is the underlying 19298e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * type with all the "sugar" removed. For example, if 'T' is a typedef 19308e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * for 'int', the canonical type for 'T' would be 'int'. 19318e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 19328e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCanonicalType(CXType T); 19338e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 19348e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 1935e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * \determine Determine whether a CXType has the "const" qualifier set, 1936e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * without looking through typedefs that may have added "const" at a different level. 1937e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 1938e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T); 1939e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 1940e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 1941e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * \determine Determine whether a CXType has the "volatile" qualifier set, 1942e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * without looking through typedefs that may have added "volatile" at a different level. 1943e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 1944e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T); 1945e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 1946e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 1947e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * \determine Determine whether a CXType has the "restrict" qualifier set, 1948e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * without looking through typedefs that may have added "restrict" at a different level. 1949e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 1950e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T); 1951e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 1952e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 19538e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief For pointer types, returns the type of the pointee. 19548e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 19558e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 19568e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getPointeeType(CXType T); 19578e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 19588e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 19598e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the cursor for the declaration of the given type. 19608e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 19618e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T); 19628e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 19635389f48b24937ad7b4093307128b3cbf25235654David Chisnall/** 19645389f48b24937ad7b4093307128b3cbf25235654David Chisnall * Returns the Objective-C type encoding for the specified declaration. 19655389f48b24937ad7b4093307128b3cbf25235654David Chisnall */ 19665389f48b24937ad7b4093307128b3cbf25235654David ChisnallCINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C); 19678e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 19688e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 19698e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the spelling of a given CXTypeKind. 19708e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 19718e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K); 19728e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 19738e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 19749a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * \brief Retrieve the result type associated with a function type. 197504c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek */ 197604c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted KremenekCINDEX_LINKAGE CXType clang_getResultType(CXType T); 197704c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek 197804c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek/** 19799a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * \brief Retrieve the result type associated with a given cursor. This only 19809a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * returns a valid type of the cursor refers to a function or method. 19819a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek */ 19829a140845438c2fc31e7d48a6dedbc695f4c83c68Ted KremenekCINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C); 19839a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek 19849a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek/** 19853ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * \brief Return 1 if the CXType is a POD (plain old data) type, and 0 19863ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * otherwise. 19873ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek */ 19883ce9e7d270e7df86c09c8126b4412d55be7c123bTed KremenekCINDEX_LINKAGE unsigned clang_isPODType(CXType T); 19893ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek 19903ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek/** 19913064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns 1 if the base class specified by the cursor with kind 19923064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * CX_CXXBaseSpecifier is virtual. 19933064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 19943064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor); 19953064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 19963064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 19973064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Represents the C++ access control level to a base class for a 19983064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * cursor with kind CX_CXXBaseSpecifier. 19993064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 20003064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenekenum CX_CXXAccessSpecifier { 20013064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXInvalidAccessSpecifier, 20023064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPublic, 20033064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXProtected, 20043064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPrivate 20053064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek}; 20063064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 20073064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 20083064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns the access control level for the C++ base specifier 20093064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * represented by a cursor with kind CX_CXXBaseSpecifier. 20103064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 20113064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor); 20123064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 20133064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 20141f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Determine the number of overloaded declarations referenced by a 20151f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c CXCursor_OverloadedDeclRef cursor. 20161f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 20171f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 20181f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 20191f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns The number of overloaded declarations referenced by \c cursor. If it 20201f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0. 20211f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 20221f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor); 20231f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 20241f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 20251f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Retrieve a cursor for one of the overloaded declarations referenced 20261f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * by a \c CXCursor_OverloadedDeclRef cursor. 20271f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 20281f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 20291f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 20301f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param index The zero-based index into the set of overloaded declarations in 20311f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * the cursor. 20321f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 20331f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns A cursor representing the declaration referenced by the given 20341f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c cursor at the specified \c index. If the cursor does not have an 20351f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * associated set of overloaded declarations, or if the index is out of bounds, 20361f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * returns \c clang_getNullCursor(); 20371f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 20381f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor, 20391f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor unsigned index); 20401f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 20411f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 20428e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @} 20438e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 204495f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 204595f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 2046ad72f4dad4cf0fd2b71eb8f4704d2fe7ac58fb44Ted Kremenek * \defgroup CINDEX_ATTRIBUTES Information for attributes 204795f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 204895f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @{ 204995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 205095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 205195f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 205295f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 205395f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * \brief For cursors representing an iboutletcollection attribute, 205495f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * this function returns the collection element type. 205595f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 205695f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 205795f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted KremenekCINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor); 205895f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 205995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 206095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @} 206195f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 20628e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 20638e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 2064c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors 2065c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2066c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines provide the ability to traverse the abstract syntax tree 2067c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * using cursors. 2068c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2069c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2070c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 20711efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2072c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2073c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes how the traversal of the children of a particular 2074c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor should proceed after visiting a particular child cursor. 2075c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2076c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A value of this enumeration type should be returned by each 2077c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXCursorVisitor to indicate how clang_visitChildren() proceed. 2078c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2079c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXChildVisitResult { 2080c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 20811efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Terminates the cursor traversal. 2082c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2083c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Break, 20841efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 2085c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Continues the cursor traversal with the next sibling of 2086c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the cursor just visited, without visiting its children. 2087c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2088c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Continue, 2089c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 2090c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Recursively traverse the children of this cursor, using 2091c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the same visitor and client data. 2092c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2093c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Recurse 2094c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 2095c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2096c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2097c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visitor invoked for each cursor found by a traversal. 2098c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2099c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This visitor function will be invoked for each cursor found by 2100c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). Its first argument is the cursor being 2101c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited, its second argument is the parent visitor for that cursor, 2102c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and its third argument is the client data provided to 2103c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). 2104c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2105c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The visitor should return one of the \c CXChildVisitResult values 2106c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to direct clang_visitCursorChildren(). 2107c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 21081efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbartypedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor, 21091efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor parent, 2110c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 2111c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2112c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2113c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visit the children of a particular cursor. 2114c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2115c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This function visits all the direct children of the given cursor, 2116c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * invoking the given \p visitor function with the cursors of each 2117c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited child. The traversal may be recursive, if the visitor returns 2118c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if 2119c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the visitor returns \c CXChildVisit_Break. 2120c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2121c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param parent the cursor whose child may be visited. All kinds of 2122a57259e9d7b30bcce93f0a62eee0488738026172Daniel Dunbar * cursors can be visited, including invalid cursors (which, by 2123c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * definition, have no children). 2124c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2125c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param visitor the visitor function that will be invoked for each 2126c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * child of \p parent. 2127c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2128c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param client_data pointer data supplied by the client, which will 2129c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be passed to the visitor each time it is invoked. 2130c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2131c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \returns a non-zero value if the traversal was terminated 2132c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * prematurely by the visitor returning \c CXChildVisit_Break. 2133c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 21341efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent, 2135c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursorVisitor visitor, 2136c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 21373387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#ifdef __has_feature 21383387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# if __has_feature(blocks) 21393387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 21403387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * \brief Visitor invoked for each cursor found by a traversal. 21413387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 21423387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * This visitor block will be invoked for each cursor found by 21433387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * clang_visitChildrenWithBlock(). Its first argument is the cursor being 21443387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * visited, its second argument is the parent visitor for that cursor. 21453387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 21463387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * The visitor should return one of the \c CXChildVisitResult values 21473387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * to direct clang_visitChildrenWithBlock(). 21483387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 21493387c65a094a02b2a94c05111d035a97d3d5c794David Chisnalltypedef enum CXChildVisitResult 21503387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent); 21513387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall 21523387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 21533387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * Visits the children of a cursor using the specified block. Behaves 21543387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * identically to clang_visitChildren() in all other respects. 21553387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 21563387c65a094a02b2a94c05111d035a97d3d5c794David Chisnallunsigned clang_visitChildrenWithBlock(CXCursor parent, 21573387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall CXCursorVisitorBlock block); 21583387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# endif 21593387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#endif 21601efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2161c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2162c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2163c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 21641efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2165c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2166c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST 2167c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 21681efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * These routines provide the ability to determine references within and 2169c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * across translation units, by providing the names of the entities referenced 2170c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by cursors, follow reference cursors to the declarations they reference, 2171c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and associate declarations with their definitions. 2172c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2173c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2174c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 21751efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2176c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2177c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced 2178c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by the given cursor. 2179c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2180c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A Unified Symbol Resolution (USR) is a string that identifies a particular 2181c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * entity (function, class, variable, etc.) within a program. USRs can be 2182c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * compared across translation units to determine, e.g., when references in 2183c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * one translation refer to an entity defined in another translation unit. 2184c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2185c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor); 2186c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2187c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2188896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C class. 2189896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2190896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name); 2191896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2192896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2193896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C category. 2194896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2195896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 219666ccaec73706f3623d2e7d191fe2c944feedcc2bTed Kremenek clang_constructUSR_ObjCCategory(const char *class_name, 2197896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek const char *category_name); 2198896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2199896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2200896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C protocol. 2201896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2202896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 2203896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek clang_constructUSR_ObjCProtocol(const char *protocol_name); 2204896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2205896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2206896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2207896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C instance variable and 2208896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 2209896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2210896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name, 2211896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2212896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2213896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2214896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C method and 2215896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 2216896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2217896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name, 2218896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek unsigned isInstanceMethod, 2219896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2220896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2221896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2222896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C property and the USR 2223896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * for its containing class. 2224896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2225896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property, 2226896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2227896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2228896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2229c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a name for the entity referenced by this cursor. 2230c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2231c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor); 2232c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2233358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor/** 2234358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * \brief Retrieve the display name for the entity referenced by this cursor. 2235358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * 2236358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * The display name contains extra information that helps identify the cursor, 2237358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * such as the parameters of a function or template or the arguments of a 2238358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * class template specialization. 2239358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor */ 2240358559d8d7b458c5f64941842383a16e61f0828dDouglas GregorCINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor); 2241358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor 2242c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor/** \brief For a cursor that is a reference, retrieve a cursor representing the 2243c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * entity that it references. 2244c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * 2245c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Reference cursors refer to other entities in the AST. For example, an 2246c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Objective-C superclass reference cursor refers to an Objective-C class. 22471efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * This function produces the cursor for the Objective-C class from the 2248c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * cursor for the superclass reference. If the input cursor is a declaration or 2249c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * definition, it returns that declaration or definition unchanged. 22501efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Otherwise, returns the NULL cursor. 2251c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor */ 2252c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor); 2253b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 22541efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 2255b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief For a cursor that is either a reference to or a declaration 2256b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * of some entity, retrieve a cursor that describes the definition of 2257b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that entity. 2258b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2259b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * Some entities can be declared multiple times within a translation 2260b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * unit, but only one of those declarations can also be a 2261b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * definition. For example, given: 2262b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2263b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \code 2264b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 2265b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int g(int x, int y) { return f(x, y); } 2266b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int a, int b) { return a + b; } 2267b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 2268b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \endcode 2269b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2270b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * there are three declarations of the function "f", but only the 2271b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * second one is a definition. The clang_getCursorDefinition() 2272b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * function will take any cursor pointing to a declaration of "f" 2273b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * (the first or fourth lines of the example) or a cursor referenced 2274b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that uses "f" (the call to "f' inside "g") and will return a 2275b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration cursor pointing to the definition (the second "f" 2276b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration). 2277b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2278b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * If given a cursor for which there is no corresponding definition, 2279b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * e.g., because there is no definition of that entity within this 2280b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * translation unit, returns a NULL cursor. 2281b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 2282b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor); 2283b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 22841efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 2285b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Determine whether the declaration pointed to by this cursor 2286b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * is also a definition of that entity. 2287b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 2288b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor); 2289b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 2290c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 22911a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \brief Retrieve the canonical cursor corresponding to the given cursor. 22921a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 22931a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * In the C family of languages, many kinds of entities can be declared several 22941a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * times within a single translation unit. For example, a structure type can 22951a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * be forward-declared (possibly multiple times) and later defined: 22961a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 22971a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \code 22981a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X; 22991a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X; 23001a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X { 23011a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * int member; 23021a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * }; 23031a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \endcode 23041a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 23051a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * The declarations and the definition of \c X are represented by three 23061a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * different cursors, all of which are declarations of the same underlying 23071a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * entity. One of these cursor is considered the "canonical" cursor, which 23081a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * is effectively the representative for the underlying entity. One can 23091a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * determine if two cursors are declarations of the same underlying entity by 23101a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * comparing their canonical cursors. 23111a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 23121a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \returns The canonical cursor for the entity referred to by the given cursor. 23131a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor */ 23141a9d0503b67a499797141af0fd6d315d5045f0eaDouglas GregorCINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor); 23151a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor 23161a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor/** 2317c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2318c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 23191efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2320c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 23219ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * \defgroup CINDEX_CPP C++ AST introspection 23229ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 23239ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * The routines in this group provide access information in the ASTs specific 23249ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * to C++ language features. 23259ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 23269ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @{ 23279ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 23289ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 23299ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 233049f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Determine if a C++ member function or member function template is 233149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared 'static'. 23329ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 23339ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed KremenekCINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C); 23349ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 23359ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 2336211924b563aa31421836cee7655be729ad02733fDouglas Gregor * \brief Determine if a C++ member function or member function template is 2337211924b563aa31421836cee7655be729ad02733fDouglas Gregor * explicitly declared 'virtual' or if it overrides a virtual method from 2338211924b563aa31421836cee7655be729ad02733fDouglas Gregor * one of the base classes. 2339211924b563aa31421836cee7655be729ad02733fDouglas Gregor */ 2340211924b563aa31421836cee7655be729ad02733fDouglas GregorCINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C); 2341211924b563aa31421836cee7655be729ad02733fDouglas Gregor 2342211924b563aa31421836cee7655be729ad02733fDouglas Gregor/** 234349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Given a cursor that represents a template, determine 234449f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the cursor kind of the specializations would be generated by instantiating 234549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the template. 234649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 234749f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * This routine can be used to determine what flavor of function template, 234849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * class template, or class template partial specialization is stored in the 234949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * cursor. For example, it can describe whether a class template cursor is 235049f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared with "struct", "class" or "union". 235149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 235249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \param C The cursor to query. This cursor should represent a template 235349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declaration. 235449f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 235549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \returns The cursor kind of the specializations that would be generated 235649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * by instantiating the template \p C. If \p C is not a template, returns 235749f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \c CXCursor_NoDeclFound. 235849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor */ 235949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C); 236049f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor 236149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor/** 2362e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \brief Given a cursor that may represent a specialization or instantiation 2363e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template, retrieve the cursor that represents the template that it 2364e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializes or from which it was instantiated. 2365e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2366e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * This routine determines the template involved both for explicit 2367e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializations of templates and for implicit instantiations of the template, 2368e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * both of which are referred to as "specializations". For a class template 2369e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specialization (e.g., \c std::vector<bool>), this routine will return 2370e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * either the primary template (\c std::vector) or, if the specialization was 2371e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * instantiated from a class template partial specialization, the class template 2372e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * partial specialization. For a class template partial specialization and a 2373e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * function template specialization (including instantiations), this 2374e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * this routine will return the specialized template. 2375e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2376e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * For members of a class template (e.g., member functions, member classes, or 2377e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * static data members), returns the specialized or instantiated member. 2378e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * Although not strictly "templates" in the C++ language, members of class 2379e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates have the same notions of specializations and instantiations that 2380e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates do, so this routine treats them similarly. 2381e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2382e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \param C A cursor that may be a specialization of a template or a member 2383e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template. 2384e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2385e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \returns If the given cursor is a specialization or instantiation of a 2386e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * template or a member thereof, the template or member that it specializes or 2387e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * from which it was instantiated. Otherwise, returns a NULL cursor. 2388e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor */ 2389e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas GregorCINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C); 2390430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 2391430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor/** 2392430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Given a cursor that references something else, return the source range 2393430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * covering that reference. 2394430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 2395430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param C A cursor pointing to a member reference, a declaration reference, or 2396430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * an operator call. 2397430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param NameFlags A bitset with three independent flags: 2398430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and 2399430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantSinglePiece. 2400430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param PieceIndex For contiguous names or when passing the flag 2401430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantSinglePiece, only one piece with index 0 is 2402430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * available. When the CXNameRange_WantSinglePiece flag is not passed for a 2403430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * non-contiguous names, this index can be used to retreive the individual 2404430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * pieces of the name. See also CXNameRange_WantSinglePiece. 2405430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 2406430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \returns The piece of the name pointed to by the given cursor. If there is no 2407430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * name, or if the PieceIndex is out-of-range, a null-cursor will be returned. 2408430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 240948a8d14fc6f064a5297024c2b34733a4080b2efeFrancois PichetCINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, 241048a8d14fc6f064a5297024c2b34733a4080b2efeFrancois Pichet unsigned NameFlags, 2411430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor unsigned PieceIndex); 2412430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 2413430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregorenum CXNameRefFlags { 2414430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 2415430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the 2416430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * range. 2417430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 2418430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantQualifier = 0x1, 2419430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 2420430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 2421430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Include the explicit template arguments, e.g. <int> in x.f<int>, in 2422430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * the range. 2423430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 2424430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantTemplateArgs = 0x2, 2425430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 2426430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 2427430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief If the name is non-contiguous, return the full spanning range. 2428430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 2429430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * Non-contiguous names occur in Objective-C when a selector with two or more 2430430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * parameters is used, or in C++ when using an operator: 2431430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \code 2432430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * [object doSomething:here withValue:there]; // ObjC 2433430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * return some_vector[1]; // C++ 2434430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \endcode 2435430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 2436430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantSinglePiece = 0x4 2437430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor}; 2438e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor 2439e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor/** 24409ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @} 24419ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 24429ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 24439ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 24440045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \defgroup CINDEX_LEX Token extraction and manipulation 24450045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 24460045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * The routines in this group provide access to the tokens within a 24470045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * translation unit, along with a semantic mapping of those tokens to 24480045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * their corresponding cursors. 2449fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2450fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @{ 2451fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2452fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2453fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2454fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a kind of token. 2455fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2456fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef enum CXTokenKind { 2457fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2458fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A token that contains some kind of punctuation. 2459fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2460fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Punctuation, 2461896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2462fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 24630045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \brief A language keyword. 2464fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2465fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Keyword, 2466896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2467fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2468fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief An identifier (that is not a keyword). 2469fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2470fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Identifier, 2471896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2472fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2473fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A numeric, string, or character literal. 2474fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2475fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Literal, 2476896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2477fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2478fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A comment. 2479fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2480fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Comment 2481fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXTokenKind; 2482fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2483fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2484fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a single preprocessing token. 2485fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2486fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef struct { 2487fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor unsigned int_data[4]; 2488fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor void *ptr_data; 2489fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXToken; 2490fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2491fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2492fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the kind of the given token. 2493fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2494fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken); 2495896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2496fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2497fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the spelling of the given token. 2498fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2499fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * The spelling of a token is the textual representation of that token, e.g., 2500fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * the text of an identifier or keyword. 2501fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2502fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken); 2503896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2504fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2505fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve the source location of the given token. 2506fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2507896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit, 2508fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken); 2509896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2510fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2511fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve a source range that covers the given token. 2512fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2513fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken); 2514fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2515fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2516fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Tokenize the source code described by the given range into raw 2517fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * lexical tokens. 2518fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2519fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit whose text is being tokenized. 2520fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2521fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Range the source range in which text should be tokenized. All of the 2522fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * tokens produced by tokenization will fall within this source range, 2523fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2524fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens this pointer will be set to point to the array of tokens 2525fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that occur within the given source range. The returned pointer must be 2526fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * freed with clang_disposeTokens() before the translation unit is destroyed. 2527fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2528fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens will be set to the number of tokens in the \c *Tokens 2529fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * array. 2530fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2531fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2532fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range, 2533fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken **Tokens, unsigned *NumTokens); 2534896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2535fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2536fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Annotate the given set of tokens by providing cursors for each token 2537fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that can be mapped to a specific entity within the abstract syntax tree. 2538fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 25390045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * This token-annotation routine is equivalent to invoking 25400045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() for the source locations of each of the 25410045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * tokens. The cursors provided are filtered, so that only those 25420045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * cursors that have a direct correspondence to the token are 25430045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * accepted. For example, given a function call \c f(x), 25440045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() would provide the following cursors: 25450045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 25460045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'. 25470045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'. 25480045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'. 25490045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 25500045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * Only the first and last of these cursors will occur within the 25510045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * annotate, since the tokens "f" and "x' directly refer to a function 25520045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * and a variable, respectively, but the parentheses are just a small 25530045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * part of the full syntax of the function call expression, which is 25540045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * not provided as an annotation. 2555fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2556fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit that owns the given tokens. 2557fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2558fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens the set of tokens to annotate. 2559fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2560fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens the number of tokens in \p Tokens. 2561fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2562fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Cursors an array of \p NumTokens cursors, whose contents will be 2563fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * replaced with the cursors corresponding to each token. 2564fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2565fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU, 2566fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens, 2567fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXCursor *Cursors); 2568896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2569fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2570fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Free the given set of tokens. 2571fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2572896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU, 2573fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens); 2574896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2575fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2576fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @} 2577fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2578896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2579fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2580c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_DEBUG Debugging facilities 2581c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2582c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines are used for testing and debugging, only, and should not 2583c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be relied upon. 2584c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2585c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2586c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 25871efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 25884ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff/* for debug/testing */ 2589e68fff6fc083c6270d835216a3de0b82c6ef0310Ted KremenekCINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind); 25901efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor, 25911efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar const char **startBuf, 25924ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff const char **endBuf, 25934ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startLine, 25944ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startColumn, 25954ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endLine, 25964ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endColumn); 25970a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE void clang_enableStackTraces(void); 2598995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel DunbarCINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data, 2599995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar unsigned stack_size); 2600995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar 26010c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 2602c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2603c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 26041efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2605c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2606c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CODE_COMPLET Code completion 2607c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2608c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Code completion involves taking an (incomplete) source file, along with 2609c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * knowledge of where the user is actively editing that file, and suggesting 2610c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * syntactically- and semantically-valid constructs that the user might want to 2611c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * use at that particular point in the source code. These data structures and 2612c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines provide support for code completion. 2613c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2614c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2615c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 26161efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2617c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 26180c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A semantic string that describes a code-completion result. 26190c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 26200c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A semantic string that describes the formatting of a code-completion 26210c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * result as a single "template" of text that should be inserted into the 26220c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * source buffer when a particular code-completion result is selected. 26230c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * Each semantic string is made up of some number of "chunks", each of which 26240c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * contains some text along with a description of what that text means, e.g., 26250c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the name of the entity being referenced, whether the text chunk is part of 26260c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the template, or whether it is a "placeholder" that the user should replace 26270c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * with actual code,of a specific kind. See \c CXCompletionChunkKind for a 26281efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * description of the different kinds of chunks. 26290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 26300c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef void *CXCompletionString; 26311efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 26320c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 26330c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A single result of code completion. 26340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 26350c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef struct { 26360c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 26371efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief The kind of entity that this completion refers to. 26380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 26391efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor kind will be a macro, keyword, or a declaration (one of the 26400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * *Decl cursor kinds), describing the entity that the completion is 26410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to. 26420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 26430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \todo In the future, we would like to provide a full cursor, to allow 26440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the client to extract additional information from declaration. 26450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 26460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor enum CXCursorKind CursorKind; 26471efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 26481efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 26490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief The code-completion string that describes how to insert this 26500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion result into the editing buffer. 26510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 26520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionString CompletionString; 26530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor} CXCompletionResult; 26540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 26550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 26560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Describes a single piece of text within a code-completion string. 26570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 26581efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Each "chunk" within a code-completion string (\c CXCompletionString) is 26591efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * either a piece of text with a specific "kind" that describes how that text 26600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * should be interpreted by the client or is another completion string. 26610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 26620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorenum CXCompletionChunkKind { 26630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 26640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A code-completion string that describes "optional" text that 26650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * could be a part of the template (but is not required). 26660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 26670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The Optional chunk is the only kind of chunk that has a code-completion 26681efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * string for its representation, which is accessible via 26690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \c clang_getCompletionChunkCompletionString(). The code-completion string 26700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * describes an additional part of the template that is completely optional. 26710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * For example, optional chunks can be used to describe the placeholders for 26720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * arguments that match up with defaulted function parameters, e.g. given: 26730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 26740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 26750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * void f(int x, float y = 3.14, double z = 2.71828); 26760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 26770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 26780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The code-completion string for this function would contain: 26790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a TypedText chunk for "f". 26800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a LeftParen chunk for "(". 26810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "int x" 26820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the remaining defaulted arguments, e.g., 26830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 268471570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * - a Placeholder chunk for "float y" 26850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the last defaulted argument: 26860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 26870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "double z" 26880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a RightParen chunk for ")" 26890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 269071570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * There are many ways to handle Optional chunks. Two simple approaches are: 26910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Completely ignore optional chunks, in which case the template for the 26920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would only include the first parameter ("int x"). 26930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Fully expand all optional chunks, in which case the template for the 26940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would have all of the parameters. 26950c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 26960c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Optional, 26970c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 26980c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that a user would be expected to type to get this 26991efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * code-completion result. 27000c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 27011efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * There will be exactly one "typed text" chunk in a semantic string, which 27021efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * will typically provide the spelling of a keyword or the name of a 27030c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * declaration that could be used at the current code point. Clients are 27040c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * expected to filter the code-completion results based on the text in this 27050c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * chunk. 27060c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27070c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_TypedText, 27080c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 27090c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that should be inserted as part of a code-completion result. 27100c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 27110c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "text" chunk represents text that is part of the template to be 27120c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * inserted into user code should this particular code-completion result 27130c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * be selected. 27140c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27150c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Text, 27160c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 27170c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Placeholder text that should be replaced by the user. 27180c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 27190c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "placeholder" chunk marks a place where the user should insert text 27200c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * into the code-completion template. For example, placeholders might mark 27210c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the function parameters for a function declaration, to indicate that the 27220c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * user should provide arguments for each of those parameters. The actual 27230c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * text in a placeholder is a suggestion for the text to display before 27240c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the user replaces the placeholder with real code. 27250c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27260c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Placeholder, 27270c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 27280c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Informative text that should be displayed but never inserted as 27290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * part of the template. 27301efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 27310c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * An "informative" chunk contains annotations that can be displayed to 27320c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * help the user decide whether a particular code-completion result is the 27330c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * right option, but which is not part of the actual template to be inserted 27340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * by code completion. 27350c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27360c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Informative, 27370c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 27380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that describes the current parameter when code-completion is 27390c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to function call, message send, or template specialization. 27400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 27410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "current parameter" chunk occurs when code-completion is providing 27420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * information about a parameter corresponding to the argument at the 27430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion point. For example, given a function 27440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 27450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 27460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * int add(int x, int y); 27470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 27480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 27490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * and the source code \c add(, where the code-completion point is after the 27500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "(", the code-completion string will contain a "current parameter" chunk 27510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * for "int x", indicating that the current argument will initialize that 27520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * parameter. After typing further, to \c add(17, (where the code-completion 27531efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * point is after the ","), the code-completion string will contain a 27540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "current paremeter" chunk to "int y". 27550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_CurrentParameter, 27570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 27580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left parenthesis ('('), used to initiate a function call or 27590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the beginning of a function parameter list. 27600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftParen, 27620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 27630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right parenthesis (')'), used to finish a function call or 27640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the end of a function parameter list. 27650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightParen, 27670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 27680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left bracket ('['). 27690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBracket, 27710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 27720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right bracket (']'). 27730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBracket, 27750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 27760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left brace ('{'). 27770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBrace, 27790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 27800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right brace ('}'). 27810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBrace, 27830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 27840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left angle bracket ('<'). 27850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftAngle, 27870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 27880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right angle bracket ('>'). 27890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 27900c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightAngle, 27910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 27920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A comma separator (','). 27930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 2794ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor CXCompletionChunk_Comma, 2795ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor /** 27961efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Text that specifies the result type of a given result. 2797ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * 2798ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * This special kind of informative chunk is not meant to be inserted into 27991efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * the text buffer. Rather, it is meant to illustrate the type that an 2800ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * expression using the given completion string would have. 2801ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor */ 280201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_ResultType, 280301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 280401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A colon (':'). 280501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 280601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Colon, 280701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 280801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A semicolon (';'). 280901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 281001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_SemiColon, 281101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 281201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief An '=' sign. 281301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 281401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Equal, 281501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 281601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Horizontal space (' '). 281701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 281801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_HorizontalSpace, 281901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 282001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Vertical space ('\n'), after which it is generally a good idea to 282101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * perform indentation. 282201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 282301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_VerticalSpace 28240c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor}; 28251efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 28260c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 28270c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Determine the kind of a particular chunk within a completion string. 28280c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 28290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 28300c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 28310c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 28320c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 28330c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the kind of the chunk at the index \c chunk_number. 28340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 28351efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE enum CXCompletionChunkKind 28360c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkKind(CXCompletionString completion_string, 28370c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 28381efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 28390c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 28401efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the text associated with a particular chunk within a 28410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * completion string. 28420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 28430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 28440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 28450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 28460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 28470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the text associated with the chunk at index \c chunk_number. 28480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 28492ef6f8f5a35a60870594c5b04e0aa2bf22c6886fTed KremenekCINDEX_LINKAGE CXString 28500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkText(CXCompletionString completion_string, 28510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 28520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 28530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 28541efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the completion string associated with a particular chunk 28550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * within a completion string. 28560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 28570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 28580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 28590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 28600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 28610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the completion string associated with the chunk at index 28620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \c chunk_number, or NULL if that chunk is not represented by a completion 28630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * string. 28640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 28650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE CXCompletionString 28660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkCompletionString(CXCompletionString completion_string, 28670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 28681efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 28690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 28700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Retrieve the number of chunks in the given code-completion string. 28710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 28720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE unsigned 28730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getNumCompletionChunks(CXCompletionString completion_string); 28740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 28750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 287612e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \brief Determine the priority of this code completion. 287712e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 287812e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * The priority of a code completion indicates how likely it is that this 287912e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * particular completion is the completion that the user will select. The 288012e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * priority is selected by various internal heuristics. 288112e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 288212e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \param completion_string The completion string to query. 288312e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 288412e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \returns The priority of this completion string. Smaller values indicate 288512e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * higher-priority (more likely) completions. 288612e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor */ 288712e131385e892e3723483a1081a89bcad29c8a84Douglas GregorCINDEX_LINKAGE unsigned 288812e131385e892e3723483a1081a89bcad29c8a84Douglas Gregorclang_getCompletionPriority(CXCompletionString completion_string); 288912e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor 289012e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor/** 289158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \brief Determine the availability of the entity that this code-completion 289258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * string refers to. 289358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 289458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param completion_string The completion string to query. 289558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 289658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the completion string. 289758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 289858ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 289958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCompletionAvailability(CXCompletionString completion_string); 290058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 290158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 29028fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \brief Retrieve a completion string for an arbitrary declaration or macro 29038fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * definition cursor. 29048fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * 29058fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \param cursor The cursor to query. 29068fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * 29078fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \returns A non-context-sensitive completion string for declaration and macro 29088fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * definition cursors, or NULL for other kinds of cursors. 29098fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor */ 29108fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas GregorCINDEX_LINKAGE CXCompletionString 29118fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregorclang_getCursorCompletionString(CXCursor cursor); 29128fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 29138fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor/** 2914ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Contains the results of code-completion. 2915ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * 2916ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * This data structure contains the results of code completion, as 2917e0cc52ef8afc8d1cba9c534191b5f0ddaff1d694Douglas Gregor * produced by \c clang_codeCompleteAt(). Its contents must be freed by 2918ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c clang_disposeCodeCompleteResults. 2919ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 2920ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregortypedef struct { 2921ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 2922ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The code-completion results. 2923ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 2924ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor CXCompletionResult *Results; 2925ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 2926ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 2927ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The number of code-completion results stored in the 2928ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c Results array. 2929ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 2930ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor unsigned NumResults; 2931ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor} CXCodeCompleteResults; 2932ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 2933ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor/** 2934cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Flags that can be passed to \c clang_codeCompleteAt() to 2935cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * modify its behavior. 2936cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 2937cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * The enumerators in this enumeration can be bitwise-OR'd together to 2938cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * provide multiple options to \c clang_codeCompleteAt(). 2939cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 2940cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregorenum CXCodeComplete_Flags { 2941cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 2942cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include macros within the set of code 2943cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completions returned. 2944cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 2945cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor CXCodeComplete_IncludeMacros = 0x01, 2946cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 2947cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 2948cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include code patterns for language constructs 2949cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * within the set of code completions, e.g., for loops. 2950cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 2951cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor CXCodeComplete_IncludeCodePatterns = 0x02 2952cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor}; 2953cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 2954cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 29553da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Bits that represent the context under which completion is occurring. 29563da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 29573da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * The enumerators in this enumeration may be bitwise-OR'd together if multiple 29583da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * contexts are occurring simultaneously. 29593da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 29603da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregorenum CXCompletionContext { 29613da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 29623da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief The context for completions is unexposed, as only Clang results 29633da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included. (This is equivalent to having no context bits set.) 29643da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 29653da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Unexposed = 0, 29663da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 29673da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 29683da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for any possible type should be included in the results. 29693da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 29703da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_AnyType = 1 << 0, 29713da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 29723da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 29733da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for any possible value (variables, function calls, etc.) 29743da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included in the results. 29753da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 29763da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_AnyValue = 1 << 1, 29773da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 29783da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to an Objective-C object should 29793da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * be included in the results. 29803da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 29813da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCObjectValue = 1 << 2, 29823da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 29833da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to an Objective-C selector 29843da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included in the results. 29853da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 29863da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCSelectorValue = 1 << 3, 29873da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 29883da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to a C++ class type should be 29893da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * included in the results. 29903da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 29913da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_CXXClassTypeValue = 1 << 4, 29923da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 29933da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 29943da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for fields of the member being accessed using the dot 29953da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * operator should be included in the results. 29963da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 29973da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_DotMemberAccess = 1 << 5, 29983da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 29993da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for fields of the member being accessed using the arrow 30003da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * operator should be included in the results. 30013da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30023da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ArrowMemberAccess = 1 << 6, 30033da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30043da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for properties of the Objective-C object being accessed 30053da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * using the dot operator should be included in the results. 30063da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30073da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCPropertyAccess = 1 << 7, 30083da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 30093da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30103da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for enum tags should be included in the results. 30113da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30123da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_EnumTag = 1 << 8, 30133da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30143da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for union tags should be included in the results. 30153da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30163da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_UnionTag = 1 << 9, 30173da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30183da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for struct tags should be included in the results. 30193da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30203da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_StructTag = 1 << 10, 30213da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 30223da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30233da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ class names should be included in the results. 30243da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30253da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ClassTag = 1 << 11, 30263da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30273da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ namespaces and namespace aliases should be 30283da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * included in the results. 30293da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30303da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Namespace = 1 << 12, 30313da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30323da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ nested name specifiers should be included in 30333da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 30343da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30353da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_NestedNameSpecifier = 1 << 13, 30363da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 30373da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30383da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C interfaces (classes) should be included 30393da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * in the results. 30403da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30413da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCInterface = 1 << 14, 30423da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30433da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C protocols should be included in 30443da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 30453da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30463da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCProtocol = 1 << 15, 30473da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30483da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C categories should be included in 30493da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 30503da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30513da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCCategory = 1 << 16, 30523da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30533da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C instance messages should be included 30543da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * in the results. 30553da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30563da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCInstanceMessage = 1 << 17, 30573da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30583da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C class messages should be included in 30593da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 30603da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30613da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCClassMessage = 1 << 18, 30623da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30633da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C selector names should be included in 30643da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 30653da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30663da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCSelectorName = 1 << 19, 30673da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 30683da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30693da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for preprocessor macro names should be included in 30703da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 30713da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30723da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_MacroName = 1 << 20, 30733da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 30743da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30753da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Natural language completions should be included in the results. 30763da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30773da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_NaturalLanguage = 1 << 21, 30783da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 30793da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 30803da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief The current context is unknown, so set all contexts. 30813da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 30823da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Unknown = ((1 << 22) - 1) 30833da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor}; 30843da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 30853da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor/** 3086cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Returns a default set of code-completion options that can be 3087cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * passed to\c clang_codeCompleteAt(). 3088cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 3089cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas GregorCINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void); 3090cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 3091cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 30921abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \brief Perform code completion at a given location in a translation unit. 30931abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 30941abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * This function performs code completion at a particular file, line, and 30951abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * column within source code, providing results that suggest potential 30961abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code snippets based on the context of the completion. The basic model 30971abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * for code completion is that Clang will parse a complete source file, 30981abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * performing syntax checking up to the location where code-completion has 30991abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * been requested. At that point, a special code-completion token is passed 31001abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * to the parser, which recognizes this token and determines, based on the 31011abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * current location in the C/Objective-C/C++ grammar and the state of 31021abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * semantic analysis, what completions to provide. These completions are 31031abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * returned via a new \c CXCodeCompleteResults structure. 31041abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 31051abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Code completion itself is meant to be triggered by the client when the 31061abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * user types punctuation characters or whitespace, at which point the 31071abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code-completion location will coincide with the cursor. For example, if \c p 31081abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is a pointer, code-completion might be triggered after the "-" and then 31091abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * after the ">" in \c p->. When the code-completion location is afer the ">", 31101abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the completion results will provide, e.g., the members of the struct that 31111abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * "p" points to. The client is responsible for placing the cursor at the 31121abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * beginning of the token currently being typed, then filtering the results 31131abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * based on the contents of the token. For example, when code-completing for 31141abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the expression \c p->get, the client should provide the location just after 31151abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the 31161abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client can filter the results based on the current token text ("get"), only 31171abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * showing those results that start with "get". The intent of this interface 31181abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is to separate the relatively high-latency acquisition of code-completion 31191abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * results from the filtering of results on a per-character basis, which must 31201abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * have a lower latency. 31211abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 31221abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param TU The translation unit in which code-completion should 31231abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * occur. The source files for this translation unit need not be 31241abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completely up-to-date (and the contents of those source files may 31251abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * be overridden via \p unsaved_files). Cursors referring into the 31261abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * translation unit may be invalidated by this invocation. 31271abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 31281abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_filename The name of the source file where code 31291abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion should be performed. This filename may be any file 31301abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * included in the translation unit. 31311abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 31321abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_line The line at which code-completion should occur. 31331abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 31341abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_column The column at which code-completion should occur. 31351abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Note that the column should point just after the syntactic construct that 31361abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * initiated code completion, and not in the middle of a lexical token. 31371abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 31381abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param unsaved_files the Tiles that have not yet been saved to disk 31391abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing or code completion, including the 31401abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * contents of those files. The contents and name of these files (as 31411abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * specified by CXUnsavedFile) are copied when necessary, so the 31421abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client only needs to guarantee their validity until the call to 31431abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * this function returns. 31441abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 31451abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 31461abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * unsaved_files. 31471abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 3148cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \param options Extra options that control the behavior of code 3149cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completion, expressed as a bitwise OR of the enumerators of the 3150cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * CXCodeComplete_Flags enumeration. The 3151cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \c clang_defaultCodeCompleteOptions() function returns a default set 3152cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * of code-completion options. 3153cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 31541abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \returns If successful, a new \c CXCodeCompleteResults structure 31551abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * containing code-completion results, which should eventually be 31561abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * freed with \c clang_disposeCodeCompleteResults(). If code 31571abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion fails, returns NULL. 31581abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor */ 31591abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCINDEX_LINKAGE 31601abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU, 31611abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor const char *complete_filename, 31621abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_line, 31631abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_column, 31641abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor struct CXUnsavedFile *unsaved_files, 3165cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned num_unsaved_files, 3166cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned options); 31671abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 31681abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor/** 31691e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \brief Sort the code-completion results in case-insensitive alphabetical 31701e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * order. 31711e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * 31721e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param Results The set of results to sort. 31731e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param NumResults The number of results in \p Results. 31741e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor */ 31751e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas GregorCINDEX_LINKAGE 31761e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregorvoid clang_sortCodeCompletionResults(CXCompletionResult *Results, 31771e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor unsigned NumResults); 31781e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor 31791e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor/** 3180ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Free the given set of code-completion results. 31810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31821efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE 3183ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregorvoid clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results); 318458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 318520d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor/** 3186a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced prior to the 3187a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * location where code completion was performed. 3188a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 3189896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 3190a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorunsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results); 3191a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 3192a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 3193a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given code completion. 3194a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 3195a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Result the code completion results to query. 3196a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 3197a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 3198a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 3199a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 3200a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 3201896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 3202a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results, 3203a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 3204a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 3205a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 32063da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Determines what compeltions are appropriate for the context 32073da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the given code completion. 32083da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 32093da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \param Results the code completion results to query 32103da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 32113da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \returns the kinds of completions that are appropriate for use 32123da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * along with the given code completion results. 32133da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 32143da626b4f38eb0350de960d71271ca77af7a9cc8Douglas GregorCINDEX_LINKAGE 32153da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregorunsigned long long clang_codeCompleteGetContexts( 32163da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCodeCompleteResults *Results); 3217e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor 3218e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor/** 3219e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \brief Returns the cursor kind for the container for the current code 3220e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * completion context. The container is only guaranteed to be set for 3221e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * contexts where a container exists (i.e. member accesses or Objective-C 3222e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * message sends); if there is not a container, this function will return 3223e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * CXCursor_InvalidCode. 3224e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3225e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param Results the code completion results to query 3226e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3227e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param IsIncomplete on return, this value will be false if Clang has complete 3228e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * information about the container. If Clang does not have complete 3229e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * information, this value will be true. 3230e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3231e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \returns the container kind, or CXCursor_InvalidCode if there is not a 3232e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * container 3233e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor */ 3234e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCINDEX_LINKAGE 3235e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregorenum CXCursorKind clang_codeCompleteGetContainerKind( 3236e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor CXCodeCompleteResults *Results, 3237e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor unsigned *IsIncomplete); 3238e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor 3239e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor/** 3240e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \brief Returns the USR for the container for the current code completion 3241e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * context. If there is not a container for the current context, this 3242e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * function will return the empty string. 3243e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3244e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param Results the code completion results to query 3245e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3246e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \returns the USR for the container 3247e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor */ 3248e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCINDEX_LINKAGE 3249e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results); 32503da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 32510a47d69af8bda945352997af3da4687a3356096aDouglas Gregor 32520a47d69af8bda945352997af3da4687a3356096aDouglas Gregor/** 32530a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \brief Returns the currently-entered selector for an Objective-C message 32540a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * send, formatted like "initWithFoo:bar:". Only guaranteed to return a 32550a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * non-empty string for CXCompletionContext_ObjCInstanceMessage and 32560a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * CXCompletionContext_ObjCClassMessage. 32570a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * 32580a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \param Results the code completion results to query 32590a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * 32600a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \returns the selector (or partial selector) that has been entered thus far 32610a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * for an Objective-C message send. 32620a47d69af8bda945352997af3da4687a3356096aDouglas Gregor */ 32630a47d69af8bda945352997af3da4687a3356096aDouglas GregorCINDEX_LINKAGE 32640a47d69af8bda945352997af3da4687a3356096aDouglas GregorCXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results); 32650a47d69af8bda945352997af3da4687a3356096aDouglas Gregor 32663da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor/** 326720d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * @} 326820d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor */ 32691efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 32701efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 327104bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek/** 327204bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * \defgroup CINDEX_MISC Miscellaneous utility functions 327304bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * 327404bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @{ 327504bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 327623e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek 327723e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek/** 327823e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * \brief Return a version string, suitable for showing to a user, but not 327923e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * intended to be parsed (the format is not guaranteed to be stable). 328023e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek */ 3281a2a9d6e4e5b6001b86b7dfc5db1ea296ce29a3d3Ted KremenekCINDEX_LINKAGE CXString clang_getClangVersion(); 328204bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek 3283d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek 3284d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek/** 3285d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * \brief Enable/disable crash recovery. 3286d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * 3287d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * \param Flag to indicate if crash recovery is enabled. A non-zero value 3288d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * enables crash recovery, while 0 disables it. 3289d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek */ 3290d2427ddf00aacdc288c386f3882e0821ca9bd27bTed KremenekCINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled); 3291d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek 329216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek /** 3293896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Visitor invoked for each file in a translation unit 329416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * (used with clang_getInclusions()). 329516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * 329616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * This visitor function will be invoked by clang_getInclusions() for each 329716b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * file included (either at the top-level or by #include directives) within 329816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * a translation unit. The first argument is the file being included, and 329916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the second and third arguments provide the inclusion stack. The 330016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * array is sorted in order of immediate inclusion. For example, 330116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the first element refers to the location that included 'included_file'. 330216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 330316b55a71695a33c094383295cc7b7a2080e098daTed Kremenektypedef void (*CXInclusionVisitor)(CXFile included_file, 330416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXSourceLocation* inclusion_stack, 330516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek unsigned include_len, 330616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 330716b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 330816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 330916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * \brief Visit the set of preprocessor inclusions in a translation unit. 331016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * The visitor function is called with the provided data for every included 331116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * file. This does not include headers included by the PCH file (unless one 331216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * is inspecting the inclusions in the PCH file itself). 331316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 331416b55a71695a33c094383295cc7b7a2080e098daTed KremenekCINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu, 331516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXInclusionVisitor visitor, 331616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 331716b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 331816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 331904bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @} 332004bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 33211efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 332297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** \defgroup CINDEX_REMAPPING Remapping functions 332397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 332497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * @{ 332597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 332697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 332797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 332897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief A remapping of original source files and their translated files. 332997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 333097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidistypedef void *CXRemapping; 333197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 333297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 333397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Retrieve a remapping. 333497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 333597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param path the path that contains metadata about remappings. 333697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 333797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \returns the requested remapping. This remapping must be freed 333897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred. 333997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 334097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path); 334197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 334297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 334397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Determine the number of remappings. 334497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 334597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping); 334697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 334797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 334897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Get the original and the associated filename from the remapping. 334997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 335097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param original If non-NULL, will be set to the original filename. 335197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 335297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param transformed If non-NULL, will be set to the filename that the original 335397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * is associated with. 335497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 335597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index, 335697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis CXString *original, CXString *transformed); 335797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 335897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 335997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Dispose the remapping. 336097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 336197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE void clang_remap_dispose(CXRemapping); 336297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 336397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 336497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * @} 336597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 336697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 3367c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 3368c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 3369c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 33701efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 3371d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifdef __cplusplus 3372d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek} 3373d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 3374d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 3375d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 3376