Index.h revision aca19be8731fc31cff68702de0dc7f30ce908979
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 */ 118d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen CXAvailability_NotAvailable, 119d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen /** 120d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen * \brief The entity is available, but not accessible; any use of it will be 121d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen * an error. 122d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen */ 123d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen CXAvailability_NotAccessible 12458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor}; 12558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 1267f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1277f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \defgroup CINDEX_STRING String manipulation routines 1287f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * 1297f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * @{ 1307f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 1311efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1327f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1337f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief A character string. 1347f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * 1357f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * The \c CXString type is used to return strings from the interface when 1367f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * the ownership of that string might different from one call to the next. 1377f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * Use \c clang_getCString() to retrieve the string data and, once finished 1387f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * with the string data, call \c clang_disposeString() to free the string. 139ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff */ 140ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Narofftypedef struct { 141a60ed47da13393796d8552b9fdca12abbb3eea42Ted Kremenek void *data; 142ed122735639d83c10f18c28c7fd117bfcd0f62cbTed Kremenek unsigned private_flags; 143ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff} CXString; 144ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff 1457f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1467f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief Retrieve the character data associated with the given string. 1477f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 148ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve NaroffCINDEX_LINKAGE const char *clang_getCString(CXString string); 149ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff 1507f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1517f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief Free the given string, 1527f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 153ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve NaroffCINDEX_LINKAGE void clang_disposeString(CXString string); 154ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff 1557f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1567f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * @} 1577f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 1581efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1591efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 160e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * \brief clang_createIndex() provides a shared context for creating 161e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * translation units. It provides two options: 162e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * 163e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local" 164e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * declarations (when loading any new translation units). A "local" declaration 1651efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * is one that belongs in the translation unit itself and not in a precompiled 166e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * header that was used by the translation unit. If zero, all declarations 167e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * will be enumerated. 168e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * 169b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * Here is an example: 170b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 1710a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * // excludeDeclsFromPCH = 1, displayDiagnostics=1 1720a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * Idx = clang_createIndex(1, 1); 173b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 174b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // IndexTest.pch was produced with the following command: 175b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch" 176b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * TU = clang_createTranslationUnit(Idx, "IndexTest.pch"); 177b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 178b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // This will load all the symbols from 'IndexTest.pch' 1791efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * clang_visitChildren(clang_getTranslationUnitCursor(TU), 180002a528ab0189fc60cfbf9328962c96ccbe567eeDouglas Gregor * TranslationUnitVisitor, 0); 181b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * clang_disposeTranslationUnit(TU); 182b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 183b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // This will load all the symbols from 'IndexTest.c', excluding symbols 184b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // from 'IndexTest.pch'. 185fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" }; 186fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args, 187fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * 0, 0); 188b2cd48756119f4d8d2a865b4b3e0e8efd02e26a0Douglas Gregor * clang_visitChildren(clang_getTranslationUnitCursor(TU), 189b2cd48756119f4d8d2a865b4b3e0e8efd02e26a0Douglas Gregor * TranslationUnitVisitor, 0); 190b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * clang_disposeTranslationUnit(TU); 191b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 192b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * This process of creating the 'pch', loading it separately, and using it (via 193b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks 194b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * (which gives the indexer the same performance benefit as the compiler). 195e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff */ 1960a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH, 1970a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor int displayDiagnostics); 198896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1990087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor/** 2000087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * \brief Destroy the given index. 2010087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * 2020087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * The index must not be destroyed until all of the translation units created 2030087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * within that index have been destroyed. 2040087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor */ 2058506dde586459887b7e14e23a30af8ac5be5adb6Daniel DunbarCINDEX_LINKAGE void clang_disposeIndex(CXIndex index); 2061efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2071efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 208c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_FILES File manipulation routines 209f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 210f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @{ 211f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 2121efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 213f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 214f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief A particular source file that is part of a translation unit. 215f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 216f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregortypedef void *CXFile; 2171efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 218f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor 219f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 220f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief Retrieve the complete file and path name of the given file. 22188145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff */ 22274844072411bae91d5dbb89955d200cbe1e0a1c8Ted KremenekCINDEX_LINKAGE CXString clang_getFileName(CXFile SFile); 2231efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 224f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 225f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief Retrieve the last modification time of the given file. 226f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 22708b0e8daeb683686b876d72674962ad96df21d45Douglas GregorCINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile); 22888145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff 2293c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor/** 230dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor * \brief Determine whether the given header is guarded against 231dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor * multiple inclusions, either with the conventional 232dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor * #ifndef/#define/#endif macro guards or with #pragma once. 233dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor */ 234dd3e5549e3c11e217078938aacf72f042eea5343Douglas GregorCINDEX_LINKAGE unsigned 235dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregorclang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file); 236dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor 237dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor/** 238b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a file handle within the given translation unit. 239b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 240b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \param tu the translation unit 2411efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 242b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \param file_name the name of the file. 243b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 244b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns the file handle for the named file in the translation unit \p tu, 245b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * or a NULL file handle if the file was not a part of this translation unit. 246b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 2471efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu, 248b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor const char *file_name); 2491efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 250b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 251f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @} 252f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 253f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor 254f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 255f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \defgroup CINDEX_LOCATIONS Physical source locations 256f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 257f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * Clang represents physical source locations in its abstract syntax tree in 258f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * great detail, with file, line, and column information for the majority of 259f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * the tokens parsed in the source code. These data types and functions are 260f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * used to represent source location information, either for a particular 261f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * point in the program or for a range of points in the program, and extract 262f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * specific location information from those data types. 263f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 264f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @{ 265f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 2661efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 267f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 2681db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * \brief Identifies a specific source location within a translation 2691db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * unit. 2701db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 27120174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * Use clang_getExpansionLocation() or clang_getSpellingLocation() 272a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * to map a source location to a particular file, line, and column. 2733c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor */ 2743c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregortypedef struct { 2755352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor void *ptr_data[2]; 2761db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned int_data; 2773c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor} CXSourceLocation; 278fe6fd3d41a7f48317d6856c9327b6cead32c3498Ted Kremenek 2793c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor/** 280d52864bd33c66aacc84133460d8c9c0dfcdd5c18Daniel Dunbar * \brief Identifies a half-open character range in the source code. 2813c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor * 2821db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the 2831db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * starting and end locations from a source range, respectively. 2843c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor */ 2853c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregortypedef struct { 2865352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor void *ptr_data[2]; 2871db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned begin_int_data; 2881db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned end_int_data; 2893c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor} CXSourceRange; 290fe6fd3d41a7f48317d6856c9327b6cead32c3498Ted Kremenek 2911db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor/** 292b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a NULL (invalid) source location. 293b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 294b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getNullLocation(); 2951efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 296b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 297b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \determine Determine whether two source locations, which must refer into 2981efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * the same translation unit, refer to exactly the same point in the source 299b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * code. 300b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 301b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns non-zero if the source locations refer to the same location, zero 302b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * if they refer to different locations. 303b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 304b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1, 305b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXSourceLocation loc2); 3061efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 307b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 3081efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieves the source location associated with a given file/line/column 3091efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * in a particular translation unit. 310b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 311b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu, 312b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXFile file, 313b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor unsigned line, 314b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor unsigned column); 31583889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall/** 31683889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall * \brief Retrieves the source location associated with a given character offset 31783889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall * in a particular translation unit. 31883889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall */ 31983889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid ChisnallCINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu, 32083889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall CXFile file, 32183889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall unsigned offset); 3221efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 323b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 3245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve a NULL (invalid) source range. 3255352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 3265352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXSourceRange clang_getNullRange(); 327896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3285352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 329b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a source range given the beginning and ending source 330b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * locations. 331b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 332b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin, 333b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXSourceLocation end); 3341efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 335b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 336ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor * \brief Determine whether two ranges are equivalent. 337ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor * 338ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor * \returns non-zero if the ranges are the same, zero if they differ. 339ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor */ 340ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas GregorCINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1, 341ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor CXSourceRange range2); 342ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor 343ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor/** 344de5db649fd5f9aedde200f443ad73d62517b1c88Argyrios Kyrtzidis * \brief Returns non-zero if \arg range is null. 345de5db649fd5f9aedde200f443ad73d62517b1c88Argyrios Kyrtzidis */ 346733dbc805facad7cebec5420f6c47c83848cee5fErik VerbruggenCINDEX_LINKAGE int clang_Range_isNull(CXSourceRange range); 347de5db649fd5f9aedde200f443ad73d62517b1c88Argyrios Kyrtzidis 348de5db649fd5f9aedde200f443ad73d62517b1c88Argyrios Kyrtzidis/** 34946766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * \brief Retrieve the file, line, column, and offset represented by 35046766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * the given source location. 3511db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 35220174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * If the location refers into a macro expansion, retrieves the 35320174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * location of the macro expansion. 354a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 3551efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param location the location within a source file that will be decomposed 3561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * into its parts. 3571db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3581efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param file [out] if non-NULL, will be set to the file to which the given 3591db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * source location points. 3601db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3611efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param line [out] if non-NULL, will be set to the line to which the given 3621db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * source location points. 3631db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3641efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param column [out] if non-NULL, will be set to the column to which the given 3651efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source location points. 36646766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * 36746766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * \param offset [out] if non-NULL, will be set to the offset into the 36846766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * buffer to which the given source location points. 3691db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 37020174221af145554b76a0b0f5e4eb3ac70d05945Chandler CarruthCINDEX_LINKAGE void clang_getExpansionLocation(CXSourceLocation location, 37120174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth CXFile *file, 37220174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth unsigned *line, 37320174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth unsigned *column, 37420174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth unsigned *offset); 37520174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth 37620174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth/** 377e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \brief Retrieve the file, line, column, and offset represented by 378e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * the given source location, as specified in a # line directive. 379e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 380e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * Example: given the following source code in a file somefile.c 381e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 382e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * #123 "dummy.c" 1 383e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 384e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * static int func(void) 385e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * { 386e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * return 0; 387e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * } 388e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 389e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * the location information returned by this function would be 390e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 391e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * File: dummy.c Line: 124 Column: 12 392e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 393e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * whereas clang_getExpansionLocation would have returned 394e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 395e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * File: somefile.c Line: 3 Column: 12 396e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 397e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \param location the location within a source file that will be decomposed 398e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * into its parts. 399e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 400e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \param filename [out] if non-NULL, will be set to the filename of the 401e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * source location. Note that filenames returned will be for "virtual" files, 402e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * which don't necessarily exist on the machine running clang - e.g. when 403e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * parsing preprocessed output obtained from a different environment. If 404e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * a non-NULL value is passed in, remember to dispose of the returned value 405e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * using \c clang_disposeString() once you've finished with it. For an invalid 406e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * source location, an empty string is returned. 407e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 408e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \param line [out] if non-NULL, will be set to the line number of the 409e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * source location. For an invalid source location, zero is returned. 410e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 411e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \param column [out] if non-NULL, will be set to the column number of the 412e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * source location. For an invalid source location, zero is returned. 413e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis */ 414e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios KyrtzidisCINDEX_LINKAGE void clang_getPresumedLocation(CXSourceLocation location, 415e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis CXString *filename, 416e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis unsigned *line, 417e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis unsigned *column); 418e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis 419e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis/** 42020174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * \brief Legacy API to retrieve the file, line, column, and offset represented 42120174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * by the given source location. 42220174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * 42320174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * This interface has been replaced by the newer interface 42420174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * \see clang_getExpansionLocation(). See that interface's documentation for 42520174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * details. 42620174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth */ 4271db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location, 4281db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor CXFile *file, 4291db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned *line, 43046766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor unsigned *column, 43146766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor unsigned *offset); 432e69517ce61638f12c9abe4605753a45275ac4e37Douglas Gregor 433e69517ce61638f12c9abe4605753a45275ac4e37Douglas Gregor/** 434a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \brief Retrieve the file, line, column, and offset represented by 435a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * the given source location. 436a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 437a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * If the location refers into a macro instantiation, return where the 438a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * location was originally spelled in the source file. 439a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 440a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param location the location within a source file that will be decomposed 441a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * into its parts. 442a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 443a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param file [out] if non-NULL, will be set to the file to which the given 444a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 445a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 446a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param line [out] if non-NULL, will be set to the line to which the given 447a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 448a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 449a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param column [out] if non-NULL, will be set to the column to which the given 450a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 451a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 452a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param offset [out] if non-NULL, will be set to the offset into the 453a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * buffer to which the given source location points. 454a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor */ 455a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas GregorCINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location, 456a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor CXFile *file, 457a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *line, 458a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *column, 459a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *offset); 460a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor 461a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor/** 4621efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve a source location representing the first character within a 4631efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source range. 4641db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 4651db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range); 4661db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor 4671db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor/** 4681efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve a source location representing the last character within a 4691efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source range. 4701db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 4711db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range); 4721db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor 473f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 474f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @} 475f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 476c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 477c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 4785352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \defgroup CINDEX_DIAG Diagnostic reporting 4795352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 4805352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @{ 4815352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4825352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4835352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 4845352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Describes the severity of a particular diagnostic. 4855352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4865352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorenum CXDiagnosticSeverity { 4875352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 488896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief A diagnostic that has been suppressed, e.g., by a command-line 4895352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * option. 4905352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4915352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Ignored = 0, 492896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 4935352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 4945352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic is a note that should be attached to the 4955352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * previous (non-note) diagnostic. 4965352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4975352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Note = 1, 4985352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4995352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 5005352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates suspicious code that may not be 5015352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * wrong. 5025352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5035352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Warning = 2, 5045352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5055352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 5065352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates that the code is ill-formed. 5075352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5085352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Error = 3, 5095352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5105352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 5115352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates that the code is ill-formed such 5125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * that future parser recovery is unlikely to produce useful 5135352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * results. 5145352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Fatal = 4 5165352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor}; 5175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5195352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief A single diagnostic, containing the diagnostic's severity, 5205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * location, text, source ranges, and fix-it hints. 5215352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5225352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregortypedef void *CXDiagnostic; 5235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 525a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced for the given 526a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * translation unit. 527a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 528a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit); 529a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 530a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 531a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given translation unit. 5325352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 533a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Unit the translation unit to query. 534a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 5355352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 536a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 537a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 5385352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 539a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit, 540a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 541a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 542a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 543a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Destroy a diagnostic. 544a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 545a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic); 5465352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5475352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5480a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Options to control the display of diagnostics. 5490a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 5500a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * The values in this enum are meant to be combined to customize the 5510a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * behavior of \c clang_displayDiagnostic(). 5520a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 5530a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregorenum CXDiagnosticDisplayOptions { 5540a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 5550a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Display the source-location information where the 5560a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic was located. 5570a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 5580a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * When set, diagnostics will be prefixed by the file, line, and 5590a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * (optionally) column to which the diagnostic refers. For example, 5600a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 5610a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \code 5620a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * test.c:28: warning: extra tokens at end of #endif directive 5630a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \endcode 5640a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 5650a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-source-location. 5660a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 5670a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplaySourceLocation = 0x01, 5680a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 5690a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 5700a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 5710a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include the column number. 5720a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 5730a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-column. 5740a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 5750a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplayColumn = 0x02, 5760a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 5770a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 5780a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 5790a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include information about source ranges in a 5800a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * machine-parsable format. 5810a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 582896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * This option corresponds to the clang flag 5830a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \c -fdiagnostics-print-source-range-info. 5840a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 585aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplaySourceRanges = 0x04, 586aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 587aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 588aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the option name associated with this diagnostic, if any. 589aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 590aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The option name displayed (e.g., -Wconversion) will be placed in brackets 591aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * after the diagnostic text. This option corresponds to the clang flag 592aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-option. 593aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 594aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayOption = 0x08, 595aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 596aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 597aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the category number associated with this diagnostic, if any. 598aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 599aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The category number is displayed within brackets after the diagnostic text. 600aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * This option corresponds to the clang flag 601aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-category=id. 602aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 603aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayCategoryId = 0x10, 604aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 605aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 606aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the category name associated with this diagnostic, if any. 607aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 608aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The category name is displayed within brackets after the diagnostic text. 609aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * This option corresponds to the clang flag 610aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-category=name. 611aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 612aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayCategoryName = 0x20 6130a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor}; 6140a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 6150a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 616274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \brief Format the given diagnostic in a manner that is suitable for display. 6170a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 618274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * This routine will format the given diagnostic to a string, rendering 619896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the diagnostic according to the various options given. The 620896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \c clang_defaultDiagnosticDisplayOptions() function returns the set of 6210a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * options that most closely mimics the behavior of the clang compiler. 6220a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6230a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \param Diagnostic The diagnostic to print. 6240a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 625896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Options A set of options that control the diagnostic display, 6260a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * created by combining \c CXDiagnosticDisplayOptions values. 627274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * 628274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \returns A new string containing for formatted diagnostic. 6290a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 630274f1906f12ebf8fcc179701deeda6d3271120c1Douglas GregorCINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic, 631274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor unsigned Options); 6320a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 6330a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 6340a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Retrieve the set of display options most similar to the 6350a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * default behavior of the clang compiler. 6360a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6370a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \returns A set of display options suitable for use with \c 6380a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * clang_displayDiagnostic(). 6390a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 6400a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void); 6410a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 6420a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 6435352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the severity of the given diagnostic. 6445352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 645896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE enum CXDiagnosticSeverity 6465352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getDiagnosticSeverity(CXDiagnostic); 6475352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6485352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6495352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the source location of the given diagnostic. 6505352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6515352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * This location is where Clang would print the caret ('^') when 6525352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * displaying the diagnostic on the command line. 6535352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 6545352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic); 6555352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6565352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6575352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the text of the given diagnostic. 6585352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 6595352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic); 660a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor 661a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor/** 662aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the name of the command-line option that enabled this 663aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostic. 664aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 665aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Diag The diagnostic to be queried. 666aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 667aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Disable If non-NULL, will be set to the option that disables this 668aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostic (if any). 669aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 670aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns A string that contains the command-line option used to enable this 671aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * warning, such as "-Wconversion" or "-pedantic". 672aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 673aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag, 674aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXString *Disable); 675aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 676aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 677aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the category number for this diagnostic. 678aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 679aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * Diagnostics can be categorized into groups along with other, related 680aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostics (e.g., diagnostics under the same warning flag). This routine 681aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * retrieves the category number for the given diagnostic. 682aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 683aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns The number of the category that contains this diagnostic, or zero 684aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * if this diagnostic is uncategorized. 685aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 686aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic); 687aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 688aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 689aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the name of a particular diagnostic category. 690aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 691aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Category A diagnostic category number, as returned by 692aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c clang_getDiagnosticCategory(). 693aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 694aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns The name of the given diagnostic category. 695aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 696aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticCategoryName(unsigned Category); 697aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 698aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 699a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Determine the number of source ranges associated with the given 700a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * diagnostic. 701a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor */ 702a3890baf1256ff26081306c7fef70202f8223f41Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic); 703896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 7045352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 705a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Retrieve a source range associated with the diagnostic. 7065352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 707a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * A diagnostic's source ranges highlight important elements in the source 7085352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * code. On the command line, Clang displays source ranges by 709896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * underlining them with '~' characters. 7105352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 711a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \param Diagnostic the diagnostic whose range is being extracted. 7125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 713896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Range the zero-based index specifying which range to 7145352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 715a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \returns the requested source range. 7165352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 717896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic, 718a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor unsigned Range); 7195352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 7205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7215352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the number of fix-it hints associated with the 7225352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * given diagnostic. 7235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 7245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic); 7255352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 7265352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 727473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \brief Retrieve the replacement information for a given fix-it. 7285352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 729473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * Fix-its are described in terms of a source range whose contents 730473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * should be replaced by a string. This approach generalizes over 731473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * three kinds of operations: removal of source code (the range covers 732473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * the code to be removed and the replacement string is empty), 733473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replacement of source code (the range covers the code to be 734473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced and the replacement string provides the new code), and 735473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion (both the start and end of the range point at the 736473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion location, and the replacement string provides the text to 737473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insert). 7385352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 739473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param Diagnostic The diagnostic whose fix-its are being queried. 7405352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 741473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param FixIt The zero-based index of the fix-it. 7425352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 743473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param ReplacementRange The source range whose contents will be 744473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced with the returned replacement string. Note that source 745473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * ranges are half-open ranges [a, b), so the source code should be 746473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced from a and up to (but not including) b. 7475352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 748473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \returns A string containing text that should be replace the source 749473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * code indicated by the \c ReplacementRange. 7505352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 751896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic, 752473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor unsigned FixIt, 753473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor CXSourceRange *ReplacementRange); 7545352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 7555352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7565352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 7575352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 7585352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 7595352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7605352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation 7615352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7625352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * The routines in this group provide the ability to create and destroy 7635352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * translation units from files, either by parsing the contents of the files or 7645352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * by reading in a serialized representation of a translation unit. 7655352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7665352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @{ 7675352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 768896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 7695352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7705352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Get the original translation unit source file name. 7715352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 7725352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString 7735352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getTranslationUnitSpelling(CXTranslationUnit CTUnit); 7745352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 7755352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7765352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Return the CXTranslationUnit for a given source file and the provided 7775352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * command line arguments one would pass to the compiler. 7785352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7795352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: The 'source_filename' argument is optional. If the caller provides a 7805352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * NULL pointer, the name of the source file is expected to reside in the 7815352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * specified command line arguments. 7825352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7835352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: When encountered in 'clang_command_line_args', the following options 7845352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * are ignored: 7855352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7865352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-c' 7875352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-emit-ast' 7885352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-fsyntax-only' 7895352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-o <output file>' (both '-o' and '<output file>' are ignored) 7905352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7911ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param CIdx The index object with which the translation unit will be 7921ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * associated. 7935352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7945352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param source_filename - The name of the source file to load, or NULL if the 7951ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * source file is included in \p clang_command_line_args. 7961ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * 7971ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param num_clang_command_line_args The number of command-line arguments in 7981ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \p clang_command_line_args. 7991ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * 8001ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param clang_command_line_args The command-line arguments that would be 8011ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * passed to the \c clang executable if it were being invoked out-of-process. 8021ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * These command-line options will be parsed and will affect how the translation 8031ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * unit is parsed. Note that the following options are ignored: '-c', 8041ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'. 8055352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8065352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 8075352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * unsaved_files. 8085352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8095352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 8105352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * but may be required for code completion, including the contents of 811c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * those files. The contents and name of these files (as specified by 812c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * CXUnsavedFile) are copied when necessary, so the client only needs to 813c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * guarantee their validity until the call to this function returns. 8145352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 8155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile( 8165352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXIndex CIdx, 8175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor const char *source_filename, 8185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor int num_clang_command_line_args, 8192ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *clang_command_line_args, 8205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor unsigned num_unsaved_files, 821a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor struct CXUnsavedFile *unsaved_files); 822896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 8235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 8245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Create a translation unit from an AST file (-emit-ast). 8255352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 826896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(CXIndex, 827a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const char *ast_filename); 8285352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 82944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor/** 83044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Flags that control the creation of translation units. 83144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 83244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * The enumerators in this enumeration type are meant to be bitwise 83344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * ORed together to specify which options should be used when 83444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * constructing the translation unit. 83544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 8365a43021ac491bf091494167127772a20d9a9bb48Douglas Gregorenum CXTranslationUnit_Flags { 8375a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 8385a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that no special translation-unit options are 8395a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * needed. 8405a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 8415a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor CXTranslationUnit_None = 0x0, 8425a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 8435a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 8445a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that the parser should construct a "detailed" 8455a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * preprocessing record, including all macro definitions and instantiations. 8465a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 8475a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * Constructing a detailed preprocessing record requires more memory 8485a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * and time to parse, since the information contained in the record 8495a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is usually not retained. However, it can be useful for 8505a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * applications that require more detailed information about the 8515a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * behavior of the preprocessor. 8525a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 85344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor CXTranslationUnit_DetailedPreprocessingRecord = 0x01, 85444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 85544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 856b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Used to indicate that the translation unit is incomplete. 85744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 858b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * When a translation unit is considered "incomplete", semantic 859b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * analysis that is typically performed at the end of the 860b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * translation unit will be suppressed. For example, this suppresses 861b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * the completion of tentative declarations in C and of 862b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * instantiation of implicitly-instantiation function templates in 863b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * C++. This option is typically used when parsing a header with the 864b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * intent of producing a precompiled header. 86544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 866b1c031be513705d924038f497279b9b599868ba1Douglas Gregor CXTranslationUnit_Incomplete = 0x02, 86744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 86844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 86944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Used to indicate that the translation unit should be built with an 87044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header for the preamble. 87144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 87244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * An implicit precompiled header is used as an optimization when a 87344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * particular translation unit is likely to be reparsed many times 87444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * when the sources aren't changing that often. In this case, an 87544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header will be built containing all of the 87644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * initial includes at the top of the main file (what we refer to as 87744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * the "preamble" of the file). In subsequent parses, if the 87844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * preamble or the files in it have not changed, \c 87944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * clang_reparseTranslationUnit() will re-use the implicit 88044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * precompiled header to improve parsing performance. 88144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 882e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXTranslationUnit_PrecompiledPreamble = 0x04, 883e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 884e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 885e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that the translation unit should cache some 886e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion results with each reparse of the source file. 887e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 888e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * Caching of code-completion results is a performance optimization that 889e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * introduces some overhead to reparsing but improves the performance of 890e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion operations. 891e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 89299ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CacheCompletionResults = 0x08, 89399ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 894b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * \brief DEPRECATED: Enable precompiled preambles in C++. 89599ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 89699ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 897b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * we are testing C++ precompiled preamble support. It is deprecated. 89899ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 89999ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CXXPrecompiledPreamble = 0x10, 90099ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor 90199ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 902b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * \brief DEPRECATED: Enabled chained precompiled preambles in C++. 90399ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 90499ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 905b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * we are testing C++ precompiled preamble support. It is deprecated. 90699ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 907dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor CXTranslationUnit_CXXChainedPCH = 0x20, 908dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor 909dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor /** 910dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor * \brief Used to indicate that the "detailed" preprocessing record, 911fd14e91dc0ac5db175c4b30af98e7f8adabcb508Chandler Carruth * if requested, should also contain nested macro expansions. 912dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor * 913fd14e91dc0ac5db175c4b30af98e7f8adabcb508Chandler Carruth * Nested macro expansions (i.e., macro expansions that occur 914fd14e91dc0ac5db175c4b30af98e7f8adabcb508Chandler Carruth * inside another macro expansion) can, in some code bases, require 915dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor * a large amount of storage to due preprocessor metaprogramming. Moreover, 916dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor * its fairly rare that this information is useful for libclang clients. 917dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor */ 918ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth CXTranslationUnit_NestedMacroExpansions = 0x40, 919ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth 920ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth /** 921ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth * \brief Legacy name to indicate that the "detailed" preprocessing record, 922fd14e91dc0ac5db175c4b30af98e7f8adabcb508Chandler Carruth * if requested, should contain nested macro expansions. 923ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth * 924ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth * \see CXTranslationUnit_NestedMacroExpansions for the current name for this 925ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth * value, and its semantics. This is just an alias. 926ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth */ 927ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth CXTranslationUnit_NestedMacroInstantiations = 928ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth CXTranslationUnit_NestedMacroExpansions 9295a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor}; 9305a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 9315a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor/** 932b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Returns the set of flags that is suitable for parsing a translation 933b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * unit that is being edited. 934b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * 935b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * The set of flags returned provide options for \c clang_parseTranslationUnit() 936b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * to indicate that the translation unit is likely to be reparsed many times, 937b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly 938b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag 939b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set contains an unspecified set of optimizations (e.g., the precompiled 940b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * preamble) geared toward improving the performance of these routines. The 941b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set of optimizations enabled may change from one version to the next. 942b1c031be513705d924038f497279b9b599868ba1Douglas Gregor */ 943e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void); 944b1c031be513705d924038f497279b9b599868ba1Douglas Gregor 945b1c031be513705d924038f497279b9b599868ba1Douglas Gregor/** 9465a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Parse the given source file and the translation unit corresponding 9475a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * to that file. 9485a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9495a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * This routine is the main entry point for the Clang C API, providing the 9505a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * ability to parse a source file into a translation unit that can then be 9515a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * queried by other functions in the API. This routine accepts a set of 9525a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * command-line arguments so that the compilation can be configured in the same 9535a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * way that the compiler is configured on the command line. 9545a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9555a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param CIdx The index object with which the translation unit will be 9565a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * associated. 9575a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9585a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param source_filename The name of the source file to load, or NULL if the 9591ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * source file is included in \p command_line_args. 9605a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9615a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param command_line_args The command-line arguments that would be 9625a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * passed to the \c clang executable if it were being invoked out-of-process. 9635a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * These command-line options will be parsed and will affect how the translation 9645a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unit is parsed. Note that the following options are ignored: '-c', 9655a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'. 9665a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9675a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_command_line_args The number of command-line arguments in 9685a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \p command_line_args. 9695a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9705a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 9711abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing, including the contents of 9725a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * those files. The contents and name of these files (as specified by 9735a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 9745a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * guarantee their validity until the call to this function returns. 9755a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9765a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 9775a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unsaved_files. 9785a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9795a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param options A bitmask of options that affects how the translation unit 9805a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is managed but not its compilation. This should be a bitwise OR of the 9815a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXTranslationUnit_XXX flags. 9825a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9835a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \returns A new translation unit describing the parsed code and containing 9845a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * any diagnostics produced by the compiler. If there is a failure from which 9855a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * the compiler cannot recover, returns NULL. 9865a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 9875a43021ac491bf091494167127772a20d9a9bb48Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx, 9885a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor const char *source_filename, 9892ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *command_line_args, 9905a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor int num_command_line_args, 9915a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor struct CXUnsavedFile *unsaved_files, 9925a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned num_unsaved_files, 9935a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned options); 9945a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 9955352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 9961999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Flags that control how translation units are saved. 9971999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 9981999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 9991999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * ORed together to specify which options should be used when 10001999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * saving the translation unit. 10011999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 10021999844e7a18786e61e619e1dc6c789827541863Douglas Gregorenum CXSaveTranslationUnit_Flags { 10031999844e7a18786e61e619e1dc6c789827541863Douglas Gregor /** 10041999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Used to indicate that no special saving options are needed. 10051999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 10061999844e7a18786e61e619e1dc6c789827541863Douglas Gregor CXSaveTranslationUnit_None = 0x0 10071999844e7a18786e61e619e1dc6c789827541863Douglas Gregor}; 10081999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 10091999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 10101999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Returns the set of flags that is suitable for saving a translation 10111999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * unit. 10121999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 10131999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The set of flags returned provide options for 10141999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \c clang_saveTranslationUnit() by default. The returned flag 10151999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * set contains an unspecified set of options that save translation units with 10161999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * the most commonly-requested data. 10171999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 10181999844e7a18786e61e619e1dc6c789827541863Douglas GregorCINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU); 10191999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 10201999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 102139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Describes the kind of error that occurred (if any) in a call to 102239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \c clang_saveTranslationUnit(). 102339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 102439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregorenum CXSaveError { 102539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 102639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that no error occurred while saving a translation unit. 102739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 102839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_None = 0, 102939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 103039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 103139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that an unknown error occurred while attempting to save 103239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * the file. 103339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * 103439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * This error typically indicates that file I/O failed when attempting to 103539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * write the file. 103639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 103739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_Unknown = 1, 103839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 103939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 104039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that errors during translation prevented this attempt 104139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * to save the translation unit. 104239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * 104339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * Errors that prevent the translation unit from being saved can be 104439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic(). 104539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 104639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_TranslationErrors = 2, 104739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 104839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 104939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that the translation unit to be saved was somehow 105039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * invalid (e.g., NULL). 105139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 105239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_InvalidTU = 3 105339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor}; 105439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 105539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor/** 10567ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \brief Saves a translation unit into a serialized representation of 10577ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * that translation unit on disk. 10587ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 10597ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * Any translation unit that was parsed without error can be saved 10607ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * into a file. The translation unit can then be deserialized into a 10617ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * new \c CXTranslationUnit with \c clang_createTranslationUnit() or, 10627ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * if it is an incomplete translation unit that corresponds to a 10637ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * header, used as a precompiled header when parsing other translation 10647ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * units. 10657ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 10667ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param TU The translation unit to save. 10671999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 10687ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param FileName The file to which the translation unit will be saved. 10697ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 10701999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \param options A bitmask of options that affects how the translation unit 10711999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * is saved. This should be a bitwise OR of the 10721999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * CXSaveTranslationUnit_XXX flags. 10731999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 107439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \returns A value that will match one of the enumerators of the CXSaveError 107539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * enumeration. Zero (CXSaveError_None) indicates that the translation unit was 107639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * saved successfully, while a non-zero value indicates that a problem occurred. 10777ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor */ 10787ae2faafd30524ef5f863bb3b8701977888839bbDouglas GregorCINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU, 10791999844e7a18786e61e619e1dc6c789827541863Douglas Gregor const char *FileName, 10801999844e7a18786e61e619e1dc6c789827541863Douglas Gregor unsigned options); 10817ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 10827ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor/** 10835352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Destroy the specified CXTranslationUnit object. 10845352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 10855352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit); 1086896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 10875352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 1088e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Flags that control the reparsing of translation units. 1089e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1090e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 1091e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * ORed together to specify which options should be used when 1092e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * reparsing the translation unit. 1093e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1094e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregorenum CXReparse_Flags { 1095e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 1096e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that no special reparsing options are needed. 1097e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1098e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXReparse_None = 0x0 1099e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor}; 1100e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 1101e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 1102e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Returns the set of flags that is suitable for reparsing a translation 1103e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * unit. 1104e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1105e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The set of flags returned provide options for 1106e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \c clang_reparseTranslationUnit() by default. The returned flag 1107e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * set contains an unspecified set of optimizations geared toward common uses 1108e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * of reparsing. The set of optimizations enabled may change from one version 1109e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * to the next. 1110e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1111e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU); 1112e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 1113e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 1114abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \brief Reparse the source files that produced this translation unit. 1115abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1116abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * This routine can be used to re-parse the source files that originally 1117abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * created the given translation unit, for example because those source files 1118abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * have changed (either on disk or as passed via \p unsaved_files). The 1119abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * source code will be reparsed with the same command-line options as it 1120abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * was originally parsed. 1121abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1122abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * Reparsing a translation unit invalidates all cursors and source locations 1123abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * that refer into that translation unit. This makes reparsing a translation 1124abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit semantically equivalent to destroying the translation unit and then 1125abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * creating a new translation unit with the same command-line arguments. 1126abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * However, it may be more efficient to reparse a translation 1127abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit using this routine. 1128abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1129abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param TU The translation unit whose contents will be re-parsed. The 1130abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * translation unit must originally have been built with 1131abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_createTranslationUnitFromSourceFile(). 1132abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1133abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 1134abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unsaved_files. 1135abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1136abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param unsaved_files The files that have not yet been saved to disk 1137abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * but may be required for parsing, including the contents of 1138abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * those files. The contents and name of these files (as specified by 1139abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 1140abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * guarantee their validity until the call to this function returns. 1141abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1142e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \param options A bitset of options composed of the flags in CXReparse_Flags. 1143e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The function \c clang_defaultReparseOptions() produces a default set of 1144e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * options recommended for most uses, based on the translation unit. 1145e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1146abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \returns 0 if the sources could be reparsed. A non-zero value will be 1147abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * returned if reparsing was impossible, such that the translation unit is 1148abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * invalid. In such cases, the only valid call for \p TU is 1149abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_disposeTranslationUnit(TU). 1150abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor */ 1151abc563f554951259bbe0315055cad92ee14d87e4Douglas GregorCINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU, 1152abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned num_unsaved_files, 1153e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor struct CXUnsavedFile *unsaved_files, 1154e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor unsigned options); 115559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 115659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 115759fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Categorizes how memory is being used by a translation unit. 115859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1159f787002478f09af1741fb0f82a562002e6799c49Ted Kremenekenum CXTUResourceUsageKind { 1160f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_AST = 1, 1161f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_Identifiers = 2, 1162f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_Selectors = 3, 1163f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_GlobalCompletionResults = 4, 1164457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek CXTUResourceUsage_SourceManagerContentCache = 5, 1165ba29bd25515fbd99e98ba0fedb9d93617b27609eTed Kremenek CXTUResourceUsage_AST_SideTables = 6, 1166f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7, 1167e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_SourceManager_Membuffer_MMap = 8, 1168e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9, 1169e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10, 11705e1db6a434d0e3fe0fbde0bca2ec44552818fb22Ted Kremenek CXTUResourceUsage_Preprocessor = 11, 11715e1db6a434d0e3fe0fbde0bca2ec44552818fb22Ted Kremenek CXTUResourceUsage_PreprocessingRecord = 12, 1172ca7dc2b755eb81ac95121ce1a1f1aa44a4a0fe12Ted Kremenek CXTUResourceUsage_SourceManager_DataStructures = 13, 1173d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Preprocessor_HeaderSearch = 14, 1174f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST, 1175f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_MEMORY_IN_BYTES_END = 1176d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Preprocessor_HeaderSearch, 1177f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek 1178f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_First = CXTUResourceUsage_AST, 1179d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch 118059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek}; 118159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 118259fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 118359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Returns the human-readable null-terminated C string that represents 1184f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek * the name of the memory category. This string should never be freed. 118559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 118659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted KremenekCINDEX_LINKAGE 1187f787002478f09af1741fb0f82a562002e6799c49Ted Kremenekconst char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind); 118859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1189f787002478f09af1741fb0f82a562002e6799c49Ted Kremenektypedef struct CXTUResourceUsageEntry { 119059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief The memory usage category. */ 1191f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek enum CXTUResourceUsageKind kind; 1192f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek /* \brief Amount of resources used. 1193f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek The units will depend on the resource kind. */ 119459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek unsigned long amount; 1195f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek} CXTUResourceUsageEntry; 119659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 119759fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 119859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief The memory usage of a CXTranslationUnit, broken into categories. 119959fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1200f787002478f09af1741fb0f82a562002e6799c49Ted Kremenektypedef struct CXTUResourceUsage { 120159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief Private data member, used for queries. */ 120259fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek void *data; 120359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 120459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief The number of entries in the 'entries' array. */ 120559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek unsigned numEntries; 120659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 120759fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief An array of key-value pairs, representing the breakdown of memory 120859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek usage. */ 1209f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsageEntry *entries; 121059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1211f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek} CXTUResourceUsage; 121259fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 121359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 121459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Return the memory usage of a translation unit. This object 1215f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek * should be released with clang_disposeCXTUResourceUsage(). 121659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1217f787002478f09af1741fb0f82a562002e6799c49Ted KremenekCINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU); 121859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1219f787002478f09af1741fb0f82a562002e6799c49Ted KremenekCINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage); 122059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1221abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor/** 12225352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 12235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 1224896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 12255352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 1226c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes the kind of entity that a cursor refers to. 1227c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1228c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXCursorKind { 1229c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Declarations */ 12301efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1231c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A declaration whose specific kind is not exposed via this 12321efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 1233c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1234c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed declarations have the same operations as any other kind 1235c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of declaration; one can extract their location information, 1236c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, find their definitions, etc. However, the specific kind 1237c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of the declaration is not reported. 1238c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1239c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedDecl = 1, 1240c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ struct. */ 12411efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_StructDecl = 2, 1242c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ union. */ 1243c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnionDecl = 3, 1244c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C++ class. */ 1245c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ClassDecl = 4, 1246c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumeration. */ 1247c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumDecl = 5, 12481efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1249c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A field (in C) or non-static data member (in C++) in a 1250c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * struct, union, or C++ class. 1251c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1252c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FieldDecl = 6, 1253c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumerator constant. */ 1254c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumConstantDecl = 7, 1255c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function. */ 1256c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FunctionDecl = 8, 1257c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A variable. */ 1258c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_VarDecl = 9, 1259c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function or method parameter. */ 1260c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ParmDecl = 10, 1261c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @interface. */ 1262c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInterfaceDecl = 11, 1263c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @interface for a category. */ 1264c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryDecl = 12, 1265c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @protocol declaration. */ 1266c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolDecl = 13, 1267c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @property declaration. */ 1268c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCPropertyDecl = 14, 1269c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance variable. */ 1270c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCIvarDecl = 15, 1271c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance method. */ 1272c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInstanceMethodDecl = 16, 1273c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C class method. */ 1274c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassMethodDecl = 17, 1275c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @implementation. */ 1276c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCImplementationDecl = 18, 1277c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @implementation for a category. */ 1278c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryImplDecl = 19, 1279c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A typedef */ 1280c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypedefDecl = 20, 12818bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek /** \brief A C++ class method. */ 12828bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek CXCursor_CXXMethod = 21, 12838f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek /** \brief A C++ namespace. */ 12848f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek CXCursor_Namespace = 22, 1285a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek /** \brief A linkage specification, e.g. 'extern "C"'. */ 1286a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek CXCursor_LinkageSpec = 23, 128701829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ constructor. */ 128801829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Constructor = 24, 128901829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ destructor. */ 129001829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Destructor = 25, 129101829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ conversion function. */ 129201829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_ConversionFunction = 26, 1293fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template type parameter. */ 1294fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTypeParameter = 27, 1295fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ non-type template parameter. */ 1296fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_NonTypeTemplateParameter = 28, 1297fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template template parameter. */ 1298fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTemplateParameter = 29, 1299fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ function template. */ 1300fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_FunctionTemplate = 30, 130139d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor /** \brief A C++ class template. */ 130239d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor CXCursor_ClassTemplate = 31, 130374dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor /** \brief A C++ class template partial specialization. */ 130474dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor CXCursor_ClassTemplatePartialSpecialization = 32, 13056931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** \brief A C++ namespace alias declaration. */ 13066931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceAlias = 33, 13070a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor /** \brief A C++ using directive. */ 13080a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor CXCursor_UsingDirective = 34, 1309162e1c1b487352434552147967c3dd296ebee2f7Richard Smith /** \brief A C++ using declaration. */ 13107e24256c95afb64b4d5abf201a0f9f0527cb4cf3Douglas Gregor CXCursor_UsingDeclaration = 35, 1311162e1c1b487352434552147967c3dd296ebee2f7Richard Smith /** \brief A C++ alias declaration */ 1312162e1c1b487352434552147967c3dd296ebee2f7Richard Smith CXCursor_TypeAliasDecl = 36, 1313352697a87bca664356f21a838b162084013625eaDouglas Gregor /** \brief An Objective-C @synthesize definition. */ 1314352697a87bca664356f21a838b162084013625eaDouglas Gregor CXCursor_ObjCSynthesizeDecl = 37, 1315352697a87bca664356f21a838b162084013625eaDouglas Gregor /** \brief An Objective-C @dynamic definition. */ 1316352697a87bca664356f21a838b162084013625eaDouglas Gregor CXCursor_ObjCDynamicDecl = 38, 13172dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis /** \brief An access specifier. */ 13182dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis CXCursor_CXXAccessSpecifier = 39, 131942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 132050aa6acd0b8d40c8956372a69e0a73f0802a5494Ted Kremenek CXCursor_FirstDecl = CXCursor_UnexposedDecl, 13212dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis CXCursor_LastDecl = CXCursor_CXXAccessSpecifier, 13221efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1323c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* References */ 1324c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstRef = 40, /* Decl references */ 13251efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_ObjCSuperClassRef = 40, 1326c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolRef = 41, 1327c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassRef = 42, 1328c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1329c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A reference to a type declaration. 1330c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1331c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A type reference occurs anywhere where a type is named but not 1332c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * declared. For example, given: 1333c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1334c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \code 1335c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * typedef unsigned size_type; 1336c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * size_type size; 1337c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \endcode 1338c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1339c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The typedef is a declaration of size_type (CXCursor_TypedefDecl), 1340c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * while the type of the variable "size" is referenced. The cursor 1341c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * referenced by the type of size is the typedef for size_type. 1342c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1343c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypeRef = 43, 13443064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CXCursor_CXXBaseSpecifier = 44, 13450b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor /** 1346a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * \brief A reference to a class template, function template, template 1347a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * template parameter, or class template partial specialization. 13480b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor */ 13490b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor CXCursor_TemplateRef = 45, 13506931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** 13516931900f43cea558c6974075256c07728dbfecc6Douglas Gregor * \brief A reference to a namespace or namespace alias. 13526931900f43cea558c6974075256c07728dbfecc6Douglas Gregor */ 13536931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceRef = 46, 1354a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor /** 135536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a member of a struct, union, or class that occurs in 135636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * some non-expression context, e.g., a designated initializer. 1357a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor */ 1358a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor CXCursor_MemberRef = 47, 135936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** 136036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a labeled statement. 136136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 136236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the jump to "start_over" in the 136336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto statement in the following example: 136436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 136536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 136636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 136736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 136836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 136936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto start_over; 137036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 137136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 137236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * A label reference cursor refers to a label statement. 137336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 137436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelRef = 48, 137536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 13761f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor /** 13771f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief A reference to a set of overloaded functions or function templates 13781f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * that has not yet been resolved to a specific function or function template. 13791f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 13801f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * An overloaded declaration reference cursor occurs in C++ templates where 13811f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * a dependent name refers to a function. For example: 13821f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 13831f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \code 13841f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> void swap(T&, T&); 13851f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 13861f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct X { ... }; 13871f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(X&, X&); 13881f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 13891f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> 13901f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void reverse(T* first, T* last) { 13911f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * while (first < last - 1) { 13921f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * swap(*first, *--last); 13931f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * ++first; 13941f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 13951f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 13961f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 13971f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct Y { }; 13981f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(Y&, Y&); 13991f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \endcode 14001f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14011f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * Here, the identifier "swap" is associated with an overloaded declaration 14021f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * reference. In the template definition, "swap" refers to either of the two 14031f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * "swap" functions declared above, so both results will be available. At 14041f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * instantiation time, "swap" may also refer to other functions found via 14051f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * argument-dependent lookup (e.g., the "swap" function at the end of the 14061f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * example). 14071f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14081f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * The functions \c clang_getNumOverloadedDecls() and 14091f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c clang_getOverloadedDecl() can be used to retrieve the definitions 14101f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * referenced by this cursor. 14111f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 14121f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor CXCursor_OverloadedDeclRef = 49, 14131f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 14141f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor CXCursor_LastRef = CXCursor_OverloadedDeclRef, 14151efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1416c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Error conditions */ 1417c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstInvalid = 70, 1418c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_InvalidFile = 70, 1419c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NoDeclFound = 71, 1420c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NotImplemented = 72, 1421ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_InvalidCode = 73, 1422ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_LastInvalid = CXCursor_InvalidCode, 14231efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1424c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Expressions */ 1425c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstExpr = 100, 14261efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1427c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1428c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression whose specific kind is not exposed via this 14291efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 1430c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1431c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed expressions have the same operations as any other kind 1432c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of expression; one can extract their location information, 1433c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, children, etc. However, the specific kind of the 1434c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * expression is not reported. 1435c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1436c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedExpr = 100, 14371efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1438c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1439c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to some value declaration, such 1440c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * as a function, varible, or enumerator. 1441c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1442c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_DeclRefExpr = 101, 14431efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1444c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1445c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to a member of a struct, union, 1446c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * class, Objective-C class, etc. 1447c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1448c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_MemberRefExpr = 102, 14491efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1450c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that calls a function. */ 1451c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_CallExpr = 103, 14521efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1453c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that sends a message to an Objective-C 1454c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor object or class. */ 1455c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCMessageExpr = 104, 14561ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 14571ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek /** \brief An expression that represents a block literal. */ 14581ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek CXCursor_BlockExpr = 105, 14591ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 146042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An integer literal. 146142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 146242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_IntegerLiteral = 106, 146342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 146442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A floating point number literal. 146542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 146642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_FloatingLiteral = 107, 146742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 146842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An imaginary number literal. 146942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 147042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ImaginaryLiteral = 108, 147142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 147242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A string literal. 147342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 147442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_StringLiteral = 109, 147542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 147642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A character literal. 147742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 147842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CharacterLiteral = 110, 147942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 148042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A parenthesized expression, e.g. "(1)". 148142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 148242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This AST node is only formed if full location information is requested. 148342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 148442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ParenExpr = 111, 148542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 148642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief This represents the unary-expression's (except sizeof and 148742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * alignof). 148842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 148942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_UnaryOperator = 112, 149042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 149142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C99 6.5.2.1] Array Subscripting. 149242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 149342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ArraySubscriptExpr = 113, 149442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 149542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A builtin binary operation expression such as "x + y" or 149642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * "x <= y". 149742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 149842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_BinaryOperator = 114, 149942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 150042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Compound assignment such as "+=". 150142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 150242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CompoundAssignOperator = 115, 150342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 150442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief The ?: ternary operator. 150542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 150642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ConditionalOperator = 116, 150742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 150842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++ 150942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * (C++ [expr.cast]), which uses the syntax (Type)expr. 151042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 151142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * For example: (int)f. 151242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 151342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CStyleCastExpr = 117, 151442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 151542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C99 6.5.2.5] 151642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 151742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CompoundLiteralExpr = 118, 151842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 151942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Describes an C or C++ initializer list. 152042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 152142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_InitListExpr = 119, 152242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 152342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief The GNU address of label extension, representing &&label. 152442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 152542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_AddrLabelExpr = 120, 152642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 152742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief This is the GNU Statement Expression extension: ({int X=4; X;}) 152842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 152942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_StmtExpr = 121, 153042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 153142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents a C1X generic selection. 153242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 153342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_GenericSelectionExpr = 122, 153442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 153542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Implements the GNU __null extension, which is a name for a null 153642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * pointer constant that has integral type (e.g., int or long) and is the same 153742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * size and alignment as a pointer. 153842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 153942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * The __null extension is typically only used by system headers, which define 154042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * NULL as __null in C++ rather than using 0 (which is an integer that may not 154142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * match the size of a pointer). 154242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 154342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_GNUNullExpr = 123, 154442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 154542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s static_cast<> expression. 154642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 154742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXStaticCastExpr = 124, 154842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 154942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s dynamic_cast<> expression. 155042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 155142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXDynamicCastExpr = 125, 155242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 155342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s reinterpret_cast<> expression. 155442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 155542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXReinterpretCastExpr = 126, 155642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 155742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s const_cast<> expression. 155842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 155942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXConstCastExpr = 127, 156042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 156142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents an explicit C++ type conversion that uses "functional" 156242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * notion (C++ [expr.type.conv]). 156342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 156442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * Example: 156542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 156642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * x = int(0.5); 156742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 156842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 156942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXFunctionalCastExpr = 128, 157042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 157142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A C++ typeid expression (C++ [expr.typeid]). 157242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 157342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXTypeidExpr = 129, 157442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 157542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C++ 2.13.5] C++ Boolean Literal. 157642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 157742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXBoolLiteralExpr = 130, 157842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 157942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C++0x 2.14.7] C++ Pointer Literal. 158042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 158142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXNullPtrLiteralExpr = 131, 158242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 158342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents the "this" expression in C++ 158442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 158542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXThisExpr = 132, 158642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 158742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C++ 15] C++ Throw Expression. 158842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 158942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This handles 'throw' and 'throw' assignment-expression. When 159042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * assignment-expression isn't present, Op will be null. 159142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 159242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXThrowExpr = 133, 159342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 159442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A new expression for memory allocation and constructor calls, e.g: 159542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * "new CXXNewExpr(foo)". 159642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 159742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXNewExpr = 134, 159842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 159942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A delete expression for memory deallocation and destructor calls, 160042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * e.g. "delete[] pArray". 160142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 160242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXDeleteExpr = 135, 160342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 160442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A unary expression. 160542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 160642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_UnaryExpr = 136, 160742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 160842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief ObjCStringLiteral, used for Objective-C string literals i.e. "foo". 160942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 161042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCStringLiteral = 137, 161142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 161242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief ObjCEncodeExpr, used for in Objective-C. 161342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 161442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCEncodeExpr = 138, 161542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 161642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief ObjCSelectorExpr used for in Objective-C. 161742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 161842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCSelectorExpr = 139, 161942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 162042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's protocol expression. 162142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 162242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCProtocolExpr = 140, 162342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 162442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An Objective-C "bridged" cast expression, which casts between 162542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * Objective-C pointers and C pointers, transferring ownership in the process. 162642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 162742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 162842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * NSString *str = (__bridge_transfer NSString *)CFCreateString(); 162942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 163042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 163142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCBridgedCastExpr = 141, 163242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 163342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents a C++0x pack expansion that produces a sequence of 163442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * expressions. 163542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 163642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * A pack expansion expression contains a pattern (which itself is an 163742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * expression) followed by an ellipsis. For example: 163842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 163942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 164042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * template<typename F, typename ...Types> 164142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * void forward(F f, Types &&...args) { 164242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * f(static_cast<Types&&>(args)...); 164342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * } 164442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 164542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 164642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_PackExpansionExpr = 142, 164742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 164842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents an expression that computes the length of a parameter 164942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * pack. 165042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 165142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 165242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * template<typename ...Types> 165342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * struct count { 165442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * static const unsigned value = sizeof...(Types); 165542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * }; 165642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 165742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 165842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SizeOfPackExpr = 143, 165942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 166042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_LastExpr = CXCursor_SizeOfPackExpr, 16611efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1662c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Statements */ 1663c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstStmt = 200, 1664c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1665c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A statement whose specific kind is not exposed via this 1666c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * interface. 1667c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1668c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed statements have the same operations as any other kind of 1669c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * statement; one can extract their location information, spelling, 1670c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * children, etc. However, the specific kind of the statement is not 1671c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reported. 1672c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1673c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedStmt = 200, 167436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 167536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** \brief A labelled statement in a function. 167636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 167736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the "start_over:" label statement in 167836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * the following example: 167936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 168036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 168136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 168236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 168336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 168436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 168536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 168636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelStmt = 201, 168742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 168842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A group of statements like { stmt stmt }. 168942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 169042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This cursor kind is used to describe compound statements, e.g. function 169142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * bodies. 169242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 169342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CompoundStmt = 202, 169442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 169542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A case statment. 169642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 169742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CaseStmt = 203, 169842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 169942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A default statement. 170042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 170142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_DefaultStmt = 204, 170242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 170342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An if statement 170442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 170542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_IfStmt = 205, 170642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 170742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A switch statement. 170842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 170942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SwitchStmt = 206, 171042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 171142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A while statement. 171242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 171342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_WhileStmt = 207, 171442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 171542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A do statement. 171642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 171742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_DoStmt = 208, 171842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 171942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A for statement. 172042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 172142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ForStmt = 209, 172242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 172342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A goto statement. 172442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 172542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_GotoStmt = 210, 172642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 172742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An indirect goto statement. 172842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 172942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_IndirectGotoStmt = 211, 173042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 173142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A continue statement. 173242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 173342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ContinueStmt = 212, 173442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 173542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A break statement. 173642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 173742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_BreakStmt = 213, 173842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 173942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A return statement. 174042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 174142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ReturnStmt = 214, 174242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 174342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A GNU inline assembly statement extension. 174442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 174542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_AsmStmt = 215, 174642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 174742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's overall @try-@catc-@finall statement. 174842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 174942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtTryStmt = 216, 175042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 175142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's @catch statement. 175242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 175342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtCatchStmt = 217, 175442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 175542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's @finally statement. 175642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 175742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtFinallyStmt = 218, 175842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 175942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's @throw statement. 176042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 176142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtThrowStmt = 219, 176242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 176342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's @synchronized statement. 176442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 176542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtSynchronizedStmt = 220, 176642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 176742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's autorelease pool statement. 176842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 176942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAutoreleasePoolStmt = 221, 177042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 177142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's collection statement. 177242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 177342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCForCollectionStmt = 222, 177442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 177542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s catch statement. 177642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 177742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXCatchStmt = 223, 177842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 177942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s try statement. 178042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 178142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXTryStmt = 224, 178242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 178342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s for (* : *) statement. 178442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 178542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXForRangeStmt = 225, 178642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 178742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Windows Structured Exception Handling's try statement. 178842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 178942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SEHTryStmt = 226, 179042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 179142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Windows Structured Exception Handling's except statement. 179242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 179342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SEHExceptStmt = 227, 179442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 179542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Windows Structured Exception Handling's finally statement. 179642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 179742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SEHFinallyStmt = 228, 179842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 179942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief The null satement ";": C99 6.8.3p3. 180042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 180142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This cursor kind is used to describe the null statement. 180242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 180342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_NullStmt = 230, 180442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 180542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Adaptor class for mixing declarations with statements and 180642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * expressions. 180742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 180842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_DeclStmt = 231, 180942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 181042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_LastStmt = CXCursor_DeclStmt, 18111efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1812c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1813c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Cursor that represents the translation unit itself. 1814c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1815c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor exists primarily to act as the root 1816c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor for traversing the contents of a translation unit. 1817c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1818e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_TranslationUnit = 300, 1819e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1820e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /* Attributes */ 1821e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_FirstAttr = 400, 1822e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /** 1823e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * \brief An attribute whose specific kind is not exposed via this 1824e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * interface. 1825e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek */ 1826e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_UnexposedAttr = 400, 1827e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1828e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBActionAttr = 401, 1829e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBOutletAttr = 402, 1830857e918a8a40deb128840308a318bf623d68295fTed Kremenek CXCursor_IBOutletCollectionAttr = 403, 18316639e9255489ad8e10278d5658fdd4b3c0e1e4cdArgyrios Kyrtzidis CXCursor_CXXFinalAttr = 404, 18326639e9255489ad8e10278d5658fdd4b3c0e1e4cdArgyrios Kyrtzidis CXCursor_CXXOverrideAttr = 405, 18335f1c822def3efffe1d8f7299fbbbc3b1cdd4833dErik Verbruggen CXCursor_AnnotateAttr = 406, 18345f1c822def3efffe1d8f7299fbbbc3b1cdd4833dErik Verbruggen CXCursor_LastAttr = CXCursor_AnnotateAttr, 18359f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 18369f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor /* Preprocessing */ 18379f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_PreprocessingDirective = 500, 1838572feb2a190b5e8b04fb06c4ac50ee0f61e93ff0Douglas Gregor CXCursor_MacroDefinition = 501, 18399b2a0ac970a077bdc0bf08c6c682f80ad733c892Chandler Carruth CXCursor_MacroExpansion = 502, 18409b2a0ac970a077bdc0bf08c6c682f80ad733c892Chandler Carruth CXCursor_MacroInstantiation = CXCursor_MacroExpansion, 1841ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_InclusionDirective = 503, 18429f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective, 1843ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_LastPreprocessing = CXCursor_InclusionDirective 1844c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 1845c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1846c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1847c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A cursor representing some element in the abstract syntax tree for 1848c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a translation unit. 1849c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 18501efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor abstraction unifies the different kinds of entities in a 1851c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * program--declaration, statements, expressions, references to declarations, 1852c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * etc.--under a single "cursor" abstraction with a common set of operations. 1853c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Common operation for a cursor include: getting the physical location in 1854c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a source file where the cursor points, getting the name associated with a 1855c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor, and retrieving cursors for any child nodes of a particular cursor. 1856c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1857c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors can be produced in two specific ways. 1858c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_getTranslationUnitCursor() produces a cursor for a translation unit, 1859c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * from which one can use clang_visitChildren() to explore the rest of the 1860c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * translation unit. clang_getCursor() maps from a physical source location 1861c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to the entity that resides at that location, allowing one to map from the 1862c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * source code into the AST. 1863c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1864c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregortypedef struct { 1865c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor enum CXCursorKind kind; 1866aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis int xdata; 1867c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor void *data[3]; 18681efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar} CXCursor; 1869c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1870c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1871c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations 1872c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1873c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 1874c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 18751efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1876c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1877c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the NULL cursor, which represents no entity. 1878c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1879c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getNullCursor(void); 18801efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1881c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1882c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the cursor that represents the given translation unit. 1883c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1884c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor can be used to start traversing the 1885c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * various declarations within the given translation unit. 1886c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1887c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit); 1888c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1889c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1890c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether two cursors are equivalent. 1891c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1892c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor); 18931efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1894c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1895b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis * \brief Returns non-zero if \arg cursor is null. 1896b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis */ 1897fa865df489fe68668c554dece36c68b4ce03920fArgyrios Kyrtzidisint clang_Cursor_isNull(CXCursor); 1898b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis 1899b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis/** 19009ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor * \brief Compute a hash value for the given cursor. 19019ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor */ 19029ce5584553054d0cb934940586aca0186e87fa57Douglas GregorCINDEX_LINKAGE unsigned clang_hashCursor(CXCursor); 19039ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor 19049ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor/** 1905c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the kind of the given cursor. 1906c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1907c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor); 1908c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1909c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1910c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a declaration. 1911c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1912c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind); 1913c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1914c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1915c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a simple 1916c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reference. 1917c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1918c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Note that other kinds of cursors (such as expressions) can also refer to 1919c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * other cursors. Use clang_getCursorReferenced() to determine whether a 1920c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * particular cursor refers to another entity. 1921c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1922c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind); 1923c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1924c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1925c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents an expression. 1926c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1927c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind); 1928c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1929c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1930c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a statement. 1931c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1932c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind); 1933c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1934c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 19358be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor * \brief Determine whether the given cursor kind represents an attribute. 19368be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor */ 19378be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas GregorCINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind); 19388be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor 19398be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor/** 19401efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents an invalid 1941c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor. 19421efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar */ 1943c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind); 1944c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1945c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 19461efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents a translation 19471efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unit. 1948c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1949c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind); 19501efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1951ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek/*** 19529f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * \brief Determine whether the given cursor represents a preprocessing 19539f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * element, such as a preprocessor directive or macro instantiation. 19549f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor */ 19559f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas GregorCINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind); 19569f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 19579f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor/*** 1958ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * \brief Determine whether the given cursor represents a currently 1959ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt). 1960ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek */ 1961ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted KremenekCINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind); 1962ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek 1963c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 196416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief Describe the linkage of the entity referred to by a cursor. 196516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 196616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenekenum CXLinkageKind { 196716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This value indicates that no linkage information is available 196816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * for a provided CXCursor. */ 196916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Invalid, 197016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** 197116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief This is the linkage for variables, parameters, and so on that 197216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * have automatic storage. This covers normal (non-extern) local variables. 197316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 197416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_NoLinkage, 197516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for static variables and static functions. */ 197616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Internal, 197716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with external linkage that live 197816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * in C++ anonymous namespaces.*/ 197916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_UniqueExternal, 198016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with true, external linkage. */ 198116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_External 198216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek}; 198316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 198416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 198545e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the linkage of the entity referred to by a given cursor. 198616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 198716b4259aecaa22b642d35d36fd89965ed700c1e0Ted KremenekCINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor); 198816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 198916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 199058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \brief Determine the availability of the entity that this cursor refers to. 199158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 199258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param cursor The cursor to query. 199358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 199458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the cursor. 199558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 199658ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 199758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCursorAvailability(CXCursor cursor); 199858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 199958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 200045e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Describe the "language" of the entity referred to by a cursor. 200145e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 200245e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind { 20036cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_Invalid = 0, 200445e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_C, 200545e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_ObjC, 20066cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_CPlusPlus 200745e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek}; 200845e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 200945e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 201045e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the "language" of the entity referred to by a given cursor. 201145e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 201245e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor); 201345e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 2014b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis/** 2015b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis * \brief Returns the translation unit that a cursor originated from. 2016b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis */ 2017b0d6eaa6b646c18c49923aefc76973801f561701Argyrios KyrtzidisCINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor); 2018b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis 2019eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2020eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2021eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief A fast container representing a set of CXCursors. 2022eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 2023eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenektypedef struct CXCursorSetImpl *CXCursorSet; 2024eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2025eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2026eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Creates an empty CXCursorSet. 2027eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 2028eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(); 2029eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2030eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2031eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Disposes a CXCursorSet and releases its associated memory. 2032eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 2033eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset); 2034eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2035eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2036eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Queries a CXCursorSet to see if it contains a specific CXCursor. 2037eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * 2038eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \returns non-zero if the set contains the specified cursor. 2039eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek*/ 2040eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset, 2041eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek CXCursor cursor); 2042eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2043eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2044eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Inserts a CXCursor into a CXCursorSet. 2045eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * 2046eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \returns zero if the CXCursor was already in the set, and non-zero otherwise. 2047eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek*/ 2048eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset, 2049eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek CXCursor cursor); 2050eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 20512be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 20522be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the semantic parent of the given cursor. 20532be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 20542be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The semantic parent of a cursor is the cursor that semantically contains 20552be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the given \p cursor. For many declarations, the lexical and semantic parents 20562be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the lexical parent is returned by 20572be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorLexicalParent()). They diverge when declarations or 20582be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 20592be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 20602be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 20612be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 20622be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 20632be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 20642be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 20652be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 20662be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 20672be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 20682be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 20692be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 20702be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 20712be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 20722be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 20732be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 20742be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 20752be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 20762be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 20772be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 20782be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 20792be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 20802be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 20813910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * 20823910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * For global declarations, the semantic parent is the translation unit. 20832be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 20842be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor); 20852be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor 20862be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 20872be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the lexical parent of the given cursor. 20882be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 20892be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The lexical parent of a cursor is the cursor in which the given \p cursor 20902be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * was actually written. For many declarations, the lexical and semantic parents 20912be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the semantic parent is returned by 20922be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorSemanticParent()). They diverge when declarations or 20932be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 20942be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 20952be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 20962be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 20972be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 20982be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 20992be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21002be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 21012be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 21022be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21032be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 21042be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 21052be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 21062be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 21072be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 21082be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 21092be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 21102be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 21112be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 21122be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21132be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 21142be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 21152be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 21163910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * 21173910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * For declarations written in the global scope, the lexical parent is 21183910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * the translation unit. 21192be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 21202be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor); 21219f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 21229f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 21239f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Determine the set of methods that are overridden by the given 21249f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. 21259f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 21269f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In both Objective-C and C++, a method (aka virtual member function, 21279f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * in C++) can override a virtual method in a base class. For 21289f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * Objective-C, a method is said to override any method in the class's 21299f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * interface (if we're coming from an implementation), its protocols, 21309f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * or its categories, that has the same selector and is of the same 21319f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * kind (class or instance). If no such method exists, the search 21329f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * continues to the class's superclass, its protocols, and its 21339f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * categories, and so on. 21349f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 21359f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * For C++, a virtual member function overrides any virtual member 21369f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * function with the same signature that occurs in its base 21379f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * classes. With multiple inheritance, a virtual member function can 21389f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * override several virtual member functions coming from different 21399f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * base classes. 21409f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 21419f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In all cases, this function determines the immediate overridden 21429f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method, rather than all of the overridden methods. For example, if 21439f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * a method is originally declared in a class A, then overridden in B 21449f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * (which in inherits from A) and also in C (which inherited from B), 21459f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * then the only overridden method returned from this function when 21469f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoked on C's method will be B's method. The client may then 21479f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoke this function again, given the previously-found overridden 21489f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods, to map out the complete method-override set. 21499f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 21509f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param cursor A cursor representing an Objective-C or C++ 21519f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. This routine will compute the set of methods that this 21529f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method overrides. 21539f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 21549f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param overridden A pointer whose pointee will be replaced with a 21559f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * pointer to an array of cursors, representing the set of overridden 21569f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods. If there are no overridden methods, the pointee will be 21579f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * set to NULL. The pointee must be freed via a call to 21589f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \c clang_disposeOverriddenCursors(). 21599f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 21609f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param num_overridden A pointer to the number of overridden 21619f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * functions, will be set to the number of overridden functions in the 21629f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * array pointed to by \p overridden. 21639f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 21649f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor, 21659f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor CXCursor **overridden, 21669f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor unsigned *num_overridden); 21679f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 21689f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 21699f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Free the set of overridden cursors returned by \c 21709f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * clang_getOverriddenCursors(). 21719f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 21729f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden); 21739f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 217445e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 2175ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * \brief Retrieve the file that is included by the given inclusion directive 2176ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * cursor. 2177ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor */ 2178ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas GregorCINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor); 2179ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor 2180ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor/** 2181c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2182c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 21831efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2184c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2185c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code 2186c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2187c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors represent a location within the Abstract Syntax Tree (AST). These 2188c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines help map between cursors and the physical locations where the 2189c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * described entities occur in the source code. The mapping is provided in 2190c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * both directions, so one can map from source code to the AST and back. 2191c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2192c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 219350398199fb10e196a8d92fbf7a062dbe42ed88fdSteve Naroff */ 21941efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 21956a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff/** 2196b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Map a source location to the cursor that describes the entity at that 2197b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * location in the source code. 2198b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 2199b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() maps an arbitrary source location within a translation 2200b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * unit down to the most specific cursor that describes the entity at that 22011efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * location. For example, given an expression \c x + y, invoking 2202b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() with a source location pointing to "x" will return the 22031efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * cursor for "x"; similarly for "y". If the cursor points anywhere between 2204b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor() 2205b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * will return a cursor referring to the "+" expression. 2206b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 2207b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns a cursor representing the entity at the given source location, or 2208b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * a NULL cursor if no such entity can be found. 22096a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff */ 2210b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation); 22111efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 221298258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor/** 221398258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * \brief Retrieve the physical location of the source constructor referenced 221498258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * by the given cursor. 221598258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * 221698258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * The location of a declaration is typically the location of the name of that 22171efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * declaration, where the name of that declaration would occur if it is 22181efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unnamed, or some keyword that introduces that particular declaration. 22191efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The location of a reference is where that reference occurs within the 222098258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * source code. 222198258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor */ 222298258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor); 2223c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2224b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor/** 2225b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Retrieve the physical extent of the source construct referenced by 2226a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the given cursor. 2227a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * 2228a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * The extent of a cursor starts with the file/line/column pointing at the 2229a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * first character within the source construct that the cursor refers to and 22301efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * ends with the last character withinin that source construct. For a 2231a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * declaration, the extent covers the declaration itself. For a reference, 2232a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the extent covers the location of the reference (e.g., where the referenced 2233a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * entity was actually used). 2234a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor */ 2235a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas GregorCINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor); 2236c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor 2237c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2238c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2239c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 224095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 2241c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 22428e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \defgroup CINDEX_TYPES Type information for CXCursors 22438e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 22448e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @{ 22458e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 22468e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 22478e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 22488e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Describes the kind of type 22498e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 22508e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenekenum CXTypeKind { 22518e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 22528e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Reprents an invalid type (e.g., where no type is available). 22538e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 22548e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Invalid = 0, 22558e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 22568e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 22578e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief A type whose specific kind is not exposed via this 22588e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * interface. 22598e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 22608e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Unexposed = 1, 22618e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 22628e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /* Builtin types */ 22638e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Void = 2, 22648e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Bool = 3, 22658e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_U = 4, 22668e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UChar = 5, 22678e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char16 = 6, 22688e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char32 = 7, 22698e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UShort = 8, 22708e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt = 9, 22718e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULong = 10, 22728e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULongLong = 11, 22738e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt128 = 12, 22748e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_S = 13, 22758e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_SChar = 14, 22768e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_WChar = 15, 22778e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Short = 16, 22788e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int = 17, 22798e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Long = 18, 22808e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongLong = 19, 22818e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int128 = 20, 22828e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Float = 21, 22838e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Double = 22, 22848e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongDouble = 23, 22858e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_NullPtr = 24, 22868e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Overload = 25, 22878e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Dependent = 26, 22888e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCId = 27, 22898e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCClass = 28, 22908e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCSel = 29, 22918e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_FirstBuiltin = CXType_Void, 22928e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LastBuiltin = CXType_ObjCSel, 22938e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 22948e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Complex = 100, 22958e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Pointer = 101, 22968e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_BlockPointer = 102, 22978e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LValueReference = 103, 22988e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_RValueReference = 104, 22998e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Record = 105, 23008e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Enum = 106, 23018e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Typedef = 107, 23028e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCInterface = 108, 230304c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_ObjCObjectPointer = 109, 230404c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_FunctionNoProto = 110, 23055f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis CXType_FunctionProto = 111, 23065f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis CXType_ConstantArray = 112 23078e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek}; 23088e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23098e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 23108e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief The type of an element in the abstract syntax tree. 23118e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 23128e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23138e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenektypedef struct { 23148e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek enum CXTypeKind kind; 23158e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek void *data[2]; 23168e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek} CXType; 23178e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23188e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 23198e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the type of a CXCursor (if any). 23208e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23218e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCursorType(CXCursor C); 23228e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23238e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 23248e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \determine Determine whether two CXTypes represent the same type. 23258e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 23268e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \returns non-zero if the CXTypes represent the same type and 23278e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek zero otherwise. 23288e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23298e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B); 23308e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23318e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 23328e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the canonical type for a CXType. 23338e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 23348e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * Clang's type system explicitly models typedefs and all the ways 23358e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * a specific type can be represented. The canonical type is the underlying 23368e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * type with all the "sugar" removed. For example, if 'T' is a typedef 23378e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * for 'int', the canonical type for 'T' would be 'int'. 23388e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23398e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCanonicalType(CXType T); 23408e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23418e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 2342e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * \determine Determine whether a CXType has the "const" qualifier set, 2343e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * without looking through typedefs that may have added "const" at a different level. 2344e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 2345e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T); 2346e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 2347e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 2348e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * \determine Determine whether a CXType has the "volatile" qualifier set, 2349e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * without looking through typedefs that may have added "volatile" at a different level. 2350e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 2351e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T); 2352e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 2353e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 2354e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * \determine Determine whether a CXType has the "restrict" qualifier set, 2355e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * without looking through typedefs that may have added "restrict" at a different level. 2356e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 2357e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T); 2358e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 2359e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 23608e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief For pointer types, returns the type of the pointee. 23618e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 23628e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23638e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getPointeeType(CXType T); 23648e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23658e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 23668e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the cursor for the declaration of the given type. 23678e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23688e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T); 23698e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23705389f48b24937ad7b4093307128b3cbf25235654David Chisnall/** 23715389f48b24937ad7b4093307128b3cbf25235654David Chisnall * Returns the Objective-C type encoding for the specified declaration. 23725389f48b24937ad7b4093307128b3cbf25235654David Chisnall */ 23735389f48b24937ad7b4093307128b3cbf25235654David ChisnallCINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C); 23748e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23758e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 23768e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the spelling of a given CXTypeKind. 23778e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23788e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K); 23798e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23808e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 23819a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * \brief Retrieve the result type associated with a function type. 238204c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek */ 238304c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted KremenekCINDEX_LINKAGE CXType clang_getResultType(CXType T); 238404c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek 238504c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek/** 23869a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * \brief Retrieve the result type associated with a given cursor. This only 23879a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * returns a valid type of the cursor refers to a function or method. 23889a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek */ 23899a140845438c2fc31e7d48a6dedbc695f4c83c68Ted KremenekCINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C); 23909a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek 23919a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek/** 23923ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * \brief Return 1 if the CXType is a POD (plain old data) type, and 0 23933ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * otherwise. 23943ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek */ 23953ce9e7d270e7df86c09c8126b4412d55be7c123bTed KremenekCINDEX_LINKAGE unsigned clang_isPODType(CXType T); 23963ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek 23973ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek/** 23985f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * \brief Return the element type of an array type. 23995f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * 24005f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * If a non-array type is passed in, an invalid type is returned. 24015f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis */ 24025f0bfc522266f3319c4a6262b016a552de058c7fArgyrios KyrtzidisCINDEX_LINKAGE CXType clang_getArrayElementType(CXType T); 24035f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis 24045f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis/** 24055f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * \brief Return the the array size of a constant array. 24065f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * 24075f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * If a non-array type is passed in, -1 is returned. 24085f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis */ 24095f0bfc522266f3319c4a6262b016a552de058c7fArgyrios KyrtzidisCINDEX_LINKAGE long long clang_getArraySize(CXType T); 24105f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis 24115f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis/** 24123064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns 1 if the base class specified by the cursor with kind 24133064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * CX_CXXBaseSpecifier is virtual. 24143064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 24153064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor); 24163064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 24173064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 24183064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Represents the C++ access control level to a base class for a 24193064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * cursor with kind CX_CXXBaseSpecifier. 24203064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 24213064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenekenum CX_CXXAccessSpecifier { 24223064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXInvalidAccessSpecifier, 24233064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPublic, 24243064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXProtected, 24253064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPrivate 24263064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek}; 24273064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 24283064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 24293064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns the access control level for the C++ base specifier 24302dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis * represented by a cursor with kind CXCursor_CXXBaseSpecifier or 24312dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis * CXCursor_AccessSpecifier. 24323064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 24333064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor); 24343064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 24353064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 24361f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Determine the number of overloaded declarations referenced by a 24371f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c CXCursor_OverloadedDeclRef cursor. 24381f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 24391f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 24401f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 24411f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns The number of overloaded declarations referenced by \c cursor. If it 24421f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0. 24431f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 24441f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor); 24451f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 24461f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 24471f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Retrieve a cursor for one of the overloaded declarations referenced 24481f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * by a \c CXCursor_OverloadedDeclRef cursor. 24491f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 24501f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 24511f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 24521f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param index The zero-based index into the set of overloaded declarations in 24531f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * the cursor. 24541f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 24551f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns A cursor representing the declaration referenced by the given 24561f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c cursor at the specified \c index. If the cursor does not have an 24571f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * associated set of overloaded declarations, or if the index is out of bounds, 24581f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * returns \c clang_getNullCursor(); 24591f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 24601f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor, 24611f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor unsigned index); 24621f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 24631f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 24648e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @} 24658e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 246695f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 246795f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 2468ad72f4dad4cf0fd2b71eb8f4704d2fe7ac58fb44Ted Kremenek * \defgroup CINDEX_ATTRIBUTES Information for attributes 246995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 247095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @{ 247195f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 247295f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 247395f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 247495f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 247595f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * \brief For cursors representing an iboutletcollection attribute, 247695f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * this function returns the collection element type. 247795f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 247895f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 247995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted KremenekCINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor); 248095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 248195f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 248295f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @} 248395f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 24848e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 24858e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 2486c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors 2487c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2488c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines provide the ability to traverse the abstract syntax tree 2489c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * using cursors. 2490c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2491c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2492c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 24931efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2494c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2495c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes how the traversal of the children of a particular 2496c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor should proceed after visiting a particular child cursor. 2497c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2498c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A value of this enumeration type should be returned by each 2499c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXCursorVisitor to indicate how clang_visitChildren() proceed. 2500c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2501c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXChildVisitResult { 2502c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 25031efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Terminates the cursor traversal. 2504c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2505c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Break, 25061efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 2507c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Continues the cursor traversal with the next sibling of 2508c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the cursor just visited, without visiting its children. 2509c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2510c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Continue, 2511c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 2512c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Recursively traverse the children of this cursor, using 2513c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the same visitor and client data. 2514c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2515c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Recurse 2516c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 2517c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2518c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2519c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visitor invoked for each cursor found by a traversal. 2520c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2521c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This visitor function will be invoked for each cursor found by 2522c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). Its first argument is the cursor being 2523c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited, its second argument is the parent visitor for that cursor, 2524c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and its third argument is the client data provided to 2525c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). 2526c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2527c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The visitor should return one of the \c CXChildVisitResult values 2528c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to direct clang_visitCursorChildren(). 2529c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 25301efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbartypedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor, 25311efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor parent, 2532c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 2533c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2534c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2535c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visit the children of a particular cursor. 2536c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2537c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This function visits all the direct children of the given cursor, 2538c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * invoking the given \p visitor function with the cursors of each 2539c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited child. The traversal may be recursive, if the visitor returns 2540c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if 2541c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the visitor returns \c CXChildVisit_Break. 2542c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2543c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param parent the cursor whose child may be visited. All kinds of 2544a57259e9d7b30bcce93f0a62eee0488738026172Daniel Dunbar * cursors can be visited, including invalid cursors (which, by 2545c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * definition, have no children). 2546c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2547c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param visitor the visitor function that will be invoked for each 2548c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * child of \p parent. 2549c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2550c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param client_data pointer data supplied by the client, which will 2551c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be passed to the visitor each time it is invoked. 2552c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2553c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \returns a non-zero value if the traversal was terminated 2554c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * prematurely by the visitor returning \c CXChildVisit_Break. 2555c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 25561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent, 2557c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursorVisitor visitor, 2558c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 25593387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#ifdef __has_feature 25603387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# if __has_feature(blocks) 25613387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 25623387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * \brief Visitor invoked for each cursor found by a traversal. 25633387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 25643387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * This visitor block will be invoked for each cursor found by 25653387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * clang_visitChildrenWithBlock(). Its first argument is the cursor being 25663387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * visited, its second argument is the parent visitor for that cursor. 25673387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 25683387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * The visitor should return one of the \c CXChildVisitResult values 25693387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * to direct clang_visitChildrenWithBlock(). 25703387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 25713387c65a094a02b2a94c05111d035a97d3d5c794David Chisnalltypedef enum CXChildVisitResult 25723387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent); 25733387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall 25743387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 25753387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * Visits the children of a cursor using the specified block. Behaves 25763387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * identically to clang_visitChildren() in all other respects. 25773387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 25783387c65a094a02b2a94c05111d035a97d3d5c794David Chisnallunsigned clang_visitChildrenWithBlock(CXCursor parent, 25793387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall CXCursorVisitorBlock block); 25803387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# endif 25813387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#endif 25821efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2583c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2584c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2585c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 25861efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2587c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2588c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST 2589c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 25901efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * These routines provide the ability to determine references within and 2591c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * across translation units, by providing the names of the entities referenced 2592c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by cursors, follow reference cursors to the declarations they reference, 2593c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and associate declarations with their definitions. 2594c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2595c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2596c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 25971efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2598c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2599c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced 2600c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by the given cursor. 2601c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2602c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A Unified Symbol Resolution (USR) is a string that identifies a particular 2603c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * entity (function, class, variable, etc.) within a program. USRs can be 2604c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * compared across translation units to determine, e.g., when references in 2605c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * one translation refer to an entity defined in another translation unit. 2606c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2607c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor); 2608c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2609c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2610896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C class. 2611896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2612896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name); 2613896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2614896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2615896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C category. 2616896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2617896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 261866ccaec73706f3623d2e7d191fe2c944feedcc2bTed Kremenek clang_constructUSR_ObjCCategory(const char *class_name, 2619896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek const char *category_name); 2620896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2621896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2622896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C protocol. 2623896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2624896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 2625896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek clang_constructUSR_ObjCProtocol(const char *protocol_name); 2626896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2627896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2628896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2629896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C instance variable and 2630896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 2631896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2632896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name, 2633896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2634896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2635896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2636896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C method and 2637896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 2638896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2639896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name, 2640896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek unsigned isInstanceMethod, 2641896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2642896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2643896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2644896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C property and the USR 2645896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * for its containing class. 2646896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2647896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property, 2648896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2649896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2650896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2651c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a name for the entity referenced by this cursor. 2652c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2653c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor); 2654c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2655358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor/** 2656358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * \brief Retrieve the display name for the entity referenced by this cursor. 2657358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * 2658358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * The display name contains extra information that helps identify the cursor, 2659358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * such as the parameters of a function or template or the arguments of a 2660358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * class template specialization. 2661358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor */ 2662358559d8d7b458c5f64941842383a16e61f0828dDouglas GregorCINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor); 2663358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor 2664c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor/** \brief For a cursor that is a reference, retrieve a cursor representing the 2665c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * entity that it references. 2666c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * 2667c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Reference cursors refer to other entities in the AST. For example, an 2668c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Objective-C superclass reference cursor refers to an Objective-C class. 26691efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * This function produces the cursor for the Objective-C class from the 2670c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * cursor for the superclass reference. If the input cursor is a declaration or 2671c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * definition, it returns that declaration or definition unchanged. 26721efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Otherwise, returns the NULL cursor. 2673c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor */ 2674c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor); 2675b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 26761efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 2677b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief For a cursor that is either a reference to or a declaration 2678b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * of some entity, retrieve a cursor that describes the definition of 2679b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that entity. 2680b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2681b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * Some entities can be declared multiple times within a translation 2682b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * unit, but only one of those declarations can also be a 2683b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * definition. For example, given: 2684b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2685b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \code 2686b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 2687b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int g(int x, int y) { return f(x, y); } 2688b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int a, int b) { return a + b; } 2689b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 2690b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \endcode 2691b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2692b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * there are three declarations of the function "f", but only the 2693b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * second one is a definition. The clang_getCursorDefinition() 2694b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * function will take any cursor pointing to a declaration of "f" 2695b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * (the first or fourth lines of the example) or a cursor referenced 2696b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that uses "f" (the call to "f' inside "g") and will return a 2697b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration cursor pointing to the definition (the second "f" 2698b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration). 2699b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2700b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * If given a cursor for which there is no corresponding definition, 2701b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * e.g., because there is no definition of that entity within this 2702b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * translation unit, returns a NULL cursor. 2703b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 2704b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor); 2705b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 27061efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 2707b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Determine whether the declaration pointed to by this cursor 2708b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * is also a definition of that entity. 2709b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 2710b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor); 2711b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 2712c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 27131a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \brief Retrieve the canonical cursor corresponding to the given cursor. 27141a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 27151a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * In the C family of languages, many kinds of entities can be declared several 27161a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * times within a single translation unit. For example, a structure type can 27171a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * be forward-declared (possibly multiple times) and later defined: 27181a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 27191a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \code 27201a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X; 27211a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X; 27221a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X { 27231a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * int member; 27241a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * }; 27251a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \endcode 27261a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 27271a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * The declarations and the definition of \c X are represented by three 27281a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * different cursors, all of which are declarations of the same underlying 27291a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * entity. One of these cursor is considered the "canonical" cursor, which 27301a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * is effectively the representative for the underlying entity. One can 27311a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * determine if two cursors are declarations of the same underlying entity by 27321a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * comparing their canonical cursors. 27331a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 27341a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \returns The canonical cursor for the entity referred to by the given cursor. 27351a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor */ 27361a9d0503b67a499797141af0fd6d315d5045f0eaDouglas GregorCINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor); 27371a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor 27381a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor/** 2739c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2740c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 27411efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2742c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 27439ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * \defgroup CINDEX_CPP C++ AST introspection 27449ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 27459ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * The routines in this group provide access information in the ASTs specific 27469ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * to C++ language features. 27479ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 27489ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @{ 27499ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 27509ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 27519ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 275249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Determine if a C++ member function or member function template is 275349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared 'static'. 27549ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 27559ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed KremenekCINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C); 27569ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 27579ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 2758211924b563aa31421836cee7655be729ad02733fDouglas Gregor * \brief Determine if a C++ member function or member function template is 2759211924b563aa31421836cee7655be729ad02733fDouglas Gregor * explicitly declared 'virtual' or if it overrides a virtual method from 2760211924b563aa31421836cee7655be729ad02733fDouglas Gregor * one of the base classes. 2761211924b563aa31421836cee7655be729ad02733fDouglas Gregor */ 2762211924b563aa31421836cee7655be729ad02733fDouglas GregorCINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C); 2763211924b563aa31421836cee7655be729ad02733fDouglas Gregor 2764211924b563aa31421836cee7655be729ad02733fDouglas Gregor/** 276549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Given a cursor that represents a template, determine 276649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the cursor kind of the specializations would be generated by instantiating 276749f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the template. 276849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 276949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * This routine can be used to determine what flavor of function template, 277049f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * class template, or class template partial specialization is stored in the 277149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * cursor. For example, it can describe whether a class template cursor is 277249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared with "struct", "class" or "union". 277349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 277449f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \param C The cursor to query. This cursor should represent a template 277549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declaration. 277649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 277749f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \returns The cursor kind of the specializations that would be generated 277849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * by instantiating the template \p C. If \p C is not a template, returns 277949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \c CXCursor_NoDeclFound. 278049f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor */ 278149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C); 278249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor 278349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor/** 2784e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \brief Given a cursor that may represent a specialization or instantiation 2785e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template, retrieve the cursor that represents the template that it 2786e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializes or from which it was instantiated. 2787e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2788e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * This routine determines the template involved both for explicit 2789e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializations of templates and for implicit instantiations of the template, 2790e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * both of which are referred to as "specializations". For a class template 2791e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specialization (e.g., \c std::vector<bool>), this routine will return 2792e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * either the primary template (\c std::vector) or, if the specialization was 2793e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * instantiated from a class template partial specialization, the class template 2794e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * partial specialization. For a class template partial specialization and a 2795e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * function template specialization (including instantiations), this 2796e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * this routine will return the specialized template. 2797e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2798e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * For members of a class template (e.g., member functions, member classes, or 2799e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * static data members), returns the specialized or instantiated member. 2800e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * Although not strictly "templates" in the C++ language, members of class 2801e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates have the same notions of specializations and instantiations that 2802e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates do, so this routine treats them similarly. 2803e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2804e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \param C A cursor that may be a specialization of a template or a member 2805e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template. 2806e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2807e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \returns If the given cursor is a specialization or instantiation of a 2808e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * template or a member thereof, the template or member that it specializes or 2809e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * from which it was instantiated. Otherwise, returns a NULL cursor. 2810e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor */ 2811e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas GregorCINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C); 2812430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 2813430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor/** 2814430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Given a cursor that references something else, return the source range 2815430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * covering that reference. 2816430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 2817430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param C A cursor pointing to a member reference, a declaration reference, or 2818430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * an operator call. 2819430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param NameFlags A bitset with three independent flags: 2820430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and 2821430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantSinglePiece. 2822430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param PieceIndex For contiguous names or when passing the flag 2823430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantSinglePiece, only one piece with index 0 is 2824430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * available. When the CXNameRange_WantSinglePiece flag is not passed for a 2825430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * non-contiguous names, this index can be used to retreive the individual 2826430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * pieces of the name. See also CXNameRange_WantSinglePiece. 2827430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 2828430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \returns The piece of the name pointed to by the given cursor. If there is no 2829430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * name, or if the PieceIndex is out-of-range, a null-cursor will be returned. 2830430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 283148a8d14fc6f064a5297024c2b34733a4080b2efeFrancois PichetCINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, 283248a8d14fc6f064a5297024c2b34733a4080b2efeFrancois Pichet unsigned NameFlags, 2833430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor unsigned PieceIndex); 2834430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 2835430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregorenum CXNameRefFlags { 2836430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 2837430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the 2838430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * range. 2839430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 2840430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantQualifier = 0x1, 2841430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 2842430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 2843430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Include the explicit template arguments, e.g. <int> in x.f<int>, in 2844430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * the range. 2845430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 2846430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantTemplateArgs = 0x2, 2847430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 2848430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 2849430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief If the name is non-contiguous, return the full spanning range. 2850430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 2851430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * Non-contiguous names occur in Objective-C when a selector with two or more 2852430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * parameters is used, or in C++ when using an operator: 2853430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \code 2854430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * [object doSomething:here withValue:there]; // ObjC 2855430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * return some_vector[1]; // C++ 2856430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \endcode 2857430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 2858430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantSinglePiece = 0x4 2859430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor}; 2860e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor 2861e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor/** 28629ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @} 28639ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 28649ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 28659ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 28660045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \defgroup CINDEX_LEX Token extraction and manipulation 28670045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 28680045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * The routines in this group provide access to the tokens within a 28690045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * translation unit, along with a semantic mapping of those tokens to 28700045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * their corresponding cursors. 2871fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2872fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @{ 2873fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2874fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2875fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2876fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a kind of token. 2877fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2878fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef enum CXTokenKind { 2879fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2880fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A token that contains some kind of punctuation. 2881fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2882fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Punctuation, 2883896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2884fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 28850045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \brief A language keyword. 2886fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2887fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Keyword, 2888896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2889fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2890fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief An identifier (that is not a keyword). 2891fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2892fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Identifier, 2893896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2894fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2895fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A numeric, string, or character literal. 2896fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2897fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Literal, 2898896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2899fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2900fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A comment. 2901fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2902fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Comment 2903fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXTokenKind; 2904fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2905fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2906fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a single preprocessing token. 2907fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2908fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef struct { 2909fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor unsigned int_data[4]; 2910fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor void *ptr_data; 2911fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXToken; 2912fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2913fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2914fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the kind of the given token. 2915fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2916fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken); 2917896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2918fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2919fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the spelling of the given token. 2920fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2921fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * The spelling of a token is the textual representation of that token, e.g., 2922fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * the text of an identifier or keyword. 2923fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2924fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken); 2925896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2926fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2927fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve the source location of the given token. 2928fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2929896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit, 2930fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken); 2931896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2932fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2933fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve a source range that covers the given token. 2934fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2935fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken); 2936fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2937fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2938fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Tokenize the source code described by the given range into raw 2939fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * lexical tokens. 2940fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2941fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit whose text is being tokenized. 2942fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2943fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Range the source range in which text should be tokenized. All of the 2944fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * tokens produced by tokenization will fall within this source range, 2945fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2946fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens this pointer will be set to point to the array of tokens 2947fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that occur within the given source range. The returned pointer must be 2948fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * freed with clang_disposeTokens() before the translation unit is destroyed. 2949fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2950fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens will be set to the number of tokens in the \c *Tokens 2951fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * array. 2952fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2953fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2954fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range, 2955fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken **Tokens, unsigned *NumTokens); 2956896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2957fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2958fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Annotate the given set of tokens by providing cursors for each token 2959fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that can be mapped to a specific entity within the abstract syntax tree. 2960fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 29610045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * This token-annotation routine is equivalent to invoking 29620045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() for the source locations of each of the 29630045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * tokens. The cursors provided are filtered, so that only those 29640045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * cursors that have a direct correspondence to the token are 29650045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * accepted. For example, given a function call \c f(x), 29660045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() would provide the following cursors: 29670045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 29680045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'. 29690045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'. 29700045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'. 29710045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 29720045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * Only the first and last of these cursors will occur within the 29730045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * annotate, since the tokens "f" and "x' directly refer to a function 29740045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * and a variable, respectively, but the parentheses are just a small 29750045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * part of the full syntax of the function call expression, which is 29760045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * not provided as an annotation. 2977fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2978fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit that owns the given tokens. 2979fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2980fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens the set of tokens to annotate. 2981fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2982fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens the number of tokens in \p Tokens. 2983fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2984fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Cursors an array of \p NumTokens cursors, whose contents will be 2985fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * replaced with the cursors corresponding to each token. 2986fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2987fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU, 2988fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens, 2989fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXCursor *Cursors); 2990896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2991fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2992fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Free the given set of tokens. 2993fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2994896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU, 2995fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens); 2996896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2997fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2998fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @} 2999fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3000896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3001fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3002c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_DEBUG Debugging facilities 3003c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3004c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines are used for testing and debugging, only, and should not 3005c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be relied upon. 3006c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3007c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 3008c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 30091efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 30104ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff/* for debug/testing */ 3011e68fff6fc083c6270d835216a3de0b82c6ef0310Ted KremenekCINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind); 30121efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor, 30131efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar const char **startBuf, 30144ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff const char **endBuf, 30154ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startLine, 30164ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startColumn, 30174ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endLine, 30184ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endColumn); 30190a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE void clang_enableStackTraces(void); 3020995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel DunbarCINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data, 3021995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar unsigned stack_size); 3022995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar 30230c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 3024c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 3025c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 30261efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 3027c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 3028c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CODE_COMPLET Code completion 3029c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3030c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Code completion involves taking an (incomplete) source file, along with 3031c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * knowledge of where the user is actively editing that file, and suggesting 3032c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * syntactically- and semantically-valid constructs that the user might want to 3033c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * use at that particular point in the source code. These data structures and 3034c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines provide support for code completion. 3035c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3036c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 3037c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 30381efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 3039c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 30400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A semantic string that describes a code-completion result. 30410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 30420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A semantic string that describes the formatting of a code-completion 30430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * result as a single "template" of text that should be inserted into the 30440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * source buffer when a particular code-completion result is selected. 30450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * Each semantic string is made up of some number of "chunks", each of which 30460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * contains some text along with a description of what that text means, e.g., 30470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the name of the entity being referenced, whether the text chunk is part of 30480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the template, or whether it is a "placeholder" that the user should replace 30490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * with actual code,of a specific kind. See \c CXCompletionChunkKind for a 30501efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * description of the different kinds of chunks. 30510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 30520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef void *CXCompletionString; 30531efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 30540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 30550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A single result of code completion. 30560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 30570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef struct { 30580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 30591efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief The kind of entity that this completion refers to. 30600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 30611efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor kind will be a macro, keyword, or a declaration (one of the 30620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * *Decl cursor kinds), describing the entity that the completion is 30630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to. 30640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 30650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \todo In the future, we would like to provide a full cursor, to allow 30660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the client to extract additional information from declaration. 30670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 30680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor enum CXCursorKind CursorKind; 30691efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 30701efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 30710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief The code-completion string that describes how to insert this 30720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion result into the editing buffer. 30730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 30740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionString CompletionString; 30750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor} CXCompletionResult; 30760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 30770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 30780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Describes a single piece of text within a code-completion string. 30790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 30801efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Each "chunk" within a code-completion string (\c CXCompletionString) is 30811efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * either a piece of text with a specific "kind" that describes how that text 30820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * should be interpreted by the client or is another completion string. 30830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 30840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorenum CXCompletionChunkKind { 30850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 30860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A code-completion string that describes "optional" text that 30870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * could be a part of the template (but is not required). 30880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 30890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The Optional chunk is the only kind of chunk that has a code-completion 30901efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * string for its representation, which is accessible via 30910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \c clang_getCompletionChunkCompletionString(). The code-completion string 30920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * describes an additional part of the template that is completely optional. 30930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * For example, optional chunks can be used to describe the placeholders for 30940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * arguments that match up with defaulted function parameters, e.g. given: 30950c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 30960c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 30970c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * void f(int x, float y = 3.14, double z = 2.71828); 30980c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 30990c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31000c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The code-completion string for this function would contain: 31010c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a TypedText chunk for "f". 31020c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a LeftParen chunk for "(". 31030c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "int x" 31040c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the remaining defaulted arguments, e.g., 31050c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 310671570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * - a Placeholder chunk for "float y" 31070c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the last defaulted argument: 31080c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 31090c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "double z" 31100c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a RightParen chunk for ")" 31110c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 311271570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * There are many ways to handle Optional chunks. Two simple approaches are: 31130c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Completely ignore optional chunks, in which case the template for the 31140c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would only include the first parameter ("int x"). 31150c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Fully expand all optional chunks, in which case the template for the 31160c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would have all of the parameters. 31170c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31180c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Optional, 31190c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 31200c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that a user would be expected to type to get this 31211efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * code-completion result. 31220c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31231efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * There will be exactly one "typed text" chunk in a semantic string, which 31241efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * will typically provide the spelling of a keyword or the name of a 31250c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * declaration that could be used at the current code point. Clients are 31260c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * expected to filter the code-completion results based on the text in this 31270c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * chunk. 31280c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_TypedText, 31300c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 31310c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that should be inserted as part of a code-completion result. 31320c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31330c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "text" chunk represents text that is part of the template to be 31340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * inserted into user code should this particular code-completion result 31350c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * be selected. 31360c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31370c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Text, 31380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 31390c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Placeholder text that should be replaced by the user. 31400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "placeholder" chunk marks a place where the user should insert text 31420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * into the code-completion template. For example, placeholders might mark 31430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the function parameters for a function declaration, to indicate that the 31440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * user should provide arguments for each of those parameters. The actual 31450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * text in a placeholder is a suggestion for the text to display before 31460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the user replaces the placeholder with real code. 31470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Placeholder, 31490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 31500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Informative text that should be displayed but never inserted as 31510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * part of the template. 31521efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 31530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * An "informative" chunk contains annotations that can be displayed to 31540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * help the user decide whether a particular code-completion result is the 31550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * right option, but which is not part of the actual template to be inserted 31560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * by code completion. 31570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Informative, 31590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 31600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that describes the current parameter when code-completion is 31610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to function call, message send, or template specialization. 31620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "current parameter" chunk occurs when code-completion is providing 31640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * information about a parameter corresponding to the argument at the 31650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion point. For example, given a function 31660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 31680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * int add(int x, int y); 31690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 31700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * and the source code \c add(, where the code-completion point is after the 31720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "(", the code-completion string will contain a "current parameter" chunk 31730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * for "int x", indicating that the current argument will initialize that 31740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * parameter. After typing further, to \c add(17, (where the code-completion 31751efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * point is after the ","), the code-completion string will contain a 31760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "current paremeter" chunk to "int y". 31770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_CurrentParameter, 31790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 31800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left parenthesis ('('), used to initiate a function call or 31810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the beginning of a function parameter list. 31820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftParen, 31840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 31850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right parenthesis (')'), used to finish a function call or 31860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the end of a function parameter list. 31870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightParen, 31890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 31900c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left bracket ('['). 31910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBracket, 31930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 31940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right bracket (']'). 31950c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31960c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBracket, 31970c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 31980c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left brace ('{'). 31990c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32000c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBrace, 32010c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32020c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right brace ('}'). 32030c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32040c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBrace, 32050c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32060c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left angle bracket ('<'). 32070c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32080c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftAngle, 32090c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32100c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right angle bracket ('>'). 32110c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32120c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightAngle, 32130c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32140c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A comma separator (','). 32150c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 3216ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor CXCompletionChunk_Comma, 3217ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor /** 32181efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Text that specifies the result type of a given result. 3219ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * 3220ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * This special kind of informative chunk is not meant to be inserted into 32211efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * the text buffer. Rather, it is meant to illustrate the type that an 3222ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * expression using the given completion string would have. 3223ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor */ 322401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_ResultType, 322501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 322601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A colon (':'). 322701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 322801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Colon, 322901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 323001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A semicolon (';'). 323101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 323201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_SemiColon, 323301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 323401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief An '=' sign. 323501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 323601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Equal, 323701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 323801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Horizontal space (' '). 323901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 324001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_HorizontalSpace, 324101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 324201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Vertical space ('\n'), after which it is generally a good idea to 324301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * perform indentation. 324401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 324501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_VerticalSpace 32460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor}; 32471efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 32480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 32490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Determine the kind of a particular chunk within a completion string. 32500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 32520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 32540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the kind of the chunk at the index \c chunk_number. 32560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32571efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE enum CXCompletionChunkKind 32580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkKind(CXCompletionString completion_string, 32590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 32601efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 32610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 32621efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the text associated with a particular chunk within a 32630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * completion string. 32640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 32660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 32680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the text associated with the chunk at index \c chunk_number. 32700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32712ef6f8f5a35a60870594c5b04e0aa2bf22c6886fTed KremenekCINDEX_LINKAGE CXString 32720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkText(CXCompletionString completion_string, 32730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 32740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 32750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 32761efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the completion string associated with a particular chunk 32770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * within a completion string. 32780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 32800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 32820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the completion string associated with the chunk at index 32846164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \c chunk_number. 32850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE CXCompletionString 32870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkCompletionString(CXCompletionString completion_string, 32880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 32891efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 32900c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 32910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Retrieve the number of chunks in the given code-completion string. 32920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE unsigned 32940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getNumCompletionChunks(CXCompletionString completion_string); 32950c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 32960c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 329712e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \brief Determine the priority of this code completion. 329812e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 329912e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * The priority of a code completion indicates how likely it is that this 330012e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * particular completion is the completion that the user will select. The 330112e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * priority is selected by various internal heuristics. 330212e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 330312e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \param completion_string The completion string to query. 330412e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 330512e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \returns The priority of this completion string. Smaller values indicate 330612e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * higher-priority (more likely) completions. 330712e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor */ 330812e131385e892e3723483a1081a89bcad29c8a84Douglas GregorCINDEX_LINKAGE unsigned 330912e131385e892e3723483a1081a89bcad29c8a84Douglas Gregorclang_getCompletionPriority(CXCompletionString completion_string); 331012e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor 331112e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor/** 331258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \brief Determine the availability of the entity that this code-completion 331358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * string refers to. 331458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 331558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param completion_string The completion string to query. 331658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 331758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the completion string. 331858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 331958ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 332058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCompletionAvailability(CXCompletionString completion_string); 332158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 332258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 33236164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \brief Retrieve the number of annotations associated with the given 33246164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * completion string. 33256164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 33266164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \param completion_string the completion string to query. 33276164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 33286164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \returns the number of annotations associated with the given completion 33296164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * string. 33306164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen */ 33316164ea1d75385b6fc3c19e5ab9bb686298436a5aErik VerbruggenCINDEX_LINKAGE unsigned 33326164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggenclang_getCompletionNumAnnotations(CXCompletionString completion_string); 33336164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen 33346164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen/** 33356164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \brief Retrieve the annotation associated with the given completion string. 33366164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 33376164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \param completion_string the completion string to query. 33386164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 33396164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \param annotation_number the 0-based index of the annotation of the 33406164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * completion string. 33416164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 33426164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \returns annotation string associated with the completion at index 33436164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \c annotation_number, or a NULL string if that annotation is not available. 33446164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen */ 33456164ea1d75385b6fc3c19e5ab9bb686298436a5aErik VerbruggenCINDEX_LINKAGE CXString 33466164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggenclang_getCompletionAnnotation(CXCompletionString completion_string, 33476164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen unsigned annotation_number); 33486164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen 33496164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen/** 33508fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \brief Retrieve a completion string for an arbitrary declaration or macro 33518fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * definition cursor. 33528fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * 33538fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \param cursor The cursor to query. 33548fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * 33558fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \returns A non-context-sensitive completion string for declaration and macro 33568fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * definition cursors, or NULL for other kinds of cursors. 33578fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor */ 33588fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas GregorCINDEX_LINKAGE CXCompletionString 33598fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregorclang_getCursorCompletionString(CXCursor cursor); 33608fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 33618fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor/** 3362ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Contains the results of code-completion. 3363ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * 3364ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * This data structure contains the results of code completion, as 3365e0cc52ef8afc8d1cba9c534191b5f0ddaff1d694Douglas Gregor * produced by \c clang_codeCompleteAt(). Its contents must be freed by 3366ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c clang_disposeCodeCompleteResults. 3367ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 3368ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregortypedef struct { 3369ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 3370ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The code-completion results. 3371ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 3372ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor CXCompletionResult *Results; 3373ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 3374ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 3375ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The number of code-completion results stored in the 3376ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c Results array. 3377ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 3378ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor unsigned NumResults; 3379ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor} CXCodeCompleteResults; 3380ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 3381ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor/** 3382cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Flags that can be passed to \c clang_codeCompleteAt() to 3383cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * modify its behavior. 3384cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 3385cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * The enumerators in this enumeration can be bitwise-OR'd together to 3386cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * provide multiple options to \c clang_codeCompleteAt(). 3387cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 3388cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregorenum CXCodeComplete_Flags { 3389cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 3390cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include macros within the set of code 3391cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completions returned. 3392cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 3393cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor CXCodeComplete_IncludeMacros = 0x01, 3394cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 3395cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 3396cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include code patterns for language constructs 3397cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * within the set of code completions, e.g., for loops. 3398cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 3399cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor CXCodeComplete_IncludeCodePatterns = 0x02 3400cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor}; 3401cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 3402cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 34033da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Bits that represent the context under which completion is occurring. 34043da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 34053da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * The enumerators in this enumeration may be bitwise-OR'd together if multiple 34063da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * contexts are occurring simultaneously. 34073da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34083da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregorenum CXCompletionContext { 34093da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34103da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief The context for completions is unexposed, as only Clang results 34113da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included. (This is equivalent to having no context bits set.) 34123da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34133da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Unexposed = 0, 34143da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 34153da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34163da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for any possible type should be included in the results. 34173da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34183da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_AnyType = 1 << 0, 34193da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 34203da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34213da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for any possible value (variables, function calls, etc.) 34223da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included in the results. 34233da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34243da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_AnyValue = 1 << 1, 34253da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34263da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to an Objective-C object should 34273da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * be included in the results. 34283da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34293da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCObjectValue = 1 << 2, 34303da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34313da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to an Objective-C selector 34323da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included in the results. 34333da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34343da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCSelectorValue = 1 << 3, 34353da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34363da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to a C++ class type should be 34373da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * included in the results. 34383da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34393da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_CXXClassTypeValue = 1 << 4, 34403da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 34413da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34423da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for fields of the member being accessed using the dot 34433da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * operator should be included in the results. 34443da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34453da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_DotMemberAccess = 1 << 5, 34463da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34473da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for fields of the member being accessed using the arrow 34483da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * operator should be included in the results. 34493da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34503da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ArrowMemberAccess = 1 << 6, 34513da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34523da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for properties of the Objective-C object being accessed 34533da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * using the dot operator should be included in the results. 34543da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34553da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCPropertyAccess = 1 << 7, 34563da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 34573da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34583da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for enum tags should be included in the results. 34593da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34603da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_EnumTag = 1 << 8, 34613da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34623da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for union tags should be included in the results. 34633da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34643da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_UnionTag = 1 << 9, 34653da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34663da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for struct tags should be included in the results. 34673da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34683da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_StructTag = 1 << 10, 34693da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 34703da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34713da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ class names should be included in the results. 34723da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34733da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ClassTag = 1 << 11, 34743da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34753da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ namespaces and namespace aliases should be 34763da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * included in the results. 34773da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34783da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Namespace = 1 << 12, 34793da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34803da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ nested name specifiers should be included in 34813da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 34823da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34833da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_NestedNameSpecifier = 1 << 13, 34843da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 34853da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34863da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C interfaces (classes) should be included 34873da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * in the results. 34883da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34893da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCInterface = 1 << 14, 34903da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34913da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C protocols should be included in 34923da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 34933da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34943da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCProtocol = 1 << 15, 34953da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34963da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C categories should be included in 34973da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 34983da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34993da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCCategory = 1 << 16, 35003da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35013da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C instance messages should be included 35023da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * in the results. 35033da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35043da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCInstanceMessage = 1 << 17, 35053da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35063da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C class messages should be included in 35073da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 35083da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35093da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCClassMessage = 1 << 18, 35103da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35113da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C selector names should be included in 35123da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 35133da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35143da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCSelectorName = 1 << 19, 35153da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 35163da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35173da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for preprocessor macro names should be included in 35183da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 35193da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35203da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_MacroName = 1 << 20, 35213da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 35223da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35233da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Natural language completions should be included in the results. 35243da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35253da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_NaturalLanguage = 1 << 21, 35263da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 35273da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35283da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief The current context is unknown, so set all contexts. 35293da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35303da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Unknown = ((1 << 22) - 1) 35313da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor}; 35323da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 35333da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor/** 3534cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Returns a default set of code-completion options that can be 3535cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * passed to\c clang_codeCompleteAt(). 3536cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 3537cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas GregorCINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void); 3538cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 3539cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 35401abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \brief Perform code completion at a given location in a translation unit. 35411abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 35421abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * This function performs code completion at a particular file, line, and 35431abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * column within source code, providing results that suggest potential 35441abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code snippets based on the context of the completion. The basic model 35451abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * for code completion is that Clang will parse a complete source file, 35461abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * performing syntax checking up to the location where code-completion has 35471abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * been requested. At that point, a special code-completion token is passed 35481abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * to the parser, which recognizes this token and determines, based on the 35491abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * current location in the C/Objective-C/C++ grammar and the state of 35501abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * semantic analysis, what completions to provide. These completions are 35511abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * returned via a new \c CXCodeCompleteResults structure. 35521abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 35531abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Code completion itself is meant to be triggered by the client when the 35541abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * user types punctuation characters or whitespace, at which point the 35551abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code-completion location will coincide with the cursor. For example, if \c p 35561abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is a pointer, code-completion might be triggered after the "-" and then 35571abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * after the ">" in \c p->. When the code-completion location is afer the ">", 35581abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the completion results will provide, e.g., the members of the struct that 35591abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * "p" points to. The client is responsible for placing the cursor at the 35601abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * beginning of the token currently being typed, then filtering the results 35611abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * based on the contents of the token. For example, when code-completing for 35621abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the expression \c p->get, the client should provide the location just after 35631abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the 35641abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client can filter the results based on the current token text ("get"), only 35651abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * showing those results that start with "get". The intent of this interface 35661abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is to separate the relatively high-latency acquisition of code-completion 35671abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * results from the filtering of results on a per-character basis, which must 35681abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * have a lower latency. 35691abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 35701abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param TU The translation unit in which code-completion should 35711abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * occur. The source files for this translation unit need not be 35721abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completely up-to-date (and the contents of those source files may 35731abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * be overridden via \p unsaved_files). Cursors referring into the 35741abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * translation unit may be invalidated by this invocation. 35751abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 35761abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_filename The name of the source file where code 35771abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion should be performed. This filename may be any file 35781abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * included in the translation unit. 35791abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 35801abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_line The line at which code-completion should occur. 35811abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 35821abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_column The column at which code-completion should occur. 35831abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Note that the column should point just after the syntactic construct that 35841abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * initiated code completion, and not in the middle of a lexical token. 35851abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 35861abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param unsaved_files the Tiles that have not yet been saved to disk 35871abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing or code completion, including the 35881abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * contents of those files. The contents and name of these files (as 35891abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * specified by CXUnsavedFile) are copied when necessary, so the 35901abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client only needs to guarantee their validity until the call to 35911abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * this function returns. 35921abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 35931abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 35941abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * unsaved_files. 35951abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 3596cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \param options Extra options that control the behavior of code 3597cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completion, expressed as a bitwise OR of the enumerators of the 3598cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * CXCodeComplete_Flags enumeration. The 3599cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \c clang_defaultCodeCompleteOptions() function returns a default set 3600cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * of code-completion options. 3601cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 36021abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \returns If successful, a new \c CXCodeCompleteResults structure 36031abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * containing code-completion results, which should eventually be 36041abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * freed with \c clang_disposeCodeCompleteResults(). If code 36051abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion fails, returns NULL. 36061abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor */ 36071abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCINDEX_LINKAGE 36081abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU, 36091abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor const char *complete_filename, 36101abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_line, 36111abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_column, 36121abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor struct CXUnsavedFile *unsaved_files, 3613cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned num_unsaved_files, 3614cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned options); 36151abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 36161abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor/** 36171e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \brief Sort the code-completion results in case-insensitive alphabetical 36181e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * order. 36191e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * 36201e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param Results The set of results to sort. 36211e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param NumResults The number of results in \p Results. 36221e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor */ 36231e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas GregorCINDEX_LINKAGE 36241e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregorvoid clang_sortCodeCompletionResults(CXCompletionResult *Results, 36251e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor unsigned NumResults); 36261e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor 36271e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor/** 3628ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Free the given set of code-completion results. 36290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 36301efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE 3631ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregorvoid clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results); 363258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 363320d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor/** 3634a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced prior to the 3635a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * location where code completion was performed. 3636a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 3637896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 3638a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorunsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results); 3639a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 3640a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 3641a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given code completion. 3642a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 3643a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Result the code completion results to query. 3644a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 3645a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 3646a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 3647a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 3648a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 3649896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 3650a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results, 3651a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 3652a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 3653a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 36543da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Determines what compeltions are appropriate for the context 36553da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the given code completion. 36563da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 36573da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \param Results the code completion results to query 36583da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 36593da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \returns the kinds of completions that are appropriate for use 36603da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * along with the given code completion results. 36613da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36623da626b4f38eb0350de960d71271ca77af7a9cc8Douglas GregorCINDEX_LINKAGE 36633da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregorunsigned long long clang_codeCompleteGetContexts( 36643da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCodeCompleteResults *Results); 3665e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor 3666e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor/** 3667e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \brief Returns the cursor kind for the container for the current code 3668e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * completion context. The container is only guaranteed to be set for 3669e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * contexts where a container exists (i.e. member accesses or Objective-C 3670e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * message sends); if there is not a container, this function will return 3671e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * CXCursor_InvalidCode. 3672e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3673e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param Results the code completion results to query 3674e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3675e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param IsIncomplete on return, this value will be false if Clang has complete 3676e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * information about the container. If Clang does not have complete 3677e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * information, this value will be true. 3678e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3679e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \returns the container kind, or CXCursor_InvalidCode if there is not a 3680e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * container 3681e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor */ 3682e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCINDEX_LINKAGE 3683e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregorenum CXCursorKind clang_codeCompleteGetContainerKind( 3684e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor CXCodeCompleteResults *Results, 3685e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor unsigned *IsIncomplete); 3686e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor 3687e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor/** 3688e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \brief Returns the USR for the container for the current code completion 3689e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * context. If there is not a container for the current context, this 3690e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * function will return the empty string. 3691e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3692e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param Results the code completion results to query 3693e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3694e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \returns the USR for the container 3695e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor */ 3696e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCINDEX_LINKAGE 3697e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results); 36983da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 36990a47d69af8bda945352997af3da4687a3356096aDouglas Gregor 37000a47d69af8bda945352997af3da4687a3356096aDouglas Gregor/** 37010a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \brief Returns the currently-entered selector for an Objective-C message 37020a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * send, formatted like "initWithFoo:bar:". Only guaranteed to return a 37030a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * non-empty string for CXCompletionContext_ObjCInstanceMessage and 37040a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * CXCompletionContext_ObjCClassMessage. 37050a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * 37060a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \param Results the code completion results to query 37070a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * 37080a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \returns the selector (or partial selector) that has been entered thus far 37090a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * for an Objective-C message send. 37100a47d69af8bda945352997af3da4687a3356096aDouglas Gregor */ 37110a47d69af8bda945352997af3da4687a3356096aDouglas GregorCINDEX_LINKAGE 37120a47d69af8bda945352997af3da4687a3356096aDouglas GregorCXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results); 37130a47d69af8bda945352997af3da4687a3356096aDouglas Gregor 37143da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor/** 371520d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * @} 371620d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor */ 37171efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 37181efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 371904bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek/** 372004bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * \defgroup CINDEX_MISC Miscellaneous utility functions 372104bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * 372204bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @{ 372304bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 372423e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek 372523e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek/** 372623e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * \brief Return a version string, suitable for showing to a user, but not 372723e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * intended to be parsed (the format is not guaranteed to be stable). 372823e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek */ 3729a2a9d6e4e5b6001b86b7dfc5db1ea296ce29a3d3Ted KremenekCINDEX_LINKAGE CXString clang_getClangVersion(); 373004bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek 3731d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek 3732d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek/** 3733d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * \brief Enable/disable crash recovery. 3734d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * 3735d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * \param Flag to indicate if crash recovery is enabled. A non-zero value 3736d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * enables crash recovery, while 0 disables it. 3737d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek */ 3738d2427ddf00aacdc288c386f3882e0821ca9bd27bTed KremenekCINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled); 3739d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek 374016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek /** 3741896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Visitor invoked for each file in a translation unit 374216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * (used with clang_getInclusions()). 374316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * 374416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * This visitor function will be invoked by clang_getInclusions() for each 374516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * file included (either at the top-level or by #include directives) within 374616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * a translation unit. The first argument is the file being included, and 374716b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the second and third arguments provide the inclusion stack. The 374816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * array is sorted in order of immediate inclusion. For example, 374916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the first element refers to the location that included 'included_file'. 375016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 375116b55a71695a33c094383295cc7b7a2080e098daTed Kremenektypedef void (*CXInclusionVisitor)(CXFile included_file, 375216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXSourceLocation* inclusion_stack, 375316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek unsigned include_len, 375416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 375516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 375616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 375716b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * \brief Visit the set of preprocessor inclusions in a translation unit. 375816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * The visitor function is called with the provided data for every included 375916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * file. This does not include headers included by the PCH file (unless one 376016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * is inspecting the inclusions in the PCH file itself). 376116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 376216b55a71695a33c094383295cc7b7a2080e098daTed KremenekCINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu, 376316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXInclusionVisitor visitor, 376416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 376516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 376616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 376704bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @} 376804bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 37691efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 377097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** \defgroup CINDEX_REMAPPING Remapping functions 377197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 377297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * @{ 377397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 377497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 377597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 377697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief A remapping of original source files and their translated files. 377797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 377897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidistypedef void *CXRemapping; 377997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 378097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 378197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Retrieve a remapping. 378297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 378397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param path the path that contains metadata about remappings. 378497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 378597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \returns the requested remapping. This remapping must be freed 378697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred. 378797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 378897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path); 378997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 379097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 379197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Determine the number of remappings. 379297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 379397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping); 379497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 379597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 379697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Get the original and the associated filename from the remapping. 379797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 379897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param original If non-NULL, will be set to the original filename. 379997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 380097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param transformed If non-NULL, will be set to the filename that the original 380197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * is associated with. 380297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 380397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index, 380497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis CXString *original, CXString *transformed); 380597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 380697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 380797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Dispose the remapping. 380897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 380997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE void clang_remap_dispose(CXRemapping); 381097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 381197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 381297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * @} 381397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 381497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 3815aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis/** \defgroup CINDEX_HIGH Higher level API functions 3816aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 3817aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * @{ 3818aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis */ 3819aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3820aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidisenum CXVisitorResult { 3821aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXVisit_Break, 3822aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXVisit_Continue 3823aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis}; 3824aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3825aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidistypedef struct { 3826aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis void *context; 3827aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange); 3828aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis} CXCursorAndRangeVisitor; 3829aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3830aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis/** 3831aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \brief Find references of a declaration in a specific file. 3832aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 3833aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \param cursor pointing to a declaration or a reference of one. 3834aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 3835aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \param file to search for references. 3836aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 3837aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for 3838aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * each reference found. 3839aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * The CXSourceRange will point inside the file; if the reference is inside 3840aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * a macro (and not a macro argument) the CXSourceRange will be invalid. 3841aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis */ 3842aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios KyrtzidisCINDEX_LINKAGE void clang_findReferencesInFile(CXCursor cursor, CXFile file, 3843aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXCursorAndRangeVisitor visitor); 3844aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3845aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis#ifdef __has_feature 3846aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis# if __has_feature(blocks) 3847aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3848aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidistypedef enum CXVisitorResult 3849aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange); 3850aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3851aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios KyrtzidisCINDEX_LINKAGE 3852aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidisvoid clang_findReferencesInFileWithBlock(CXCursor, CXFile, 3853aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXCursorAndRangeVisitorBlock); 3854aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3855aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis# endif 3856aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis#endif 3857aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 38584e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef void *CXIdxFile; 38594e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef void *CXIdxEntity; 38604e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef void *CXIdxContainer; 38614e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef void *CXIdxMacro; 38624e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef void *CXIdxASTFile; 38634e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 38644e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 38654e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void *ptr_data[2]; 38664e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned int_data; 38674e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxLoc; 38684e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 38694e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 38704e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc hashLoc; 38714e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *filename; 38724e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxFile file; 38734e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isImport; 38744e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isAngled; 38754e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxIncludedFileInfo; 38764e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 38774e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 38784e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXFile file; 38794e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 38804e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isModule; 38814e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxImportedASTFileInfo; 38824e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 38834e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 38844e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 38854e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *name; 38864e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxMacroInfo; 38874e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 38884e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 38894e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxMacroInfo *macroInfo; 38904e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc defBegin; 38914e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned defLength; 38924e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxMacroDefinedInfo; 38934e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 38944e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 38954e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 38964e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *name; 38974e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxMacro macro; 38984e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxMacroUndefinedInfo; 38994e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39004e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39014e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 39024e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *name; 39034e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxMacro macro; 39044e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxMacroExpandedInfo; 39054e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39064e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39074e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *name; 39084e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *USR; 39094e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxEntityInfo; 39104e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39114e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39124e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXCursor cursor; 39134e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 39144e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxContainer container; 39154e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxIndexedDeclInfo; 39164e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39174e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39184e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntityInfo *entityInfo; 39194e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXCursor cursor; 39204e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 39214e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxASTFile ASTFile; 39224e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxImportedEntityInfo; 39234e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39244e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39254e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxMacroInfo *macroInfo; 39264e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxASTFile ASTFile; 39274e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxImportedMacroInfo; 39284e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39294e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39304e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntityInfo *entityInfo; 39314e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedDeclInfo *declInfo; 39324e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxIndexedEntityInfo; 39334e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39344e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39354e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedDeclInfo *declInfo; 39364e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity entity; 39374e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxIndexedRedeclInfo; 39384e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39394e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39404e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXCursor cursor; 39414e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 39424e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity entity; 39434e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxContainerInfo; 39444e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39454e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39464e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedEntityInfo *indexedEntityInfo; 39474e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxTypedefInfo; 39484e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39494e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39504e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedEntityInfo *indexedEntityInfo; 39514e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isDefinition; 39524e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxFunctionInfo; 39534e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39544e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39554e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedRedeclInfo *indexedRedeclInfo; 39564e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isDefinition; 39574e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxFunctionRedeclInfo; 39584e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39594e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39604e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedEntityInfo *indexedEntityInfo; 39614e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isDefinition; 39624e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxVariableInfo; 39634e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39644e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39654e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedRedeclInfo *indexedRedeclInfo; 39664e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isDefinition; 39674e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxVariableRedeclInfo; 39684e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39694e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39704e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedEntityInfo *indexedEntityInfo; 39714e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isDefinition; 39724e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isAnonymous; 39734e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxTagTypeInfo; 39744e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39754e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39764e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedRedeclInfo *indexedRedeclInfo; 39774e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isDefinition; 39784e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxTagTypeRedeclInfo; 39794e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39804e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39814e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxContainerInfo *containerInfo; 39824e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxTagTypeDefinitionInfo; 39834e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39844e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39854e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedEntityInfo *indexedEntityInfo; 39864e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxFieldInfo; 39874e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39884e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39894e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedEntityInfo *indexedEntityInfo; 39904e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxEnumeratorInfo; 39914e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39924e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39934e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedEntityInfo *indexedEntityInfo; 39944e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isForwardRef; 39954e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCClassInfo; 39964e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 39974e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 39984e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedEntityInfo *indexedEntityInfo; 39994e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isForwardRef; 40004e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCProtocolInfo; 40014e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40024e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40034e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedEntityInfo *indexedEntityInfo; 40044e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity objcClass; 40054e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCCategoryInfo; 40064e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40074e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40084e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedEntityInfo *indexedEntityInfo; 40094e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isDefinition; 40104e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCMethodInfo; 40114e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40124e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40134e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedEntityInfo *indexedEntityInfo; 40144e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCPropertyInfo; 40154e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40164e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40174e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIndexedRedeclInfo *indexedRedeclInfo; 40184e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isDefinition; 40194e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCMethodRedeclInfo; 40204e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40214e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40224e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxContainerInfo *containerInfo; 40234e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc bodyBegin; 40244e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxStmtBodyInfo; 40254e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40264e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40274e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxContainerInfo *containerInfo; 40284e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCContainerInfo; 40294e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40304e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40314e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity objcClass; 40324e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 40334e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCBaseClassInfo; 40344e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40354e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40364e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity protocol; 40374e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 40384e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCProtocolRefInfo; 40394e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40404e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40414e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXCursor cursor; 40424e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity objcClass; 40434e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxContainer container; 40444e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxObjCBaseClassInfo *baseInfo; 40454e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxObjCProtocolRefInfo **protocols; 40464e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned numProtocols; 40474e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCClassDefineInfo; 40484e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40494e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40504e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxContainer container; 40514e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc endLoc; 40524e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxEndContainerInfo; 40534e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4054aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidistypedef enum { 4055aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis CXIdxEntityRef_Direct = 1, 4056aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis CXIdxEntityRef_ImplicitProperty = 2 4057aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis} CXIdxEntityRefKind; 4058aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis 40594e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40604e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXCursor cursor; 40614e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 40624e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity referencedEntity; 40634e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity parentEntity; 40644e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxContainer container; 4065aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis CXIdxEntityRefKind kind; 40664e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxEntityRefInfo; 40674e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40684e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40694e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*diagnostic)(CXClientData client_data, 40704e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXDiagnostic, void *reserved); 40714e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40724e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxFile (*recordFile)(CXClientData client_data, 40734e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXFile file, void *reserved); 40744e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40754e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*ppIncludedFile)(CXClientData client_data, 40764e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxIncludedFileInfo *); 40774e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40784e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxMacro (*ppMacroDefined)(CXClientData client_data, 40794e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxMacroDefinedInfo *); 40804e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40814e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*ppMacroUndefined)(CXClientData client_data, 40824e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxMacroUndefinedInfo *); 40834e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40844e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*ppMacroExpanded)(CXClientData client_data, 40854e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxMacroExpandedInfo *); 40864e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40874e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxASTFile (*importedASTFile)(CXClientData client_data, 40884e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxImportedASTFileInfo *); 40894e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40904e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity (*importedEntity)(CXClientData client_data, 40914e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxImportedEntityInfo *); 40924e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40934e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity (*importedMacro)(CXClientData client_data, 40944e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxImportedMacroInfo *); 40954e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40964e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxContainer (*startedTranslationUnit)(CXClientData client_data, 40974e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void *reserved); 40984e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40994e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity (*indexTypedef)(CXClientData client_data, 41004e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxTypedefInfo *); 41014e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41024e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity (*indexFunction)(CXClientData client_data, 41034e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxFunctionInfo *); 41044e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41054e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*indexFunctionRedeclaration)(CXClientData client_data, 41064e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxFunctionRedeclInfo *); 41074e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41084e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity (*indexVariable)(CXClientData client_data, 41094e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxVariableInfo *); 41104e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41114e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*indexVariableRedeclaration)(CXClientData client_data, 41124e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxVariableRedeclInfo *); 41134e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41144e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity (*indexTagType)(CXClientData client_data, 41154e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxTagTypeInfo *); 41164e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41174e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*indexTagTypeRedeclaration)(CXClientData client_data, 41184e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxTagTypeRedeclInfo *); 41194e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41204e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity (*indexField)(CXClientData client_data, 41214e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxFieldInfo *); 41224e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41234e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity (*indexEnumerator)(CXClientData client_data, 41244e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEnumeratorInfo *); 41254e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41264e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxContainer (*startedTagTypeDefinition)(CXClientData client_data, 41274e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxTagTypeDefinitionInfo *); 41284e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41294e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity (*indexObjCClass)(CXClientData client_data, 41304e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxObjCClassInfo *); 41314e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41324e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity (*indexObjCProtocol)(CXClientData client_data, 41334e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxObjCProtocolInfo *); 41344e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41354e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity (*indexObjCCategory)(CXClientData client_data, 41364e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxObjCCategoryInfo *); 41374e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41384e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity (*indexObjCMethod)(CXClientData client_data, 41394e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxObjCMethodInfo *); 41404e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41414e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntity (*indexObjCProperty)(CXClientData client_data, 41424e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxObjCPropertyInfo *); 41434e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41444e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*indexObjCMethodRedeclaration)(CXClientData client_data, 41454e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxObjCMethodRedeclInfo *); 41464e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41474e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxContainer (*startedStatementBody)(CXClientData client_data, 41484e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxStmtBodyInfo *); 41494e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41504e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxContainer (*startedObjCContainer)(CXClientData client_data, 41514e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxObjCContainerInfo *); 41524e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41534e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*defineObjCClass)(CXClientData client_data, 41544e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxObjCClassDefineInfo *); 41554e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41564e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*endedContainer)(CXClientData client_data, 41574e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEndContainerInfo *); 41584e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41594e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*indexEntityReference)(CXClientData client_data, 41604e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntityRefInfo *); 41614e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41624e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} IndexerCallbacks; 41634e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41644e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCINDEX_LINKAGE int clang_indexTranslationUnit(CXIndex CIdx, 41654e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXClientData client_data, 41664e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis IndexerCallbacks *index_callbacks, 41674e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned index_callbacks_size, 41684e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned index_options, 41694e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *source_filename, 41704e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char * const *command_line_args, 41714e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int num_command_line_args, 41724e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis struct CXUnsavedFile *unsaved_files, 41734e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned num_unsaved_files, 41744e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXTranslationUnit *out_TU, 41754e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned TU_options); 41764e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41774e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc, 41784e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxFile *indexFile, 41794e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXFile *file, 41804e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned *line, 41814e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned *column, 41824e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned *offset); 41834e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41844e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCINDEX_LINKAGE 41854e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc); 41864e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4187aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis/** 4188aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * @} 4189aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis */ 4190aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4191c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 4192c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 4193c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 41941efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 4195d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifdef __cplusplus 4196d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek} 4197d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 4198d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 4199d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 4200