Index.h revision 044e645605c6d75223e33d23e3c5701cb389969f
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/** 525153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief A group of CXDiagnostics. 526153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 527153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenektypedef void *CXDiagnosticSet; 528153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 529153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 530153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Determine the number of diagnostics in a CXDiagnosticSet. 531153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 532153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags); 533153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 534153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 535153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet. 536153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * 537153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \param Unit the CXDiagnosticSet to query. 538153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \param Index the zero-based diagnostic number to retrieve. 539153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * 540153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \returns the requested diagnostic. This diagnostic must be freed 541153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * via a call to \c clang_disposeDiagnostic(). 542153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 543153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags, 544153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek unsigned Index); 545153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 546153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 547153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 548153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Describes the kind of error that occurred (if any) in a call to 549153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \c clang_loadDiagnostics. 550153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 551153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenekenum CXLoadDiag_Error { 552153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek /** 553153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Indicates that no error occurred. 554153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 555153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXLoadDiag_None = 0, 556153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 557153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek /** 558153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Indicates that an unknown error occurred while attempting to 559153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * deserialize diagnostics. 560153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 561153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXLoadDiag_Unknown = 1, 562153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 563153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek /** 564153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Indicates that the file containing the serialized diagnostics 565153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * could not be opened. 566153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 567153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXLoadDiag_CannotLoad = 2, 568153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 569153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek /** 570153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Indicates that the serialized diagnostics file is invalid or 571153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * corrupt. 572153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 573153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXLoadDiag_InvalidFile = 3 574153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek}; 575153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 576153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 577153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode 578153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * file. 579153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * 580153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \param The name of the file to deserialize. 581153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \param A pointer to a enum value recording if there was a problem 582153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * deserializing the diagnostics. 583153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \param A pointer to a CXString for recording the error string 584153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * if the file was not successfully loaded. 585153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * 586153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise. These 587153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * diagnostics should be released using clang_disposeDiagnosticSet(). 588153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 589153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file, 590153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek enum CXLoadDiag_Error *error, 591153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXString *errorString); 592153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 593153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 594153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Release a CXDiagnosticSet and all of its contained diagnostics. 595153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 596153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags); 597153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 598153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 599153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Retrieve the child diagnostics of a CXDiagnostic. This 600153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * CXDiagnosticSet does not need to be released by clang_diposeDiagnosticSet. 601153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 602153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D); 603153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 604153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 605a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced for the given 606a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * translation unit. 607a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 608a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit); 609a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 610a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 611a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given translation unit. 6125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 613a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Unit the translation unit to query. 614a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 6155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 616a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 617a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 6185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 619a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit, 620a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 621a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 622a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 6230373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek * \brief Retrieve the complete set of diagnostics associated with a 6240373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek * translation unit. 6250373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek * 6260373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek * \param Unit the translation unit to query. 6270373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek */ 6280373fcc3e5b205cc26656c70d7dff737b0e08345Ted KremenekCINDEX_LINKAGE CXDiagnosticSet 6290373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek clang_getDiagnosticSetFromTU(CXTranslationUnit Unit); 6300373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek 6310373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek/** 632a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Destroy a diagnostic. 633a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 634a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic); 6355352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6365352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6370a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Options to control the display of diagnostics. 6380a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6390a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * The values in this enum are meant to be combined to customize the 6400a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * behavior of \c clang_displayDiagnostic(). 6410a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 6420a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregorenum CXDiagnosticDisplayOptions { 6430a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 6440a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Display the source-location information where the 6450a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic was located. 6460a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6470a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * When set, diagnostics will be prefixed by the file, line, and 6480a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * (optionally) column to which the diagnostic refers. For example, 6490a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6500a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \code 6510a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * test.c:28: warning: extra tokens at end of #endif directive 6520a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \endcode 6530a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6540a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-source-location. 6550a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 6560a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplaySourceLocation = 0x01, 6570a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 6580a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 6590a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 6600a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include the column number. 6610a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6620a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-column. 6630a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 6640a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplayColumn = 0x02, 6650a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 6660a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 6670a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 6680a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include information about source ranges in a 6690a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * machine-parsable format. 6700a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 671896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * This option corresponds to the clang flag 6720a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \c -fdiagnostics-print-source-range-info. 6730a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 674aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplaySourceRanges = 0x04, 675aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 676aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 677aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the option name associated with this diagnostic, if any. 678aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 679aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The option name displayed (e.g., -Wconversion) will be placed in brackets 680aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * after the diagnostic text. This option corresponds to the clang flag 681aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-option. 682aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 683aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayOption = 0x08, 684aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 685aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 686aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the category number associated with this diagnostic, if any. 687aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 688aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The category number is displayed within brackets after the diagnostic text. 689aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * This option corresponds to the clang flag 690aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-category=id. 691aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 692aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayCategoryId = 0x10, 693aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 694aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 695aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the category name associated with this diagnostic, if any. 696aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 697aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The category name is displayed within brackets after the diagnostic text. 698aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * This option corresponds to the clang flag 699aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-category=name. 700aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 701aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayCategoryName = 0x20 7020a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor}; 7030a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 7040a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 705274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \brief Format the given diagnostic in a manner that is suitable for display. 7060a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 707274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * This routine will format the given diagnostic to a string, rendering 708896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the diagnostic according to the various options given. The 709896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \c clang_defaultDiagnosticDisplayOptions() function returns the set of 7100a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * options that most closely mimics the behavior of the clang compiler. 7110a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 7120a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \param Diagnostic The diagnostic to print. 7130a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 714896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Options A set of options that control the diagnostic display, 7150a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * created by combining \c CXDiagnosticDisplayOptions values. 716274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * 717274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \returns A new string containing for formatted diagnostic. 7180a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 719274f1906f12ebf8fcc179701deeda6d3271120c1Douglas GregorCINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic, 720274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor unsigned Options); 7210a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 7220a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 7230a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Retrieve the set of display options most similar to the 7240a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * default behavior of the clang compiler. 7250a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 7260a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \returns A set of display options suitable for use with \c 7270a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * clang_displayDiagnostic(). 7280a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 7290a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void); 7300a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 7310a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 7325352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the severity of the given diagnostic. 7335352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 734896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE enum CXDiagnosticSeverity 7355352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getDiagnosticSeverity(CXDiagnostic); 7365352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 7375352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7385352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the source location of the given diagnostic. 7395352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7405352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * This location is where Clang would print the caret ('^') when 7415352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * displaying the diagnostic on the command line. 7425352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 7435352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic); 7445352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 7455352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7465352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the text of the given diagnostic. 7475352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 7485352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic); 749a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor 750a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor/** 751aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the name of the command-line option that enabled this 752aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostic. 753aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 754aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Diag The diagnostic to be queried. 755aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 756aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Disable If non-NULL, will be set to the option that disables this 757aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostic (if any). 758aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 759aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns A string that contains the command-line option used to enable this 760aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * warning, such as "-Wconversion" or "-pedantic". 761aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 762aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag, 763aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXString *Disable); 764aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 765aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 766aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the category number for this diagnostic. 767aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 768aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * Diagnostics can be categorized into groups along with other, related 769aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostics (e.g., diagnostics under the same warning flag). This routine 770aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * retrieves the category number for the given diagnostic. 771aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 772aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns The number of the category that contains this diagnostic, or zero 773aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * if this diagnostic is uncategorized. 774aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 775aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic); 776aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 777aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 778aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the name of a particular diagnostic category. 779aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 780aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Category A diagnostic category number, as returned by 781aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c clang_getDiagnosticCategory(). 782aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 783aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns The name of the given diagnostic category. 784aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 785aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticCategoryName(unsigned Category); 786aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 787aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 788a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Determine the number of source ranges associated with the given 789a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * diagnostic. 790a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor */ 791a3890baf1256ff26081306c7fef70202f8223f41Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic); 792896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 7935352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 794a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Retrieve a source range associated with the diagnostic. 7955352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 796a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * A diagnostic's source ranges highlight important elements in the source 7975352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * code. On the command line, Clang displays source ranges by 798896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * underlining them with '~' characters. 7995352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 800a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \param Diagnostic the diagnostic whose range is being extracted. 8015352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 802896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Range the zero-based index specifying which range to 8035352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 804a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \returns the requested source range. 8055352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 806896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic, 807a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor unsigned Range); 8085352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 8095352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 8105352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the number of fix-it hints associated with the 8115352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * given diagnostic. 8125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 8135352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic); 8145352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 8155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 816473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \brief Retrieve the replacement information for a given fix-it. 8175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 818473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * Fix-its are described in terms of a source range whose contents 819473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * should be replaced by a string. This approach generalizes over 820473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * three kinds of operations: removal of source code (the range covers 821473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * the code to be removed and the replacement string is empty), 822473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replacement of source code (the range covers the code to be 823473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced and the replacement string provides the new code), and 824473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion (both the start and end of the range point at the 825473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion location, and the replacement string provides the text to 826473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insert). 8275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 828473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param Diagnostic The diagnostic whose fix-its are being queried. 8295352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 830473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param FixIt The zero-based index of the fix-it. 8315352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 832473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param ReplacementRange The source range whose contents will be 833473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced with the returned replacement string. Note that source 834473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * ranges are half-open ranges [a, b), so the source code should be 835473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced from a and up to (but not including) b. 8365352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 837473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \returns A string containing text that should be replace the source 838473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * code indicated by the \c ReplacementRange. 8395352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 840896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic, 841473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor unsigned FixIt, 842473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor CXSourceRange *ReplacementRange); 8435352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 8445352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 8455352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 8465352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 8475352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 8485352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 8495352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation 8505352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8515352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * The routines in this group provide the ability to create and destroy 8525352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * translation units from files, either by parsing the contents of the files or 8535352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * by reading in a serialized representation of a translation unit. 8545352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8555352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @{ 8565352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 857896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 8585352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 8595352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Get the original translation unit source file name. 8605352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 8615352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString 8625352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getTranslationUnitSpelling(CXTranslationUnit CTUnit); 8635352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 8645352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 8655352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Return the CXTranslationUnit for a given source file and the provided 8665352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * command line arguments one would pass to the compiler. 8675352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8685352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: The 'source_filename' argument is optional. If the caller provides a 8695352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * NULL pointer, the name of the source file is expected to reside in the 8705352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * specified command line arguments. 8715352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8725352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: When encountered in 'clang_command_line_args', the following options 8735352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * are ignored: 8745352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8755352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-c' 8765352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-emit-ast' 8775352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-fsyntax-only' 8785352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-o <output file>' (both '-o' and '<output file>' are ignored) 8795352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8801ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param CIdx The index object with which the translation unit will be 8811ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * associated. 8825352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8835352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param source_filename - The name of the source file to load, or NULL if the 8841ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * source file is included in \p clang_command_line_args. 8851ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * 8861ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param num_clang_command_line_args The number of command-line arguments in 8871ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \p clang_command_line_args. 8881ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * 8891ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param clang_command_line_args The command-line arguments that would be 8901ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * passed to the \c clang executable if it were being invoked out-of-process. 8911ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * These command-line options will be parsed and will affect how the translation 8921ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * unit is parsed. Note that the following options are ignored: '-c', 8931ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'. 8945352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8955352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 8965352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * unsaved_files. 8975352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8985352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 8995352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * but may be required for code completion, including the contents of 900c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * those files. The contents and name of these files (as specified by 901c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * CXUnsavedFile) are copied when necessary, so the client only needs to 902c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * guarantee their validity until the call to this function returns. 9035352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 9045352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile( 9055352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXIndex CIdx, 9065352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor const char *source_filename, 9075352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor int num_clang_command_line_args, 9082ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *clang_command_line_args, 9095352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor unsigned num_unsaved_files, 910a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor struct CXUnsavedFile *unsaved_files); 911896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 9125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 9135352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Create a translation unit from an AST file (-emit-ast). 9145352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 915896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(CXIndex, 916a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const char *ast_filename); 9175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 91844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor/** 91944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Flags that control the creation of translation units. 92044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 92144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * The enumerators in this enumeration type are meant to be bitwise 92244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * ORed together to specify which options should be used when 92344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * constructing the translation unit. 92444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 9255a43021ac491bf091494167127772a20d9a9bb48Douglas Gregorenum CXTranslationUnit_Flags { 9265a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 9275a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that no special translation-unit options are 9285a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * needed. 9295a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 9305a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor CXTranslationUnit_None = 0x0, 9315a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 9325a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 9335a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that the parser should construct a "detailed" 9345a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * preprocessing record, including all macro definitions and instantiations. 9355a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9365a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * Constructing a detailed preprocessing record requires more memory 9375a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * and time to parse, since the information contained in the record 9385a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is usually not retained. However, it can be useful for 9395a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * applications that require more detailed information about the 9405a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * behavior of the preprocessor. 9415a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 94244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor CXTranslationUnit_DetailedPreprocessingRecord = 0x01, 94344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 94444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 945b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Used to indicate that the translation unit is incomplete. 94644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 947b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * When a translation unit is considered "incomplete", semantic 948b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * analysis that is typically performed at the end of the 949b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * translation unit will be suppressed. For example, this suppresses 950b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * the completion of tentative declarations in C and of 951b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * instantiation of implicitly-instantiation function templates in 952b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * C++. This option is typically used when parsing a header with the 953b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * intent of producing a precompiled header. 95444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 955b1c031be513705d924038f497279b9b599868ba1Douglas Gregor CXTranslationUnit_Incomplete = 0x02, 95644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 95744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 95844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Used to indicate that the translation unit should be built with an 95944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header for the preamble. 96044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 96144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * An implicit precompiled header is used as an optimization when a 96244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * particular translation unit is likely to be reparsed many times 96344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * when the sources aren't changing that often. In this case, an 96444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header will be built containing all of the 96544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * initial includes at the top of the main file (what we refer to as 96644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * the "preamble" of the file). In subsequent parses, if the 96744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * preamble or the files in it have not changed, \c 96844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * clang_reparseTranslationUnit() will re-use the implicit 96944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * precompiled header to improve parsing performance. 97044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 971e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXTranslationUnit_PrecompiledPreamble = 0x04, 972e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 973e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 974e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that the translation unit should cache some 975e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion results with each reparse of the source file. 976e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 977e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * Caching of code-completion results is a performance optimization that 978e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * introduces some overhead to reparsing but improves the performance of 979e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion operations. 980e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 98199ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CacheCompletionResults = 0x08, 98299ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 983b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * \brief DEPRECATED: Enable precompiled preambles in C++. 98499ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 98599ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 986b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * we are testing C++ precompiled preamble support. It is deprecated. 98799ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 98899ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CXXPrecompiledPreamble = 0x10, 98999ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor 99099ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 991b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * \brief DEPRECATED: Enabled chained precompiled preambles in C++. 99299ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 99399ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 994b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * we are testing C++ precompiled preamble support. It is deprecated. 99599ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 996e1d4330adaaa7faf093e725c9c993207eb2d778aArgyrios Kyrtzidis CXTranslationUnit_CXXChainedPCH = 0x20 9975a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor}; 9985a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 9995a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor/** 1000b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Returns the set of flags that is suitable for parsing a translation 1001b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * unit that is being edited. 1002b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * 1003b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * The set of flags returned provide options for \c clang_parseTranslationUnit() 1004b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * to indicate that the translation unit is likely to be reparsed many times, 1005b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly 1006b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag 1007b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set contains an unspecified set of optimizations (e.g., the precompiled 1008b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * preamble) geared toward improving the performance of these routines. The 1009b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set of optimizations enabled may change from one version to the next. 1010b1c031be513705d924038f497279b9b599868ba1Douglas Gregor */ 1011e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void); 1012b1c031be513705d924038f497279b9b599868ba1Douglas Gregor 1013b1c031be513705d924038f497279b9b599868ba1Douglas Gregor/** 10145a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Parse the given source file and the translation unit corresponding 10155a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * to that file. 10165a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10175a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * This routine is the main entry point for the Clang C API, providing the 10185a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * ability to parse a source file into a translation unit that can then be 10195a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * queried by other functions in the API. This routine accepts a set of 10205a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * command-line arguments so that the compilation can be configured in the same 10215a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * way that the compiler is configured on the command line. 10225a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10235a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param CIdx The index object with which the translation unit will be 10245a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * associated. 10255a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10265a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param source_filename The name of the source file to load, or NULL if the 10271ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * source file is included in \p command_line_args. 10285a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10295a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param command_line_args The command-line arguments that would be 10305a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * passed to the \c clang executable if it were being invoked out-of-process. 10315a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * These command-line options will be parsed and will affect how the translation 10325a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unit is parsed. Note that the following options are ignored: '-c', 10335a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'. 10345a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10355a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_command_line_args The number of command-line arguments in 10365a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \p command_line_args. 10375a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10385a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 10391abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing, including the contents of 10405a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * those files. The contents and name of these files (as specified by 10415a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 10425a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * guarantee their validity until the call to this function returns. 10435a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10445a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 10455a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unsaved_files. 10465a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10475a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param options A bitmask of options that affects how the translation unit 10485a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is managed but not its compilation. This should be a bitwise OR of the 10495a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXTranslationUnit_XXX flags. 10505a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10515a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \returns A new translation unit describing the parsed code and containing 10525a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * any diagnostics produced by the compiler. If there is a failure from which 10535a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * the compiler cannot recover, returns NULL. 10545a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 10555a43021ac491bf091494167127772a20d9a9bb48Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx, 10565a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor const char *source_filename, 10572ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *command_line_args, 10585a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor int num_command_line_args, 10595a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor struct CXUnsavedFile *unsaved_files, 10605a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned num_unsaved_files, 10615a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned options); 10625a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 10635352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 10641999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Flags that control how translation units are saved. 10651999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 10661999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 10671999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * ORed together to specify which options should be used when 10681999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * saving the translation unit. 10691999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 10701999844e7a18786e61e619e1dc6c789827541863Douglas Gregorenum CXSaveTranslationUnit_Flags { 10711999844e7a18786e61e619e1dc6c789827541863Douglas Gregor /** 10721999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Used to indicate that no special saving options are needed. 10731999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 10741999844e7a18786e61e619e1dc6c789827541863Douglas Gregor CXSaveTranslationUnit_None = 0x0 10751999844e7a18786e61e619e1dc6c789827541863Douglas Gregor}; 10761999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 10771999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 10781999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Returns the set of flags that is suitable for saving a translation 10791999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * unit. 10801999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 10811999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The set of flags returned provide options for 10821999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \c clang_saveTranslationUnit() by default. The returned flag 10831999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * set contains an unspecified set of options that save translation units with 10841999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * the most commonly-requested data. 10851999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 10861999844e7a18786e61e619e1dc6c789827541863Douglas GregorCINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU); 10871999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 10881999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 108939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Describes the kind of error that occurred (if any) in a call to 109039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \c clang_saveTranslationUnit(). 109139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 109239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregorenum CXSaveError { 109339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 109439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that no error occurred while saving a translation unit. 109539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 109639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_None = 0, 109739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 109839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 109939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that an unknown error occurred while attempting to save 110039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * the file. 110139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * 110239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * This error typically indicates that file I/O failed when attempting to 110339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * write the file. 110439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 110539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_Unknown = 1, 110639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 110739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 110839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that errors during translation prevented this attempt 110939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * to save the translation unit. 111039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * 111139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * Errors that prevent the translation unit from being saved can be 111239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic(). 111339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 111439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_TranslationErrors = 2, 111539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 111639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 111739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that the translation unit to be saved was somehow 111839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * invalid (e.g., NULL). 111939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 112039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_InvalidTU = 3 112139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor}; 112239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 112339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor/** 11247ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \brief Saves a translation unit into a serialized representation of 11257ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * that translation unit on disk. 11267ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 11277ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * Any translation unit that was parsed without error can be saved 11287ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * into a file. The translation unit can then be deserialized into a 11297ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * new \c CXTranslationUnit with \c clang_createTranslationUnit() or, 11307ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * if it is an incomplete translation unit that corresponds to a 11317ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * header, used as a precompiled header when parsing other translation 11327ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * units. 11337ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 11347ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param TU The translation unit to save. 11351999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 11367ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param FileName The file to which the translation unit will be saved. 11377ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 11381999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \param options A bitmask of options that affects how the translation unit 11391999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * is saved. This should be a bitwise OR of the 11401999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * CXSaveTranslationUnit_XXX flags. 11411999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 114239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \returns A value that will match one of the enumerators of the CXSaveError 114339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * enumeration. Zero (CXSaveError_None) indicates that the translation unit was 114439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * saved successfully, while a non-zero value indicates that a problem occurred. 11457ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor */ 11467ae2faafd30524ef5f863bb3b8701977888839bbDouglas GregorCINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU, 11471999844e7a18786e61e619e1dc6c789827541863Douglas Gregor const char *FileName, 11481999844e7a18786e61e619e1dc6c789827541863Douglas Gregor unsigned options); 11497ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 11507ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor/** 11515352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Destroy the specified CXTranslationUnit object. 11525352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 11535352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit); 1154896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 11555352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 1156e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Flags that control the reparsing of translation units. 1157e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1158e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 1159e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * ORed together to specify which options should be used when 1160e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * reparsing the translation unit. 1161e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1162e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregorenum CXReparse_Flags { 1163e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 1164e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that no special reparsing options are needed. 1165e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1166e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXReparse_None = 0x0 1167e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor}; 1168e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 1169e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 1170e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Returns the set of flags that is suitable for reparsing a translation 1171e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * unit. 1172e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1173e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The set of flags returned provide options for 1174e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \c clang_reparseTranslationUnit() by default. The returned flag 1175e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * set contains an unspecified set of optimizations geared toward common uses 1176e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * of reparsing. The set of optimizations enabled may change from one version 1177e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * to the next. 1178e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1179e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU); 1180e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 1181e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 1182abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \brief Reparse the source files that produced this translation unit. 1183abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1184abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * This routine can be used to re-parse the source files that originally 1185abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * created the given translation unit, for example because those source files 1186abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * have changed (either on disk or as passed via \p unsaved_files). The 1187abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * source code will be reparsed with the same command-line options as it 1188abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * was originally parsed. 1189abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1190abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * Reparsing a translation unit invalidates all cursors and source locations 1191abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * that refer into that translation unit. This makes reparsing a translation 1192abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit semantically equivalent to destroying the translation unit and then 1193abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * creating a new translation unit with the same command-line arguments. 1194abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * However, it may be more efficient to reparse a translation 1195abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit using this routine. 1196abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1197abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param TU The translation unit whose contents will be re-parsed. The 1198abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * translation unit must originally have been built with 1199abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_createTranslationUnitFromSourceFile(). 1200abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1201abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 1202abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unsaved_files. 1203abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1204abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param unsaved_files The files that have not yet been saved to disk 1205abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * but may be required for parsing, including the contents of 1206abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * those files. The contents and name of these files (as specified by 1207abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 1208abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * guarantee their validity until the call to this function returns. 1209abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1210e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \param options A bitset of options composed of the flags in CXReparse_Flags. 1211e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The function \c clang_defaultReparseOptions() produces a default set of 1212e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * options recommended for most uses, based on the translation unit. 1213e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1214abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \returns 0 if the sources could be reparsed. A non-zero value will be 1215abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * returned if reparsing was impossible, such that the translation unit is 1216abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * invalid. In such cases, the only valid call for \p TU is 1217abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_disposeTranslationUnit(TU). 1218abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor */ 1219abc563f554951259bbe0315055cad92ee14d87e4Douglas GregorCINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU, 1220abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned num_unsaved_files, 1221e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor struct CXUnsavedFile *unsaved_files, 1222e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor unsigned options); 122359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 122459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 122559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Categorizes how memory is being used by a translation unit. 122659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1227f787002478f09af1741fb0f82a562002e6799c49Ted Kremenekenum CXTUResourceUsageKind { 1228f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_AST = 1, 1229f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_Identifiers = 2, 1230f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_Selectors = 3, 1231f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_GlobalCompletionResults = 4, 1232457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek CXTUResourceUsage_SourceManagerContentCache = 5, 1233ba29bd25515fbd99e98ba0fedb9d93617b27609eTed Kremenek CXTUResourceUsage_AST_SideTables = 6, 1234f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7, 1235e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_SourceManager_Membuffer_MMap = 8, 1236e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9, 1237e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10, 12385e1db6a434d0e3fe0fbde0bca2ec44552818fb22Ted Kremenek CXTUResourceUsage_Preprocessor = 11, 12395e1db6a434d0e3fe0fbde0bca2ec44552818fb22Ted Kremenek CXTUResourceUsage_PreprocessingRecord = 12, 1240ca7dc2b755eb81ac95121ce1a1f1aa44a4a0fe12Ted Kremenek CXTUResourceUsage_SourceManager_DataStructures = 13, 1241d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Preprocessor_HeaderSearch = 14, 1242f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST, 1243f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_MEMORY_IN_BYTES_END = 1244d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Preprocessor_HeaderSearch, 1245f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek 1246f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_First = CXTUResourceUsage_AST, 1247d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch 124859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek}; 124959fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 125059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 125159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Returns the human-readable null-terminated C string that represents 1252f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek * the name of the memory category. This string should never be freed. 125359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 125459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted KremenekCINDEX_LINKAGE 1255f787002478f09af1741fb0f82a562002e6799c49Ted Kremenekconst char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind); 125659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1257f787002478f09af1741fb0f82a562002e6799c49Ted Kremenektypedef struct CXTUResourceUsageEntry { 125859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief The memory usage category. */ 1259f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek enum CXTUResourceUsageKind kind; 1260f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek /* \brief Amount of resources used. 1261f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek The units will depend on the resource kind. */ 126259fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek unsigned long amount; 1263f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek} CXTUResourceUsageEntry; 126459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 126559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 126659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief The memory usage of a CXTranslationUnit, broken into categories. 126759fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1268f787002478f09af1741fb0f82a562002e6799c49Ted Kremenektypedef struct CXTUResourceUsage { 126959fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief Private data member, used for queries. */ 127059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek void *data; 127159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 127259fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief The number of entries in the 'entries' array. */ 127359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek unsigned numEntries; 127459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 127559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief An array of key-value pairs, representing the breakdown of memory 127659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek usage. */ 1277f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsageEntry *entries; 127859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1279f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek} CXTUResourceUsage; 128059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 128159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 128259fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Return the memory usage of a translation unit. This object 1283f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek * should be released with clang_disposeCXTUResourceUsage(). 128459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1285f787002478f09af1741fb0f82a562002e6799c49Ted KremenekCINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU); 128659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1287f787002478f09af1741fb0f82a562002e6799c49Ted KremenekCINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage); 128859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1289abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor/** 12905352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 12915352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 1292896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 12935352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 1294c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes the kind of entity that a cursor refers to. 1295c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1296c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXCursorKind { 1297c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Declarations */ 12981efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1299c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A declaration whose specific kind is not exposed via this 13001efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 1301c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1302c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed declarations have the same operations as any other kind 1303c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of declaration; one can extract their location information, 1304c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, find their definitions, etc. However, the specific kind 1305c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of the declaration is not reported. 1306c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1307c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedDecl = 1, 1308c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ struct. */ 13091efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_StructDecl = 2, 1310c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ union. */ 1311c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnionDecl = 3, 1312c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C++ class. */ 1313c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ClassDecl = 4, 1314c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumeration. */ 1315c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumDecl = 5, 13161efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1317c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A field (in C) or non-static data member (in C++) in a 1318c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * struct, union, or C++ class. 1319c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1320c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FieldDecl = 6, 1321c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumerator constant. */ 1322c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumConstantDecl = 7, 1323c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function. */ 1324c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FunctionDecl = 8, 1325c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A variable. */ 1326c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_VarDecl = 9, 1327c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function or method parameter. */ 1328c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ParmDecl = 10, 1329c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @interface. */ 1330c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInterfaceDecl = 11, 1331c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @interface for a category. */ 1332c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryDecl = 12, 1333c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @protocol declaration. */ 1334c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolDecl = 13, 1335c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @property declaration. */ 1336c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCPropertyDecl = 14, 1337c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance variable. */ 1338c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCIvarDecl = 15, 1339c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance method. */ 1340c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInstanceMethodDecl = 16, 1341c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C class method. */ 1342c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassMethodDecl = 17, 1343c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @implementation. */ 1344c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCImplementationDecl = 18, 1345c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @implementation for a category. */ 1346c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryImplDecl = 19, 1347c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A typedef */ 1348c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypedefDecl = 20, 13498bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek /** \brief A C++ class method. */ 13508bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek CXCursor_CXXMethod = 21, 13518f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek /** \brief A C++ namespace. */ 13528f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek CXCursor_Namespace = 22, 1353a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek /** \brief A linkage specification, e.g. 'extern "C"'. */ 1354a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek CXCursor_LinkageSpec = 23, 135501829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ constructor. */ 135601829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Constructor = 24, 135701829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ destructor. */ 135801829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Destructor = 25, 135901829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ conversion function. */ 136001829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_ConversionFunction = 26, 1361fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template type parameter. */ 1362fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTypeParameter = 27, 1363fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ non-type template parameter. */ 1364fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_NonTypeTemplateParameter = 28, 1365fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template template parameter. */ 1366fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTemplateParameter = 29, 1367fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ function template. */ 1368fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_FunctionTemplate = 30, 136939d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor /** \brief A C++ class template. */ 137039d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor CXCursor_ClassTemplate = 31, 137174dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor /** \brief A C++ class template partial specialization. */ 137274dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor CXCursor_ClassTemplatePartialSpecialization = 32, 13736931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** \brief A C++ namespace alias declaration. */ 13746931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceAlias = 33, 13750a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor /** \brief A C++ using directive. */ 13760a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor CXCursor_UsingDirective = 34, 1377162e1c1b487352434552147967c3dd296ebee2f7Richard Smith /** \brief A C++ using declaration. */ 13787e24256c95afb64b4d5abf201a0f9f0527cb4cf3Douglas Gregor CXCursor_UsingDeclaration = 35, 1379162e1c1b487352434552147967c3dd296ebee2f7Richard Smith /** \brief A C++ alias declaration */ 1380162e1c1b487352434552147967c3dd296ebee2f7Richard Smith CXCursor_TypeAliasDecl = 36, 1381352697a87bca664356f21a838b162084013625eaDouglas Gregor /** \brief An Objective-C @synthesize definition. */ 1382352697a87bca664356f21a838b162084013625eaDouglas Gregor CXCursor_ObjCSynthesizeDecl = 37, 1383352697a87bca664356f21a838b162084013625eaDouglas Gregor /** \brief An Objective-C @dynamic definition. */ 1384352697a87bca664356f21a838b162084013625eaDouglas Gregor CXCursor_ObjCDynamicDecl = 38, 13852dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis /** \brief An access specifier. */ 13862dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis CXCursor_CXXAccessSpecifier = 39, 138742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 138850aa6acd0b8d40c8956372a69e0a73f0802a5494Ted Kremenek CXCursor_FirstDecl = CXCursor_UnexposedDecl, 13892dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis CXCursor_LastDecl = CXCursor_CXXAccessSpecifier, 13901efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1391c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* References */ 1392c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstRef = 40, /* Decl references */ 13931efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_ObjCSuperClassRef = 40, 1394c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolRef = 41, 1395c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassRef = 42, 1396c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1397c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A reference to a type declaration. 1398c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1399c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A type reference occurs anywhere where a type is named but not 1400c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * declared. For example, given: 1401c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1402c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \code 1403c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * typedef unsigned size_type; 1404c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * size_type size; 1405c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \endcode 1406c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1407c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The typedef is a declaration of size_type (CXCursor_TypedefDecl), 1408c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * while the type of the variable "size" is referenced. The cursor 1409c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * referenced by the type of size is the typedef for size_type. 1410c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1411c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypeRef = 43, 14123064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CXCursor_CXXBaseSpecifier = 44, 14130b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor /** 1414a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * \brief A reference to a class template, function template, template 1415a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * template parameter, or class template partial specialization. 14160b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor */ 14170b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor CXCursor_TemplateRef = 45, 14186931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** 14196931900f43cea558c6974075256c07728dbfecc6Douglas Gregor * \brief A reference to a namespace or namespace alias. 14206931900f43cea558c6974075256c07728dbfecc6Douglas Gregor */ 14216931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceRef = 46, 1422a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor /** 142336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a member of a struct, union, or class that occurs in 142436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * some non-expression context, e.g., a designated initializer. 1425a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor */ 1426a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor CXCursor_MemberRef = 47, 142736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** 142836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a labeled statement. 142936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 143036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the jump to "start_over" in the 143136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto statement in the following example: 143236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 143336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 143436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 143536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 143636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 143736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto start_over; 143836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 143936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 144036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * A label reference cursor refers to a label statement. 144136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 144236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelRef = 48, 144336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 14441f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor /** 14451f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief A reference to a set of overloaded functions or function templates 14461f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * that has not yet been resolved to a specific function or function template. 14471f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14481f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * An overloaded declaration reference cursor occurs in C++ templates where 14491f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * a dependent name refers to a function. For example: 14501f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14511f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \code 14521f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> void swap(T&, T&); 14531f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14541f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct X { ... }; 14551f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(X&, X&); 14561f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14571f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> 14581f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void reverse(T* first, T* last) { 14591f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * while (first < last - 1) { 14601f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * swap(*first, *--last); 14611f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * ++first; 14621f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 14631f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 14641f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14651f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct Y { }; 14661f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(Y&, Y&); 14671f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \endcode 14681f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14691f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * Here, the identifier "swap" is associated with an overloaded declaration 14701f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * reference. In the template definition, "swap" refers to either of the two 14711f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * "swap" functions declared above, so both results will be available. At 14721f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * instantiation time, "swap" may also refer to other functions found via 14731f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * argument-dependent lookup (e.g., the "swap" function at the end of the 14741f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * example). 14751f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14761f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * The functions \c clang_getNumOverloadedDecls() and 14771f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c clang_getOverloadedDecl() can be used to retrieve the definitions 14781f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * referenced by this cursor. 14791f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 14801f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor CXCursor_OverloadedDeclRef = 49, 14811f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 1482011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor /** 1483011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * \brief A reference to a variable that occurs in some non-expression 1484011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * context, e.g., a C++ lambda capture list. 1485011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor */ 1486011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor CXCursor_VariableRef = 50, 1487011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor 1488011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor CXCursor_LastRef = CXCursor_VariableRef, 14891efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1490c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Error conditions */ 1491c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstInvalid = 70, 1492c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_InvalidFile = 70, 1493c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NoDeclFound = 71, 1494c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NotImplemented = 72, 1495ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_InvalidCode = 73, 1496ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_LastInvalid = CXCursor_InvalidCode, 14971efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1498c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Expressions */ 1499c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstExpr = 100, 15001efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1501c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1502c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression whose specific kind is not exposed via this 15031efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 1504c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1505c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed expressions have the same operations as any other kind 1506c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of expression; one can extract their location information, 1507c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, children, etc. However, the specific kind of the 1508c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * expression is not reported. 1509c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1510c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedExpr = 100, 15111efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1512c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1513c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to some value declaration, such 1514c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * as a function, varible, or enumerator. 1515c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1516c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_DeclRefExpr = 101, 15171efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1518c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1519c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to a member of a struct, union, 1520c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * class, Objective-C class, etc. 1521c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1522c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_MemberRefExpr = 102, 15231efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1524c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that calls a function. */ 1525c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_CallExpr = 103, 15261efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1527c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that sends a message to an Objective-C 1528c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor object or class. */ 1529c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCMessageExpr = 104, 15301ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 15311ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek /** \brief An expression that represents a block literal. */ 15321ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek CXCursor_BlockExpr = 105, 15331ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 153442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An integer literal. 153542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 153642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_IntegerLiteral = 106, 153742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 153842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A floating point number literal. 153942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 154042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_FloatingLiteral = 107, 154142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 154242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An imaginary number literal. 154342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 154442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ImaginaryLiteral = 108, 154542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 154642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A string literal. 154742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 154842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_StringLiteral = 109, 154942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 155042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A character literal. 155142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 155242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CharacterLiteral = 110, 155342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 155442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A parenthesized expression, e.g. "(1)". 155542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 155642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This AST node is only formed if full location information is requested. 155742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 155842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ParenExpr = 111, 155942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 156042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief This represents the unary-expression's (except sizeof and 156142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * alignof). 156242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 156342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_UnaryOperator = 112, 156442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 156542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C99 6.5.2.1] Array Subscripting. 156642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 156742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ArraySubscriptExpr = 113, 156842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 156942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A builtin binary operation expression such as "x + y" or 157042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * "x <= y". 157142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 157242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_BinaryOperator = 114, 157342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 157442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Compound assignment such as "+=". 157542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 157642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CompoundAssignOperator = 115, 157742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 157842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief The ?: ternary operator. 157942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 158042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ConditionalOperator = 116, 158142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 158242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++ 158342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * (C++ [expr.cast]), which uses the syntax (Type)expr. 158442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 158542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * For example: (int)f. 158642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 158742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CStyleCastExpr = 117, 158842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 158942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C99 6.5.2.5] 159042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 159142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CompoundLiteralExpr = 118, 159242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 159342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Describes an C or C++ initializer list. 159442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 159542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_InitListExpr = 119, 159642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 159742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief The GNU address of label extension, representing &&label. 159842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 159942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_AddrLabelExpr = 120, 160042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 160142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief This is the GNU Statement Expression extension: ({int X=4; X;}) 160242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 160342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_StmtExpr = 121, 160442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 1605ffbe9b9c64ab2e94b9d48ec56e511f75826fc80aBenjamin Kramer /** \brief Represents a C11 generic selection. 160642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 160742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_GenericSelectionExpr = 122, 160842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 160942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Implements the GNU __null extension, which is a name for a null 161042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * pointer constant that has integral type (e.g., int or long) and is the same 161142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * size and alignment as a pointer. 161242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 161342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * The __null extension is typically only used by system headers, which define 161442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * NULL as __null in C++ rather than using 0 (which is an integer that may not 161542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * match the size of a pointer). 161642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 161742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_GNUNullExpr = 123, 161842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 161942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s static_cast<> expression. 162042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 162142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXStaticCastExpr = 124, 162242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 162342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s dynamic_cast<> expression. 162442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 162542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXDynamicCastExpr = 125, 162642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 162742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s reinterpret_cast<> expression. 162842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 162942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXReinterpretCastExpr = 126, 163042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 163142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s const_cast<> expression. 163242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 163342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXConstCastExpr = 127, 163442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 163542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents an explicit C++ type conversion that uses "functional" 163642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * notion (C++ [expr.type.conv]). 163742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 163842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * Example: 163942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 164042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * x = int(0.5); 164142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 164242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 164342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXFunctionalCastExpr = 128, 164442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 164542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A C++ typeid expression (C++ [expr.typeid]). 164642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 164742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXTypeidExpr = 129, 164842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 164942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C++ 2.13.5] C++ Boolean Literal. 165042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 165142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXBoolLiteralExpr = 130, 165242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 165342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C++0x 2.14.7] C++ Pointer Literal. 165442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 165542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXNullPtrLiteralExpr = 131, 165642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 165742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents the "this" expression in C++ 165842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 165942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXThisExpr = 132, 166042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 166142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C++ 15] C++ Throw Expression. 166242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 166342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This handles 'throw' and 'throw' assignment-expression. When 166442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * assignment-expression isn't present, Op will be null. 166542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 166642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXThrowExpr = 133, 166742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 166842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A new expression for memory allocation and constructor calls, e.g: 166942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * "new CXXNewExpr(foo)". 167042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 167142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXNewExpr = 134, 167242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 167342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A delete expression for memory deallocation and destructor calls, 167442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * e.g. "delete[] pArray". 167542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 167642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXDeleteExpr = 135, 167742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 167842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A unary expression. 167942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 168042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_UnaryExpr = 136, 168142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 16829793e8f72a2d1f420bbbd97d41f7aaf727c26ca6Douglas Gregor /** \brief An Objective-C string literal i.e. @"foo". 168342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 168442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCStringLiteral = 137, 168542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 16869793e8f72a2d1f420bbbd97d41f7aaf727c26ca6Douglas Gregor /** \brief An Objective-C @encode expression. 168742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 168842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCEncodeExpr = 138, 168942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 16909793e8f72a2d1f420bbbd97d41f7aaf727c26ca6Douglas Gregor /** \brief An Objective-C @selector expression. 169142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 169242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCSelectorExpr = 139, 169342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 16949793e8f72a2d1f420bbbd97d41f7aaf727c26ca6Douglas Gregor /** \brief An Objective-C @protocol expression. 169542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 169642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCProtocolExpr = 140, 169742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 169842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An Objective-C "bridged" cast expression, which casts between 169942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * Objective-C pointers and C pointers, transferring ownership in the process. 170042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 170142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 170242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * NSString *str = (__bridge_transfer NSString *)CFCreateString(); 170342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 170442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 170542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCBridgedCastExpr = 141, 170642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 170742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents a C++0x pack expansion that produces a sequence of 170842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * expressions. 170942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 171042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * A pack expansion expression contains a pattern (which itself is an 171142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * expression) followed by an ellipsis. For example: 171242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 171342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 171442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * template<typename F, typename ...Types> 171542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * void forward(F f, Types &&...args) { 171642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * f(static_cast<Types&&>(args)...); 171742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * } 171842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 171942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 172042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_PackExpansionExpr = 142, 172142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 172242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents an expression that computes the length of a parameter 172342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * pack. 172442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 172542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 172642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * template<typename ...Types> 172742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * struct count { 172842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * static const unsigned value = sizeof...(Types); 172942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * }; 173042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 173142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 173242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SizeOfPackExpr = 143, 173342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 1734011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor /* \brief Represents a C++ lambda expression that produces a local function 1735011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * object. 1736011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * 1737011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * \code 1738011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * void abssort(float *x, unsigned N) { 1739011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * std::sort(x, x + N, 1740011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * [](float a, float b) { 1741011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * return std::abs(a) < std::abs(b); 1742011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * }); 1743011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * } 1744011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * \endcode 1745011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor */ 1746011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor CXCursor_LambdaExpr = 144, 1747011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor 1748b3f7542a950ac0d585a7783e825cfe670e05c553Ted Kremenek /** \brief Objective-c Boolean Literal. 1749b3f7542a950ac0d585a7783e825cfe670e05c553Ted Kremenek */ 1750b3f7542a950ac0d585a7783e825cfe670e05c553Ted Kremenek CXCursor_ObjCBoolLiteralExpr = 145, 1751b3f7542a950ac0d585a7783e825cfe670e05c553Ted Kremenek 1752b3f7542a950ac0d585a7783e825cfe670e05c553Ted Kremenek CXCursor_LastExpr = CXCursor_ObjCBoolLiteralExpr, 17531efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1754c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Statements */ 1755c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstStmt = 200, 1756c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1757c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A statement whose specific kind is not exposed via this 1758c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * interface. 1759c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1760c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed statements have the same operations as any other kind of 1761c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * statement; one can extract their location information, spelling, 1762c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * children, etc. However, the specific kind of the statement is not 1763c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reported. 1764c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1765c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedStmt = 200, 176636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 176736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** \brief A labelled statement in a function. 176836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 176936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the "start_over:" label statement in 177036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * the following example: 177136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 177236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 177336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 177436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 177536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 177636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 177736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 177836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelStmt = 201, 177942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 178042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A group of statements like { stmt stmt }. 178142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 178242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This cursor kind is used to describe compound statements, e.g. function 178342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * bodies. 178442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 178542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CompoundStmt = 202, 178642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 178742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A case statment. 178842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 178942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CaseStmt = 203, 179042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 179142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A default statement. 179242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 179342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_DefaultStmt = 204, 179442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 179542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An if statement 179642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 179742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_IfStmt = 205, 179842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 179942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A switch statement. 180042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 180142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SwitchStmt = 206, 180242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 180342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A while statement. 180442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 180542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_WhileStmt = 207, 180642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 180742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A do statement. 180842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 180942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_DoStmt = 208, 181042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 181142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A for statement. 181242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 181342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ForStmt = 209, 181442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 181542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A goto statement. 181642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 181742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_GotoStmt = 210, 181842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 181942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An indirect goto statement. 182042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 182142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_IndirectGotoStmt = 211, 182242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 182342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A continue statement. 182442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 182542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ContinueStmt = 212, 182642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 182742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A break statement. 182842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 182942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_BreakStmt = 213, 183042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 183142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A return statement. 183242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 183342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ReturnStmt = 214, 183442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 183542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A GNU inline assembly statement extension. 183642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 183742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_AsmStmt = 215, 183842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 18393f54d48a75234efdbbfcd503fd316a78ffd4b50dDouglas Gregor /** \brief Objective-C's overall @try-@catch-@finally statement. 184042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 184142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtTryStmt = 216, 184242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 184342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's @catch statement. 184442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 184542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtCatchStmt = 217, 184642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 184742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's @finally statement. 184842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 184942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtFinallyStmt = 218, 185042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 185142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's @throw statement. 185242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 185342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtThrowStmt = 219, 185442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 185542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's @synchronized statement. 185642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 185742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtSynchronizedStmt = 220, 185842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 185942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's autorelease pool statement. 186042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 186142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAutoreleasePoolStmt = 221, 186242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 186342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's collection statement. 186442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 186542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCForCollectionStmt = 222, 186642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 186742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s catch statement. 186842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 186942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXCatchStmt = 223, 187042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 187142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s try statement. 187242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 187342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXTryStmt = 224, 187442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 187542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s for (* : *) statement. 187642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 187742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXForRangeStmt = 225, 187842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 187942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Windows Structured Exception Handling's try statement. 188042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 188142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SEHTryStmt = 226, 188242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 188342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Windows Structured Exception Handling's except statement. 188442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 188542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SEHExceptStmt = 227, 188642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 188742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Windows Structured Exception Handling's finally statement. 188842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 188942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SEHFinallyStmt = 228, 189042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 189142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief The null satement ";": C99 6.8.3p3. 189242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 189342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This cursor kind is used to describe the null statement. 189442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 189542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_NullStmt = 230, 189642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 189742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Adaptor class for mixing declarations with statements and 189842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * expressions. 189942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 190042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_DeclStmt = 231, 190142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 190242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_LastStmt = CXCursor_DeclStmt, 19031efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1904c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1905c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Cursor that represents the translation unit itself. 1906c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1907c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor exists primarily to act as the root 1908c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor for traversing the contents of a translation unit. 1909c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1910e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_TranslationUnit = 300, 1911e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1912e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /* Attributes */ 1913e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_FirstAttr = 400, 1914e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /** 1915e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * \brief An attribute whose specific kind is not exposed via this 1916e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * interface. 1917e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek */ 1918e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_UnexposedAttr = 400, 1919e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1920e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBActionAttr = 401, 1921e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBOutletAttr = 402, 1922857e918a8a40deb128840308a318bf623d68295fTed Kremenek CXCursor_IBOutletCollectionAttr = 403, 19236639e9255489ad8e10278d5658fdd4b3c0e1e4cdArgyrios Kyrtzidis CXCursor_CXXFinalAttr = 404, 19246639e9255489ad8e10278d5658fdd4b3c0e1e4cdArgyrios Kyrtzidis CXCursor_CXXOverrideAttr = 405, 19255f1c822def3efffe1d8f7299fbbbc3b1cdd4833dErik Verbruggen CXCursor_AnnotateAttr = 406, 192684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCursor_AsmLabelAttr = 407, 192784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCursor_LastAttr = CXCursor_AsmLabelAttr, 19289f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 19299f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor /* Preprocessing */ 19309f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_PreprocessingDirective = 500, 1931572feb2a190b5e8b04fb06c4ac50ee0f61e93ff0Douglas Gregor CXCursor_MacroDefinition = 501, 19329b2a0ac970a077bdc0bf08c6c682f80ad733c892Chandler Carruth CXCursor_MacroExpansion = 502, 19339b2a0ac970a077bdc0bf08c6c682f80ad733c892Chandler Carruth CXCursor_MacroInstantiation = CXCursor_MacroExpansion, 1934ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_InclusionDirective = 503, 19359f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective, 1936ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_LastPreprocessing = CXCursor_InclusionDirective 1937c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 1938c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1939c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1940c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A cursor representing some element in the abstract syntax tree for 1941c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a translation unit. 1942c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 19431efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor abstraction unifies the different kinds of entities in a 1944c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * program--declaration, statements, expressions, references to declarations, 1945c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * etc.--under a single "cursor" abstraction with a common set of operations. 1946c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Common operation for a cursor include: getting the physical location in 1947c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a source file where the cursor points, getting the name associated with a 1948c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor, and retrieving cursors for any child nodes of a particular cursor. 1949c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1950c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors can be produced in two specific ways. 1951c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_getTranslationUnitCursor() produces a cursor for a translation unit, 1952c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * from which one can use clang_visitChildren() to explore the rest of the 1953c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * translation unit. clang_getCursor() maps from a physical source location 1954c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to the entity that resides at that location, allowing one to map from the 1955c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * source code into the AST. 1956c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1957c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregortypedef struct { 1958c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor enum CXCursorKind kind; 1959aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis int xdata; 1960c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor void *data[3]; 19611efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar} CXCursor; 1962c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1963c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1964c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations 1965c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1966c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 1967c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 19681efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1969c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1970c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the NULL cursor, which represents no entity. 1971c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1972c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getNullCursor(void); 19731efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1974c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1975c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the cursor that represents the given translation unit. 1976c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1977c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor can be used to start traversing the 1978c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * various declarations within the given translation unit. 1979c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1980c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit); 1981c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1982c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1983c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether two cursors are equivalent. 1984c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1985c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor); 19861efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1987c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1988b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis * \brief Returns non-zero if \arg cursor is null. 1989b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis */ 19905b419362c29b7aa09d9a75a14fe1b11985625bf0Benjamin KramerCINDEX_LINKAGE int clang_Cursor_isNull(CXCursor); 1991b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis 1992b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis/** 19939ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor * \brief Compute a hash value for the given cursor. 19949ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor */ 19959ce5584553054d0cb934940586aca0186e87fa57Douglas GregorCINDEX_LINKAGE unsigned clang_hashCursor(CXCursor); 19969ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor 19979ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor/** 1998c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the kind of the given cursor. 1999c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2000c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor); 2001c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2002c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2003c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a declaration. 2004c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2005c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind); 2006c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2007c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2008c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a simple 2009c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reference. 2010c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2011c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Note that other kinds of cursors (such as expressions) can also refer to 2012c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * other cursors. Use clang_getCursorReferenced() to determine whether a 2013c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * particular cursor refers to another entity. 2014c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2015c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind); 2016c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2017c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2018c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents an expression. 2019c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2020c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind); 2021c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2022c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2023c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a statement. 2024c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2025c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind); 2026c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2027c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 20288be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor * \brief Determine whether the given cursor kind represents an attribute. 20298be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor */ 20308be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas GregorCINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind); 20318be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor 20328be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor/** 20331efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents an invalid 2034c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor. 20351efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar */ 2036c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind); 2037c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2038c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 20391efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents a translation 20401efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unit. 2041c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2042c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind); 20431efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2044ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek/*** 20459f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * \brief Determine whether the given cursor represents a preprocessing 20469f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * element, such as a preprocessor directive or macro instantiation. 20479f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor */ 20489f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas GregorCINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind); 20499f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 20509f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor/*** 2051ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * \brief Determine whether the given cursor represents a currently 2052ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt). 2053ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek */ 2054ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted KremenekCINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind); 2055ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek 2056c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 205716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief Describe the linkage of the entity referred to by a cursor. 205816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 205916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenekenum CXLinkageKind { 206016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This value indicates that no linkage information is available 206116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * for a provided CXCursor. */ 206216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Invalid, 206316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** 206416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief This is the linkage for variables, parameters, and so on that 206516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * have automatic storage. This covers normal (non-extern) local variables. 206616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 206716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_NoLinkage, 206816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for static variables and static functions. */ 206916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Internal, 207016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with external linkage that live 207116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * in C++ anonymous namespaces.*/ 207216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_UniqueExternal, 207316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with true, external linkage. */ 207416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_External 207516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek}; 207616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 207716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 207845e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the linkage of the entity referred to by a given cursor. 207916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 208016b4259aecaa22b642d35d36fd89965ed700c1e0Ted KremenekCINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor); 208116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 208216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 208358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \brief Determine the availability of the entity that this cursor refers to. 208458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 208558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param cursor The cursor to query. 208658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 208758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the cursor. 208858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 208958ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 209058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCursorAvailability(CXCursor cursor); 209158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 209258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 209345e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Describe the "language" of the entity referred to by a cursor. 209445e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 209545e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind { 20966cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_Invalid = 0, 209745e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_C, 209845e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_ObjC, 20996cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_CPlusPlus 210045e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek}; 210145e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 210245e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 210345e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the "language" of the entity referred to by a given cursor. 210445e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 210545e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor); 210645e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 2107b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis/** 2108b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis * \brief Returns the translation unit that a cursor originated from. 2109b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis */ 2110b0d6eaa6b646c18c49923aefc76973801f561701Argyrios KyrtzidisCINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor); 2111b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis 2112eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2113eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2114eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief A fast container representing a set of CXCursors. 2115eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 2116eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenektypedef struct CXCursorSetImpl *CXCursorSet; 2117eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2118eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2119eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Creates an empty CXCursorSet. 2120eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 2121eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(); 2122eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2123eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2124eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Disposes a CXCursorSet and releases its associated memory. 2125eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 2126eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset); 2127eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2128eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2129eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Queries a CXCursorSet to see if it contains a specific CXCursor. 2130eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * 2131eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \returns non-zero if the set contains the specified cursor. 2132eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek*/ 2133eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset, 2134eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek CXCursor cursor); 2135eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2136eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2137eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Inserts a CXCursor into a CXCursorSet. 2138eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * 2139eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \returns zero if the CXCursor was already in the set, and non-zero otherwise. 2140eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek*/ 2141eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset, 2142eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek CXCursor cursor); 2143eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 21442be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 21452be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the semantic parent of the given cursor. 21462be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21472be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The semantic parent of a cursor is the cursor that semantically contains 21482be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the given \p cursor. For many declarations, the lexical and semantic parents 21492be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the lexical parent is returned by 21502be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorLexicalParent()). They diverge when declarations or 21512be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 21522be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21532be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 21542be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 21552be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 21562be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 21572be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21582be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 21592be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 21602be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21612be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 21622be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 21632be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 21642be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 21652be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 21662be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 21672be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 21682be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 21692be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 21702be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21712be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 21722be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 21732be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 21743910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * 21753910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * For global declarations, the semantic parent is the translation unit. 21762be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 21772be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor); 21782be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor 21792be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 21802be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the lexical parent of the given cursor. 21812be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21822be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The lexical parent of a cursor is the cursor in which the given \p cursor 21832be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * was actually written. For many declarations, the lexical and semantic parents 21842be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the semantic parent is returned by 21852be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorSemanticParent()). They diverge when declarations or 21862be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 21872be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21882be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 21892be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 21902be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 21912be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 21922be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21932be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 21942be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 21952be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21962be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 21972be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 21982be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 21992be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 22002be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 22012be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 22022be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 22032be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 22042be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 22052be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 22062be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 22072be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 22082be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 22093910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * 22103910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * For declarations written in the global scope, the lexical parent is 22113910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * the translation unit. 22122be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 22132be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor); 22149f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 22159f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 22169f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Determine the set of methods that are overridden by the given 22179f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. 22189f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 22199f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In both Objective-C and C++, a method (aka virtual member function, 22209f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * in C++) can override a virtual method in a base class. For 22219f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * Objective-C, a method is said to override any method in the class's 2222044e645605c6d75223e33d23e3c5701cb389969fArgyrios Kyrtzidis * base class, its protocols, or its categories' protocols, that has the same 2223044e645605c6d75223e33d23e3c5701cb389969fArgyrios Kyrtzidis * selector and is of the same kind (class or instance). 2224044e645605c6d75223e33d23e3c5701cb389969fArgyrios Kyrtzidis * If no such method exists, the search continues to the class's superclass, 2225044e645605c6d75223e33d23e3c5701cb389969fArgyrios Kyrtzidis * its protocols, and its categories, and so on. A method from an Objective-C 2226044e645605c6d75223e33d23e3c5701cb389969fArgyrios Kyrtzidis * implementation is considered to override the same methods as its 2227044e645605c6d75223e33d23e3c5701cb389969fArgyrios Kyrtzidis * corresponding method in the interface. 22289f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 22299f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * For C++, a virtual member function overrides any virtual member 22309f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * function with the same signature that occurs in its base 22319f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * classes. With multiple inheritance, a virtual member function can 22329f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * override several virtual member functions coming from different 22339f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * base classes. 22349f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 22359f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In all cases, this function determines the immediate overridden 22369f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method, rather than all of the overridden methods. For example, if 22379f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * a method is originally declared in a class A, then overridden in B 22389f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * (which in inherits from A) and also in C (which inherited from B), 22399f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * then the only overridden method returned from this function when 22409f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoked on C's method will be B's method. The client may then 22419f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoke this function again, given the previously-found overridden 22429f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods, to map out the complete method-override set. 22439f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 22449f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param cursor A cursor representing an Objective-C or C++ 22459f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. This routine will compute the set of methods that this 22469f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method overrides. 22479f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 22489f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param overridden A pointer whose pointee will be replaced with a 22499f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * pointer to an array of cursors, representing the set of overridden 22509f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods. If there are no overridden methods, the pointee will be 22519f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * set to NULL. The pointee must be freed via a call to 22529f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \c clang_disposeOverriddenCursors(). 22539f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 22549f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param num_overridden A pointer to the number of overridden 22559f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * functions, will be set to the number of overridden functions in the 22569f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * array pointed to by \p overridden. 22579f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 22589f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor, 22599f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor CXCursor **overridden, 22609f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor unsigned *num_overridden); 22619f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 22629f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 22639f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Free the set of overridden cursors returned by \c 22649f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * clang_getOverriddenCursors(). 22659f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 22669f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden); 22679f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 226845e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 2269ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * \brief Retrieve the file that is included by the given inclusion directive 2270ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * cursor. 2271ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor */ 2272ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas GregorCINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor); 2273ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor 2274ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor/** 2275c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2276c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 22771efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2278c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2279c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code 2280c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2281c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors represent a location within the Abstract Syntax Tree (AST). These 2282c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines help map between cursors and the physical locations where the 2283c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * described entities occur in the source code. The mapping is provided in 2284c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * both directions, so one can map from source code to the AST and back. 2285c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2286c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 228750398199fb10e196a8d92fbf7a062dbe42ed88fdSteve Naroff */ 22881efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 22896a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff/** 2290b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Map a source location to the cursor that describes the entity at that 2291b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * location in the source code. 2292b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 2293b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() maps an arbitrary source location within a translation 2294b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * unit down to the most specific cursor that describes the entity at that 22951efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * location. For example, given an expression \c x + y, invoking 2296b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() with a source location pointing to "x" will return the 22971efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * cursor for "x"; similarly for "y". If the cursor points anywhere between 2298b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor() 2299b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * will return a cursor referring to the "+" expression. 2300b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 2301b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns a cursor representing the entity at the given source location, or 2302b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * a NULL cursor if no such entity can be found. 23036a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff */ 2304b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation); 23051efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 230698258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor/** 230798258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * \brief Retrieve the physical location of the source constructor referenced 230898258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * by the given cursor. 230998258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * 231098258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * The location of a declaration is typically the location of the name of that 23111efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * declaration, where the name of that declaration would occur if it is 23121efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unnamed, or some keyword that introduces that particular declaration. 23131efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The location of a reference is where that reference occurs within the 231498258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * source code. 231598258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor */ 231698258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor); 2317c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2318b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor/** 2319b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Retrieve the physical extent of the source construct referenced by 2320a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the given cursor. 2321a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * 2322a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * The extent of a cursor starts with the file/line/column pointing at the 2323a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * first character within the source construct that the cursor refers to and 23241efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * ends with the last character withinin that source construct. For a 2325a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * declaration, the extent covers the declaration itself. For a reference, 2326a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the extent covers the location of the reference (e.g., where the referenced 2327a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * entity was actually used). 2328a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor */ 2329a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas GregorCINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor); 2330c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor 2331c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2332c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2333c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 233495f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 2335c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 23368e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \defgroup CINDEX_TYPES Type information for CXCursors 23378e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 23388e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @{ 23398e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23408e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23418e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 23428e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Describes the kind of type 23438e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23448e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenekenum CXTypeKind { 23458e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 23468e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Reprents an invalid type (e.g., where no type is available). 23478e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23488e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Invalid = 0, 23498e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23508e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 23518e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief A type whose specific kind is not exposed via this 23528e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * interface. 23538e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23548e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Unexposed = 1, 23558e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23568e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /* Builtin types */ 23578e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Void = 2, 23588e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Bool = 3, 23598e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_U = 4, 23608e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UChar = 5, 23618e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char16 = 6, 23628e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char32 = 7, 23638e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UShort = 8, 23648e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt = 9, 23658e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULong = 10, 23668e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULongLong = 11, 23678e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt128 = 12, 23688e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_S = 13, 23698e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_SChar = 14, 23708e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_WChar = 15, 23718e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Short = 16, 23728e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int = 17, 23738e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Long = 18, 23748e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongLong = 19, 23758e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int128 = 20, 23768e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Float = 21, 23778e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Double = 22, 23788e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongDouble = 23, 23798e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_NullPtr = 24, 23808e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Overload = 25, 23818e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Dependent = 26, 23828e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCId = 27, 23838e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCClass = 28, 23848e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCSel = 29, 23858e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_FirstBuiltin = CXType_Void, 23868e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LastBuiltin = CXType_ObjCSel, 23878e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23888e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Complex = 100, 23898e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Pointer = 101, 23908e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_BlockPointer = 102, 23918e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LValueReference = 103, 23928e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_RValueReference = 104, 23938e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Record = 105, 23948e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Enum = 106, 23958e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Typedef = 107, 23968e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCInterface = 108, 239704c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_ObjCObjectPointer = 109, 239804c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_FunctionNoProto = 110, 23995f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis CXType_FunctionProto = 111, 240084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXType_ConstantArray = 112, 240184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXType_Vector = 113 24028e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek}; 24038e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 24048e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 240584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Describes the calling convention of a function type 240684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 240784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidisenum CXCallingConv { 240884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_Default = 0, 240984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_C = 1, 241084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_X86StdCall = 2, 241184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_X86FastCall = 3, 241284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_X86ThisCall = 4, 241384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_X86Pascal = 5, 241484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_AAPCS = 6, 241584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_AAPCS_VFP = 7, 241684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 241784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_Invalid = 100, 241884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_Unexposed = 200 241984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis}; 242084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 242184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 242284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 24238e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief The type of an element in the abstract syntax tree. 24248e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 24258e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 24268e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenektypedef struct { 24278e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek enum CXTypeKind kind; 24288e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek void *data[2]; 24298e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek} CXType; 24308e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 24318e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 24328e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the type of a CXCursor (if any). 24338e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 24348e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCursorType(CXCursor C); 24358e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 24368e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 243784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the underlying type of a typedef declaration. 243884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 243984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If the cursor does not reference a typedef declaration, an invalid type is 244084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * returned. 244184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 244284b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE CXType clang_getTypedefDeclUnderlyingType(CXCursor C); 244384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 244484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 244584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the integer type of an enum declaration. 244684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 244784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If the cursor does not reference an enum declaration, an invalid type is 244884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * returned. 244984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 245084b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE CXType clang_getEnumDeclIntegerType(CXCursor C); 245184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 245284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 245384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the integer value of an enum constant declaration as a signed 245484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * long long. 245584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 245684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned. 245784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * Since this is also potentially a valid constant value, the kind of the cursor 245884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * must be verified before calling this function. 245984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 246084b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE long long clang_getEnumConstantDeclValue(CXCursor C); 246184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 246284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 246384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the integer value of an enum constant declaration as an unsigned 246484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * long long. 246584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 246684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned. 246784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * Since this is also potentially a valid constant value, the kind of the cursor 246884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * must be verified before calling this function. 246984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 247084b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE unsigned long long clang_getEnumConstantDeclUnsignedValue(CXCursor C); 247184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 247284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 24738e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \determine Determine whether two CXTypes represent the same type. 24748e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 24758e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \returns non-zero if the CXTypes represent the same type and 24768e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek zero otherwise. 24778e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 24788e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B); 24798e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 24808e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 24818e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the canonical type for a CXType. 24828e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 24838e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * Clang's type system explicitly models typedefs and all the ways 24848e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * a specific type can be represented. The canonical type is the underlying 24858e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * type with all the "sugar" removed. For example, if 'T' is a typedef 24868e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * for 'int', the canonical type for 'T' would be 'int'. 24878e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 24888e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCanonicalType(CXType T); 24898e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 24908e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 2491e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * \determine Determine whether a CXType has the "const" qualifier set, 2492e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * without looking through typedefs that may have added "const" at a different level. 2493e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 2494e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T); 2495e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 2496e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 2497e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * \determine Determine whether a CXType has the "volatile" qualifier set, 2498e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * without looking through typedefs that may have added "volatile" at a different level. 2499e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 2500e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T); 2501e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 2502e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 2503e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * \determine Determine whether a CXType has the "restrict" qualifier set, 2504e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * without looking through typedefs that may have added "restrict" at a different level. 2505e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 2506e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T); 2507e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 2508e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 25098e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief For pointer types, returns the type of the pointee. 25108e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 25118e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 25128e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getPointeeType(CXType T); 25138e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 25148e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 25158e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the cursor for the declaration of the given type. 25168e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 25178e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T); 25188e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 25195389f48b24937ad7b4093307128b3cbf25235654David Chisnall/** 25205389f48b24937ad7b4093307128b3cbf25235654David Chisnall * Returns the Objective-C type encoding for the specified declaration. 25215389f48b24937ad7b4093307128b3cbf25235654David Chisnall */ 25225389f48b24937ad7b4093307128b3cbf25235654David ChisnallCINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C); 25238e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 25248e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 25258e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the spelling of a given CXTypeKind. 25268e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 25278e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K); 25288e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 25298e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 253084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the calling convention associated with a function type. 253184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 253284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If a non-function type is passed in, CXCallingConv_Invalid is returned. 253384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 253484b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE enum CXCallingConv clang_getFunctionTypeCallingConv(CXType T); 253584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 253684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 25379a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * \brief Retrieve the result type associated with a function type. 253884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 253984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If a non-function type is passed in, an invalid type is returned. 254004c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek */ 254104c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted KremenekCINDEX_LINKAGE CXType clang_getResultType(CXType T); 254204c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek 254304c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek/** 254484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the number of non-variadic arguments associated with a function type. 254584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 254684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If a non-function type is passed in, UINT_MAX is returned. 254784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 254884b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE unsigned clang_getNumArgTypes(CXType T); 254984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 255084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 255184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the type of an argument of a function type. 255284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 255384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If a non-function type is passed in or the function does not have enough parameters, 255484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * an invalid type is returned. 255584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 255684b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE CXType clang_getArgType(CXType T, unsigned i); 255784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 255884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 255984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise. 256084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 256184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 256284b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE unsigned clang_isFunctionTypeVariadic(CXType T); 256384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 256484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 256584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the result type associated with a given cursor. 256684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 256784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * This only returns a valid type if the cursor refers to a function or method. 25689a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek */ 25699a140845438c2fc31e7d48a6dedbc695f4c83c68Ted KremenekCINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C); 25709a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek 25719a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek/** 25723ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * \brief Return 1 if the CXType is a POD (plain old data) type, and 0 25733ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * otherwise. 25743ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek */ 25753ce9e7d270e7df86c09c8126b4412d55be7c123bTed KremenekCINDEX_LINKAGE unsigned clang_isPODType(CXType T); 25763ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek 25773ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek/** 257884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Return the element type of an array, complex, or vector type. 257984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 258084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If a type is passed in that is not an array, complex, or vector type, 258184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * an invalid type is returned. 258284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 258384b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE CXType clang_getElementType(CXType T); 258484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 258584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 258684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Return the number of elements of an array or vector type. 258784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 258884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If a type is passed in that is not an array or vector type, 258984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * -1 is returned. 259084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 259184b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE long long clang_getNumElements(CXType T); 259284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 259384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 25945f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * \brief Return the element type of an array type. 25955f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * 25965f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * If a non-array type is passed in, an invalid type is returned. 25975f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis */ 25985f0bfc522266f3319c4a6262b016a552de058c7fArgyrios KyrtzidisCINDEX_LINKAGE CXType clang_getArrayElementType(CXType T); 25995f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis 26005f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis/** 26015f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * \brief Return the the array size of a constant array. 26025f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * 26035f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * If a non-array type is passed in, -1 is returned. 26045f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis */ 26055f0bfc522266f3319c4a6262b016a552de058c7fArgyrios KyrtzidisCINDEX_LINKAGE long long clang_getArraySize(CXType T); 26065f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis 26075f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis/** 26083064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns 1 if the base class specified by the cursor with kind 26093064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * CX_CXXBaseSpecifier is virtual. 26103064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 26113064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor); 26123064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 26133064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 26143064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Represents the C++ access control level to a base class for a 26153064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * cursor with kind CX_CXXBaseSpecifier. 26163064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 26173064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenekenum CX_CXXAccessSpecifier { 26183064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXInvalidAccessSpecifier, 26193064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPublic, 26203064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXProtected, 26213064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPrivate 26223064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek}; 26233064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 26243064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 26253064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns the access control level for the C++ base specifier 26262dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis * represented by a cursor with kind CXCursor_CXXBaseSpecifier or 26272dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis * CXCursor_AccessSpecifier. 26283064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 26293064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor); 26303064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 26313064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 26321f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Determine the number of overloaded declarations referenced by a 26331f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c CXCursor_OverloadedDeclRef cursor. 26341f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 26351f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 26361f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 26371f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns The number of overloaded declarations referenced by \c cursor. If it 26381f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0. 26391f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 26401f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor); 26411f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 26421f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 26431f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Retrieve a cursor for one of the overloaded declarations referenced 26441f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * by a \c CXCursor_OverloadedDeclRef cursor. 26451f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 26461f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 26471f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 26481f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param index The zero-based index into the set of overloaded declarations in 26491f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * the cursor. 26501f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 26511f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns A cursor representing the declaration referenced by the given 26521f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c cursor at the specified \c index. If the cursor does not have an 26531f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * associated set of overloaded declarations, or if the index is out of bounds, 26541f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * returns \c clang_getNullCursor(); 26551f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 26561f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor, 26571f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor unsigned index); 26581f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 26591f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 26608e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @} 26618e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 266295f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 266395f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 2664ad72f4dad4cf0fd2b71eb8f4704d2fe7ac58fb44Ted Kremenek * \defgroup CINDEX_ATTRIBUTES Information for attributes 266595f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 266695f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @{ 266795f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 266895f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 266995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 267095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 267195f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * \brief For cursors representing an iboutletcollection attribute, 267295f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * this function returns the collection element type. 267395f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 267495f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 267595f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted KremenekCINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor); 267695f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 267795f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 267895f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @} 267995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 26808e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 26818e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 2682c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors 2683c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2684c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines provide the ability to traverse the abstract syntax tree 2685c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * using cursors. 2686c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2687c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2688c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 26891efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2690c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2691c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes how the traversal of the children of a particular 2692c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor should proceed after visiting a particular child cursor. 2693c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2694c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A value of this enumeration type should be returned by each 2695c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXCursorVisitor to indicate how clang_visitChildren() proceed. 2696c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2697c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXChildVisitResult { 2698c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 26991efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Terminates the cursor traversal. 2700c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2701c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Break, 27021efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 2703c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Continues the cursor traversal with the next sibling of 2704c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the cursor just visited, without visiting its children. 2705c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2706c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Continue, 2707c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 2708c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Recursively traverse the children of this cursor, using 2709c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the same visitor and client data. 2710c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2711c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Recurse 2712c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 2713c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2714c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2715c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visitor invoked for each cursor found by a traversal. 2716c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2717c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This visitor function will be invoked for each cursor found by 2718c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). Its first argument is the cursor being 2719c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited, its second argument is the parent visitor for that cursor, 2720c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and its third argument is the client data provided to 2721c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). 2722c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2723c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The visitor should return one of the \c CXChildVisitResult values 2724c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to direct clang_visitCursorChildren(). 2725c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 27261efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbartypedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor, 27271efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor parent, 2728c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 2729c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2730c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2731c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visit the children of a particular cursor. 2732c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2733c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This function visits all the direct children of the given cursor, 2734c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * invoking the given \p visitor function with the cursors of each 2735c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited child. The traversal may be recursive, if the visitor returns 2736c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if 2737c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the visitor returns \c CXChildVisit_Break. 2738c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2739c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param parent the cursor whose child may be visited. All kinds of 2740a57259e9d7b30bcce93f0a62eee0488738026172Daniel Dunbar * cursors can be visited, including invalid cursors (which, by 2741c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * definition, have no children). 2742c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2743c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param visitor the visitor function that will be invoked for each 2744c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * child of \p parent. 2745c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2746c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param client_data pointer data supplied by the client, which will 2747c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be passed to the visitor each time it is invoked. 2748c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2749c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \returns a non-zero value if the traversal was terminated 2750c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * prematurely by the visitor returning \c CXChildVisit_Break. 2751c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 27521efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent, 2753c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursorVisitor visitor, 2754c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 27553387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#ifdef __has_feature 27563387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# if __has_feature(blocks) 27573387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 27583387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * \brief Visitor invoked for each cursor found by a traversal. 27593387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 27603387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * This visitor block will be invoked for each cursor found by 27613387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * clang_visitChildrenWithBlock(). Its first argument is the cursor being 27623387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * visited, its second argument is the parent visitor for that cursor. 27633387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 27643387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * The visitor should return one of the \c CXChildVisitResult values 27653387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * to direct clang_visitChildrenWithBlock(). 27663387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 27673387c65a094a02b2a94c05111d035a97d3d5c794David Chisnalltypedef enum CXChildVisitResult 27683387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent); 27693387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall 27703387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 27713387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * Visits the children of a cursor using the specified block. Behaves 27723387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * identically to clang_visitChildren() in all other respects. 27733387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 27743387c65a094a02b2a94c05111d035a97d3d5c794David Chisnallunsigned clang_visitChildrenWithBlock(CXCursor parent, 27753387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall CXCursorVisitorBlock block); 27763387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# endif 27773387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#endif 27781efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2779c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2780c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2781c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 27821efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2783c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2784c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST 2785c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 27861efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * These routines provide the ability to determine references within and 2787c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * across translation units, by providing the names of the entities referenced 2788c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by cursors, follow reference cursors to the declarations they reference, 2789c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and associate declarations with their definitions. 2790c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2791c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2792c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 27931efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2794c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2795c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced 2796c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by the given cursor. 2797c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2798c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A Unified Symbol Resolution (USR) is a string that identifies a particular 2799c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * entity (function, class, variable, etc.) within a program. USRs can be 2800c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * compared across translation units to determine, e.g., when references in 2801c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * one translation refer to an entity defined in another translation unit. 2802c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2803c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor); 2804c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2805c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2806896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C class. 2807896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2808896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name); 2809896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2810896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2811896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C category. 2812896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2813896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 281466ccaec73706f3623d2e7d191fe2c944feedcc2bTed Kremenek clang_constructUSR_ObjCCategory(const char *class_name, 2815896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek const char *category_name); 2816896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2817896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2818896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C protocol. 2819896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2820896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 2821896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek clang_constructUSR_ObjCProtocol(const char *protocol_name); 2822896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2823896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2824896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2825896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C instance variable and 2826896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 2827896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2828896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name, 2829896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2830896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2831896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2832896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C method and 2833896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 2834896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2835896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name, 2836896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek unsigned isInstanceMethod, 2837896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2838896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2839896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2840896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C property and the USR 2841896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * for its containing class. 2842896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2843896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property, 2844896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2845896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2846896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2847c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a name for the entity referenced by this cursor. 2848c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2849c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor); 2850c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2851358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor/** 2852358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * \brief Retrieve the display name for the entity referenced by this cursor. 2853358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * 2854358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * The display name contains extra information that helps identify the cursor, 2855358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * such as the parameters of a function or template or the arguments of a 2856358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * class template specialization. 2857358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor */ 2858358559d8d7b458c5f64941842383a16e61f0828dDouglas GregorCINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor); 2859358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor 2860c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor/** \brief For a cursor that is a reference, retrieve a cursor representing the 2861c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * entity that it references. 2862c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * 2863c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Reference cursors refer to other entities in the AST. For example, an 2864c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Objective-C superclass reference cursor refers to an Objective-C class. 28651efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * This function produces the cursor for the Objective-C class from the 2866c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * cursor for the superclass reference. If the input cursor is a declaration or 2867c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * definition, it returns that declaration or definition unchanged. 28681efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Otherwise, returns the NULL cursor. 2869c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor */ 2870c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor); 2871b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 28721efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 2873b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief For a cursor that is either a reference to or a declaration 2874b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * of some entity, retrieve a cursor that describes the definition of 2875b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that entity. 2876b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2877b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * Some entities can be declared multiple times within a translation 2878b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * unit, but only one of those declarations can also be a 2879b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * definition. For example, given: 2880b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2881b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \code 2882b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 2883b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int g(int x, int y) { return f(x, y); } 2884b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int a, int b) { return a + b; } 2885b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 2886b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \endcode 2887b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2888b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * there are three declarations of the function "f", but only the 2889b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * second one is a definition. The clang_getCursorDefinition() 2890b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * function will take any cursor pointing to a declaration of "f" 2891b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * (the first or fourth lines of the example) or a cursor referenced 2892b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that uses "f" (the call to "f' inside "g") and will return a 2893b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration cursor pointing to the definition (the second "f" 2894b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration). 2895b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2896b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * If given a cursor for which there is no corresponding definition, 2897b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * e.g., because there is no definition of that entity within this 2898b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * translation unit, returns a NULL cursor. 2899b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 2900b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor); 2901b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 29021efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 2903b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Determine whether the declaration pointed to by this cursor 2904b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * is also a definition of that entity. 2905b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 2906b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor); 2907b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 2908c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 29091a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \brief Retrieve the canonical cursor corresponding to the given cursor. 29101a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 29111a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * In the C family of languages, many kinds of entities can be declared several 29121a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * times within a single translation unit. For example, a structure type can 29131a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * be forward-declared (possibly multiple times) and later defined: 29141a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 29151a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \code 29161a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X; 29171a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X; 29181a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X { 29191a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * int member; 29201a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * }; 29211a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \endcode 29221a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 29231a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * The declarations and the definition of \c X are represented by three 29241a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * different cursors, all of which are declarations of the same underlying 29251a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * entity. One of these cursor is considered the "canonical" cursor, which 29261a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * is effectively the representative for the underlying entity. One can 29271a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * determine if two cursors are declarations of the same underlying entity by 29281a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * comparing their canonical cursors. 29291a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 29301a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \returns The canonical cursor for the entity referred to by the given cursor. 29311a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor */ 29321a9d0503b67a499797141af0fd6d315d5045f0eaDouglas GregorCINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor); 29331a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor 29341a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor/** 2935c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2936c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 29371efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2938c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 29399ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * \defgroup CINDEX_CPP C++ AST introspection 29409ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 29419ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * The routines in this group provide access information in the ASTs specific 29429ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * to C++ language features. 29439ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 29449ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @{ 29459ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 29469ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 29479ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 294849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Determine if a C++ member function or member function template is 294949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared 'static'. 29509ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 29519ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed KremenekCINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C); 29529ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 29539ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 2954211924b563aa31421836cee7655be729ad02733fDouglas Gregor * \brief Determine if a C++ member function or member function template is 2955211924b563aa31421836cee7655be729ad02733fDouglas Gregor * explicitly declared 'virtual' or if it overrides a virtual method from 2956211924b563aa31421836cee7655be729ad02733fDouglas Gregor * one of the base classes. 2957211924b563aa31421836cee7655be729ad02733fDouglas Gregor */ 2958211924b563aa31421836cee7655be729ad02733fDouglas GregorCINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C); 2959211924b563aa31421836cee7655be729ad02733fDouglas Gregor 2960211924b563aa31421836cee7655be729ad02733fDouglas Gregor/** 296149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Given a cursor that represents a template, determine 296249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the cursor kind of the specializations would be generated by instantiating 296349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the template. 296449f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 296549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * This routine can be used to determine what flavor of function template, 296649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * class template, or class template partial specialization is stored in the 296749f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * cursor. For example, it can describe whether a class template cursor is 296849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared with "struct", "class" or "union". 296949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 297049f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \param C The cursor to query. This cursor should represent a template 297149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declaration. 297249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 297349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \returns The cursor kind of the specializations that would be generated 297449f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * by instantiating the template \p C. If \p C is not a template, returns 297549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \c CXCursor_NoDeclFound. 297649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor */ 297749f6f5489483beaffc7ce48dfc000af4e65b9216Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C); 297849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor 297949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor/** 2980e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \brief Given a cursor that may represent a specialization or instantiation 2981e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template, retrieve the cursor that represents the template that it 2982e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializes or from which it was instantiated. 2983e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2984e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * This routine determines the template involved both for explicit 2985e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializations of templates and for implicit instantiations of the template, 2986e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * both of which are referred to as "specializations". For a class template 2987e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specialization (e.g., \c std::vector<bool>), this routine will return 2988e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * either the primary template (\c std::vector) or, if the specialization was 2989e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * instantiated from a class template partial specialization, the class template 2990e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * partial specialization. For a class template partial specialization and a 2991e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * function template specialization (including instantiations), this 2992e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * this routine will return the specialized template. 2993e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2994e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * For members of a class template (e.g., member functions, member classes, or 2995e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * static data members), returns the specialized or instantiated member. 2996e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * Although not strictly "templates" in the C++ language, members of class 2997e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates have the same notions of specializations and instantiations that 2998e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates do, so this routine treats them similarly. 2999e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 3000e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \param C A cursor that may be a specialization of a template or a member 3001e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template. 3002e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 3003e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \returns If the given cursor is a specialization or instantiation of a 3004e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * template or a member thereof, the template or member that it specializes or 3005e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * from which it was instantiated. Otherwise, returns a NULL cursor. 3006e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor */ 3007e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas GregorCINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C); 3008430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 3009430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor/** 3010430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Given a cursor that references something else, return the source range 3011430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * covering that reference. 3012430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 3013430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param C A cursor pointing to a member reference, a declaration reference, or 3014430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * an operator call. 3015430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param NameFlags A bitset with three independent flags: 3016430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and 3017430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantSinglePiece. 3018430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param PieceIndex For contiguous names or when passing the flag 3019430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantSinglePiece, only one piece with index 0 is 3020430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * available. When the CXNameRange_WantSinglePiece flag is not passed for a 3021430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * non-contiguous names, this index can be used to retreive the individual 3022430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * pieces of the name. See also CXNameRange_WantSinglePiece. 3023430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 3024430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \returns The piece of the name pointed to by the given cursor. If there is no 3025430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * name, or if the PieceIndex is out-of-range, a null-cursor will be returned. 3026430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 302748a8d14fc6f064a5297024c2b34733a4080b2efeFrancois PichetCINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, 302848a8d14fc6f064a5297024c2b34733a4080b2efeFrancois Pichet unsigned NameFlags, 3029430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor unsigned PieceIndex); 3030430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 3031430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregorenum CXNameRefFlags { 3032430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 3033430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the 3034430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * range. 3035430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 3036430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantQualifier = 0x1, 3037430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 3038430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 3039430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Include the explicit template arguments, e.g. <int> in x.f<int>, in 3040430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * the range. 3041430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 3042430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantTemplateArgs = 0x2, 3043430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 3044430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 3045430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief If the name is non-contiguous, return the full spanning range. 3046430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 3047430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * Non-contiguous names occur in Objective-C when a selector with two or more 3048430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * parameters is used, or in C++ when using an operator: 3049430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \code 3050430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * [object doSomething:here withValue:there]; // ObjC 3051430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * return some_vector[1]; // C++ 3052430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \endcode 3053430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 3054430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantSinglePiece = 0x4 3055430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor}; 3056e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor 3057e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor/** 30589ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @} 30599ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 30609ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 30619ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 30620045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \defgroup CINDEX_LEX Token extraction and manipulation 30630045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 30640045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * The routines in this group provide access to the tokens within a 30650045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * translation unit, along with a semantic mapping of those tokens to 30660045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * their corresponding cursors. 3067fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3068fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @{ 3069fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3070fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 3071fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3072fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a kind of token. 3073fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3074fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef enum CXTokenKind { 3075fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 3076fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A token that contains some kind of punctuation. 3077fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3078fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Punctuation, 3079896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3080fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 30810045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \brief A language keyword. 3082fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3083fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Keyword, 3084896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3085fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 3086fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief An identifier (that is not a keyword). 3087fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3088fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Identifier, 3089896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3090fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 3091fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A numeric, string, or character literal. 3092fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3093fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Literal, 3094896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3095fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 3096fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A comment. 3097fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3098fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Comment 3099fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXTokenKind; 3100fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 3101fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3102fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a single preprocessing token. 3103fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3104fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef struct { 3105fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor unsigned int_data[4]; 3106fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor void *ptr_data; 3107fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXToken; 3108fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 3109fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3110fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the kind of the given token. 3111fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3112fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken); 3113896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3114fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3115fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the spelling of the given token. 3116fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3117fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * The spelling of a token is the textual representation of that token, e.g., 3118fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * the text of an identifier or keyword. 3119fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3120fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken); 3121896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3122fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3123fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve the source location of the given token. 3124fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3125896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit, 3126fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken); 3127896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3128fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3129fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve a source range that covers the given token. 3130fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3131fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken); 3132fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 3133fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3134fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Tokenize the source code described by the given range into raw 3135fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * lexical tokens. 3136fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3137fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit whose text is being tokenized. 3138fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3139fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Range the source range in which text should be tokenized. All of the 3140fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * tokens produced by tokenization will fall within this source range, 3141fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3142fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens this pointer will be set to point to the array of tokens 3143fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that occur within the given source range. The returned pointer must be 3144fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * freed with clang_disposeTokens() before the translation unit is destroyed. 3145fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3146fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens will be set to the number of tokens in the \c *Tokens 3147fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * array. 3148fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3149fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3150fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range, 3151fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken **Tokens, unsigned *NumTokens); 3152896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3153fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3154fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Annotate the given set of tokens by providing cursors for each token 3155fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that can be mapped to a specific entity within the abstract syntax tree. 3156fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 31570045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * This token-annotation routine is equivalent to invoking 31580045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() for the source locations of each of the 31590045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * tokens. The cursors provided are filtered, so that only those 31600045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * cursors that have a direct correspondence to the token are 31610045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * accepted. For example, given a function call \c f(x), 31620045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() would provide the following cursors: 31630045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 31640045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'. 31650045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'. 31660045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'. 31670045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 31680045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * Only the first and last of these cursors will occur within the 31690045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * annotate, since the tokens "f" and "x' directly refer to a function 31700045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * and a variable, respectively, but the parentheses are just a small 31710045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * part of the full syntax of the function call expression, which is 31720045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * not provided as an annotation. 3173fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3174fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit that owns the given tokens. 3175fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3176fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens the set of tokens to annotate. 3177fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3178fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens the number of tokens in \p Tokens. 3179fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3180fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Cursors an array of \p NumTokens cursors, whose contents will be 3181fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * replaced with the cursors corresponding to each token. 3182fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3183fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU, 3184fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens, 3185fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXCursor *Cursors); 3186896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3187fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3188fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Free the given set of tokens. 3189fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3190896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU, 3191fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens); 3192896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3193fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3194fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @} 3195fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3196896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3197fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3198c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_DEBUG Debugging facilities 3199c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3200c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines are used for testing and debugging, only, and should not 3201c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be relied upon. 3202c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3203c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 3204c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 32051efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 32064ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff/* for debug/testing */ 3207e68fff6fc083c6270d835216a3de0b82c6ef0310Ted KremenekCINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind); 32081efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor, 32091efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar const char **startBuf, 32104ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff const char **endBuf, 32114ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startLine, 32124ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startColumn, 32134ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endLine, 32144ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endColumn); 32150a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE void clang_enableStackTraces(void); 3216995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel DunbarCINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data, 3217995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar unsigned stack_size); 3218995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar 32190c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 3220c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 3221c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 32221efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 3223c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 3224c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CODE_COMPLET Code completion 3225c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3226c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Code completion involves taking an (incomplete) source file, along with 3227c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * knowledge of where the user is actively editing that file, and suggesting 3228c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * syntactically- and semantically-valid constructs that the user might want to 3229c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * use at that particular point in the source code. These data structures and 3230c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines provide support for code completion. 3231c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3232c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 3233c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 32341efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 3235c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 32360c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A semantic string that describes a code-completion result. 32370c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A semantic string that describes the formatting of a code-completion 32390c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * result as a single "template" of text that should be inserted into the 32400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * source buffer when a particular code-completion result is selected. 32410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * Each semantic string is made up of some number of "chunks", each of which 32420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * contains some text along with a description of what that text means, e.g., 32430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the name of the entity being referenced, whether the text chunk is part of 32440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the template, or whether it is a "placeholder" that the user should replace 32450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * with actual code,of a specific kind. See \c CXCompletionChunkKind for a 32461efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * description of the different kinds of chunks. 32470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef void *CXCompletionString; 32491efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 32500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 32510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A single result of code completion. 32520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef struct { 32540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32551efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief The kind of entity that this completion refers to. 32560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32571efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor kind will be a macro, keyword, or a declaration (one of the 32580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * *Decl cursor kinds), describing the entity that the completion is 32590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to. 32600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \todo In the future, we would like to provide a full cursor, to allow 32620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the client to extract additional information from declaration. 32630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor enum CXCursorKind CursorKind; 32651efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 32661efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 32670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief The code-completion string that describes how to insert this 32680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion result into the editing buffer. 32690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionString CompletionString; 32710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor} CXCompletionResult; 32720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 32730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 32740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Describes a single piece of text within a code-completion string. 32750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32761efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Each "chunk" within a code-completion string (\c CXCompletionString) is 32771efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * either a piece of text with a specific "kind" that describes how that text 32780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * should be interpreted by the client or is another completion string. 32790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorenum CXCompletionChunkKind { 32810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A code-completion string that describes "optional" text that 32830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * could be a part of the template (but is not required). 32840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The Optional chunk is the only kind of chunk that has a code-completion 32861efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * string for its representation, which is accessible via 32870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \c clang_getCompletionChunkCompletionString(). The code-completion string 32880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * describes an additional part of the template that is completely optional. 32890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * For example, optional chunks can be used to describe the placeholders for 32900c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * arguments that match up with defaulted function parameters, e.g. given: 32910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 32930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * void f(int x, float y = 3.14, double z = 2.71828); 32940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 32950c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32960c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The code-completion string for this function would contain: 32970c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a TypedText chunk for "f". 32980c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a LeftParen chunk for "(". 32990c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "int x" 33000c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the remaining defaulted arguments, e.g., 33010c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 330271570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * - a Placeholder chunk for "float y" 33030c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the last defaulted argument: 33040c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 33050c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "double z" 33060c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a RightParen chunk for ")" 33070c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 330871570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * There are many ways to handle Optional chunks. Two simple approaches are: 33090c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Completely ignore optional chunks, in which case the template for the 33100c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would only include the first parameter ("int x"). 33110c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Fully expand all optional chunks, in which case the template for the 33120c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would have all of the parameters. 33130c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33140c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Optional, 33150c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 33160c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that a user would be expected to type to get this 33171efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * code-completion result. 33180c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33191efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * There will be exactly one "typed text" chunk in a semantic string, which 33201efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * will typically provide the spelling of a keyword or the name of a 33210c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * declaration that could be used at the current code point. Clients are 33220c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * expected to filter the code-completion results based on the text in this 33230c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * chunk. 33240c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33250c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_TypedText, 33260c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 33270c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that should be inserted as part of a code-completion result. 33280c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "text" chunk represents text that is part of the template to be 33300c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * inserted into user code should this particular code-completion result 33310c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * be selected. 33320c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33330c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Text, 33340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 33350c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Placeholder text that should be replaced by the user. 33360c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33370c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "placeholder" chunk marks a place where the user should insert text 33380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * into the code-completion template. For example, placeholders might mark 33390c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the function parameters for a function declaration, to indicate that the 33400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * user should provide arguments for each of those parameters. The actual 33410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * text in a placeholder is a suggestion for the text to display before 33420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the user replaces the placeholder with real code. 33430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Placeholder, 33450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 33460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Informative text that should be displayed but never inserted as 33470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * part of the template. 33481efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 33490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * An "informative" chunk contains annotations that can be displayed to 33500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * help the user decide whether a particular code-completion result is the 33510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * right option, but which is not part of the actual template to be inserted 33520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * by code completion. 33530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Informative, 33550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 33560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that describes the current parameter when code-completion is 33570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to function call, message send, or template specialization. 33580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "current parameter" chunk occurs when code-completion is providing 33600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * information about a parameter corresponding to the argument at the 33610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion point. For example, given a function 33620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 33640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * int add(int x, int y); 33650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 33660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * and the source code \c add(, where the code-completion point is after the 33680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "(", the code-completion string will contain a "current parameter" chunk 33690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * for "int x", indicating that the current argument will initialize that 33700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * parameter. After typing further, to \c add(17, (where the code-completion 33711efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * point is after the ","), the code-completion string will contain a 33720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "current paremeter" chunk to "int y". 33730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_CurrentParameter, 33750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 33760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left parenthesis ('('), used to initiate a function call or 33770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the beginning of a function parameter list. 33780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftParen, 33800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 33810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right parenthesis (')'), used to finish a function call or 33820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the end of a function parameter list. 33830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightParen, 33850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 33860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left bracket ('['). 33870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBracket, 33890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 33900c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right bracket (']'). 33910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBracket, 33930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 33940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left brace ('{'). 33950c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33960c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBrace, 33970c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 33980c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right brace ('}'). 33990c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 34000c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBrace, 34010c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 34020c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left angle bracket ('<'). 34030c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 34040c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftAngle, 34050c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 34060c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right angle bracket ('>'). 34070c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 34080c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightAngle, 34090c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 34100c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A comma separator (','). 34110c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 3412ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor CXCompletionChunk_Comma, 3413ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor /** 34141efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Text that specifies the result type of a given result. 3415ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * 3416ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * This special kind of informative chunk is not meant to be inserted into 34171efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * the text buffer. Rather, it is meant to illustrate the type that an 3418ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * expression using the given completion string would have. 3419ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor */ 342001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_ResultType, 342101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 342201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A colon (':'). 342301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 342401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Colon, 342501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 342601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A semicolon (';'). 342701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 342801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_SemiColon, 342901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 343001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief An '=' sign. 343101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 343201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Equal, 343301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 343401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Horizontal space (' '). 343501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 343601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_HorizontalSpace, 343701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 343801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Vertical space ('\n'), after which it is generally a good idea to 343901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * perform indentation. 344001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 344101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_VerticalSpace 34420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor}; 34431efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 34440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 34450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Determine the kind of a particular chunk within a completion string. 34460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 34470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 34480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 34490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 34500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 34510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the kind of the chunk at the index \c chunk_number. 34520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 34531efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE enum CXCompletionChunkKind 34540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkKind(CXCompletionString completion_string, 34550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 34561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 34570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 34581efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the text associated with a particular chunk within a 34590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * completion string. 34600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 34610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 34620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 34630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 34640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 34650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the text associated with the chunk at index \c chunk_number. 34660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 34672ef6f8f5a35a60870594c5b04e0aa2bf22c6886fTed KremenekCINDEX_LINKAGE CXString 34680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkText(CXCompletionString completion_string, 34690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 34700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 34710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 34721efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the completion string associated with a particular chunk 34730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * within a completion string. 34740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 34750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 34760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 34770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 34780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 34790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the completion string associated with the chunk at index 34806164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \c chunk_number. 34810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 34820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE CXCompletionString 34830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkCompletionString(CXCompletionString completion_string, 34840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 34851efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 34860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 34870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Retrieve the number of chunks in the given code-completion string. 34880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 34890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE unsigned 34900c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getNumCompletionChunks(CXCompletionString completion_string); 34910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 34920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 349312e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \brief Determine the priority of this code completion. 349412e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 349512e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * The priority of a code completion indicates how likely it is that this 349612e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * particular completion is the completion that the user will select. The 349712e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * priority is selected by various internal heuristics. 349812e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 349912e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \param completion_string The completion string to query. 350012e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 350112e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \returns The priority of this completion string. Smaller values indicate 350212e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * higher-priority (more likely) completions. 350312e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor */ 350412e131385e892e3723483a1081a89bcad29c8a84Douglas GregorCINDEX_LINKAGE unsigned 350512e131385e892e3723483a1081a89bcad29c8a84Douglas Gregorclang_getCompletionPriority(CXCompletionString completion_string); 350612e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor 350712e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor/** 350858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \brief Determine the availability of the entity that this code-completion 350958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * string refers to. 351058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 351158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param completion_string The completion string to query. 351258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 351358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the completion string. 351458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 351558ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 351658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCompletionAvailability(CXCompletionString completion_string); 351758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 351858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 35196164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \brief Retrieve the number of annotations associated with the given 35206164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * completion string. 35216164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 35226164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \param completion_string the completion string to query. 35236164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 35246164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \returns the number of annotations associated with the given completion 35256164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * string. 35266164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen */ 35276164ea1d75385b6fc3c19e5ab9bb686298436a5aErik VerbruggenCINDEX_LINKAGE unsigned 35286164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggenclang_getCompletionNumAnnotations(CXCompletionString completion_string); 35296164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen 35306164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen/** 35316164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \brief Retrieve the annotation associated with the given completion string. 35326164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 35336164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \param completion_string the completion string to query. 35346164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 35356164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \param annotation_number the 0-based index of the annotation of the 35366164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * completion string. 35376164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 35386164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \returns annotation string associated with the completion at index 35396164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \c annotation_number, or a NULL string if that annotation is not available. 35406164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen */ 35416164ea1d75385b6fc3c19e5ab9bb686298436a5aErik VerbruggenCINDEX_LINKAGE CXString 35426164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggenclang_getCompletionAnnotation(CXCompletionString completion_string, 35436164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen unsigned annotation_number); 35446164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen 35456164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen/** 35468fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \brief Retrieve a completion string for an arbitrary declaration or macro 35478fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * definition cursor. 35488fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * 35498fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \param cursor The cursor to query. 35508fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * 35518fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \returns A non-context-sensitive completion string for declaration and macro 35528fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * definition cursors, or NULL for other kinds of cursors. 35538fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor */ 35548fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas GregorCINDEX_LINKAGE CXCompletionString 35558fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregorclang_getCursorCompletionString(CXCursor cursor); 35568fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 35578fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor/** 3558ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Contains the results of code-completion. 3559ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * 3560ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * This data structure contains the results of code completion, as 3561e0cc52ef8afc8d1cba9c534191b5f0ddaff1d694Douglas Gregor * produced by \c clang_codeCompleteAt(). Its contents must be freed by 3562ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c clang_disposeCodeCompleteResults. 3563ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 3564ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregortypedef struct { 3565ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 3566ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The code-completion results. 3567ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 3568ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor CXCompletionResult *Results; 3569ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 3570ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 3571ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The number of code-completion results stored in the 3572ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c Results array. 3573ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 3574ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor unsigned NumResults; 3575ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor} CXCodeCompleteResults; 3576ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 3577ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor/** 3578cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Flags that can be passed to \c clang_codeCompleteAt() to 3579cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * modify its behavior. 3580cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 3581cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * The enumerators in this enumeration can be bitwise-OR'd together to 3582cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * provide multiple options to \c clang_codeCompleteAt(). 3583cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 3584cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregorenum CXCodeComplete_Flags { 3585cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 3586cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include macros within the set of code 3587cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completions returned. 3588cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 3589cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor CXCodeComplete_IncludeMacros = 0x01, 3590cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 3591cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 3592cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include code patterns for language constructs 3593cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * within the set of code completions, e.g., for loops. 3594cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 3595cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor CXCodeComplete_IncludeCodePatterns = 0x02 3596cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor}; 3597cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 3598cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 35993da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Bits that represent the context under which completion is occurring. 36003da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 36013da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * The enumerators in this enumeration may be bitwise-OR'd together if multiple 36023da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * contexts are occurring simultaneously. 36033da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36043da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregorenum CXCompletionContext { 36053da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36063da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief The context for completions is unexposed, as only Clang results 36073da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included. (This is equivalent to having no context bits set.) 36083da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36093da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Unexposed = 0, 36103da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 36113da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36123da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for any possible type should be included in the results. 36133da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36143da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_AnyType = 1 << 0, 36153da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 36163da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36173da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for any possible value (variables, function calls, etc.) 36183da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included in the results. 36193da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36203da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_AnyValue = 1 << 1, 36213da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36223da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to an Objective-C object should 36233da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * be included in the results. 36243da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36253da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCObjectValue = 1 << 2, 36263da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36273da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to an Objective-C selector 36283da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included in the results. 36293da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36303da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCSelectorValue = 1 << 3, 36313da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36323da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to a C++ class type should be 36333da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * included in the results. 36343da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36353da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_CXXClassTypeValue = 1 << 4, 36363da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 36373da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36383da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for fields of the member being accessed using the dot 36393da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * operator should be included in the results. 36403da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36413da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_DotMemberAccess = 1 << 5, 36423da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36433da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for fields of the member being accessed using the arrow 36443da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * operator should be included in the results. 36453da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36463da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ArrowMemberAccess = 1 << 6, 36473da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36483da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for properties of the Objective-C object being accessed 36493da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * using the dot operator should be included in the results. 36503da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36513da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCPropertyAccess = 1 << 7, 36523da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 36533da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36543da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for enum tags should be included in the results. 36553da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36563da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_EnumTag = 1 << 8, 36573da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36583da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for union tags should be included in the results. 36593da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36603da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_UnionTag = 1 << 9, 36613da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36623da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for struct tags should be included in the results. 36633da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36643da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_StructTag = 1 << 10, 36653da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 36663da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36673da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ class names should be included in the results. 36683da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36693da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ClassTag = 1 << 11, 36703da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36713da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ namespaces and namespace aliases should be 36723da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * included in the results. 36733da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36743da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Namespace = 1 << 12, 36753da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36763da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ nested name specifiers should be included in 36773da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 36783da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36793da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_NestedNameSpecifier = 1 << 13, 36803da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 36813da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36823da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C interfaces (classes) should be included 36833da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * in the results. 36843da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36853da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCInterface = 1 << 14, 36863da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36873da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C protocols should be included in 36883da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 36893da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36903da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCProtocol = 1 << 15, 36913da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36923da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C categories should be included in 36933da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 36943da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36953da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCCategory = 1 << 16, 36963da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36973da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C instance messages should be included 36983da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * in the results. 36993da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 37003da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCInstanceMessage = 1 << 17, 37013da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 37023da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C class messages should be included in 37033da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 37043da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 37053da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCClassMessage = 1 << 18, 37063da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 37073da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C selector names should be included in 37083da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 37093da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 37103da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCSelectorName = 1 << 19, 37113da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 37123da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 37133da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for preprocessor macro names should be included in 37143da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 37153da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 37163da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_MacroName = 1 << 20, 37173da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 37183da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 37193da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Natural language completions should be included in the results. 37203da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 37213da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_NaturalLanguage = 1 << 21, 37223da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 37233da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 37243da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief The current context is unknown, so set all contexts. 37253da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 37263da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Unknown = ((1 << 22) - 1) 37273da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor}; 37283da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 37293da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor/** 3730cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Returns a default set of code-completion options that can be 3731cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * passed to\c clang_codeCompleteAt(). 3732cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 3733cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas GregorCINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void); 3734cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 3735cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 37361abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \brief Perform code completion at a given location in a translation unit. 37371abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 37381abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * This function performs code completion at a particular file, line, and 37391abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * column within source code, providing results that suggest potential 37401abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code snippets based on the context of the completion. The basic model 37411abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * for code completion is that Clang will parse a complete source file, 37421abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * performing syntax checking up to the location where code-completion has 37431abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * been requested. At that point, a special code-completion token is passed 37441abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * to the parser, which recognizes this token and determines, based on the 37451abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * current location in the C/Objective-C/C++ grammar and the state of 37461abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * semantic analysis, what completions to provide. These completions are 37471abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * returned via a new \c CXCodeCompleteResults structure. 37481abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 37491abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Code completion itself is meant to be triggered by the client when the 37501abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * user types punctuation characters or whitespace, at which point the 37511abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code-completion location will coincide with the cursor. For example, if \c p 37521abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is a pointer, code-completion might be triggered after the "-" and then 37531abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * after the ">" in \c p->. When the code-completion location is afer the ">", 37541abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the completion results will provide, e.g., the members of the struct that 37551abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * "p" points to. The client is responsible for placing the cursor at the 37561abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * beginning of the token currently being typed, then filtering the results 37571abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * based on the contents of the token. For example, when code-completing for 37581abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the expression \c p->get, the client should provide the location just after 37591abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the 37601abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client can filter the results based on the current token text ("get"), only 37611abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * showing those results that start with "get". The intent of this interface 37621abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is to separate the relatively high-latency acquisition of code-completion 37631abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * results from the filtering of results on a per-character basis, which must 37641abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * have a lower latency. 37651abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 37661abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param TU The translation unit in which code-completion should 37671abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * occur. The source files for this translation unit need not be 37681abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completely up-to-date (and the contents of those source files may 37691abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * be overridden via \p unsaved_files). Cursors referring into the 37701abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * translation unit may be invalidated by this invocation. 37711abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 37721abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_filename The name of the source file where code 37731abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion should be performed. This filename may be any file 37741abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * included in the translation unit. 37751abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 37761abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_line The line at which code-completion should occur. 37771abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 37781abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_column The column at which code-completion should occur. 37791abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Note that the column should point just after the syntactic construct that 37801abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * initiated code completion, and not in the middle of a lexical token. 37811abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 37821abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param unsaved_files the Tiles that have not yet been saved to disk 37831abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing or code completion, including the 37841abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * contents of those files. The contents and name of these files (as 37851abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * specified by CXUnsavedFile) are copied when necessary, so the 37861abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client only needs to guarantee their validity until the call to 37871abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * this function returns. 37881abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 37891abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 37901abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * unsaved_files. 37911abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 3792cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \param options Extra options that control the behavior of code 3793cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completion, expressed as a bitwise OR of the enumerators of the 3794cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * CXCodeComplete_Flags enumeration. The 3795cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \c clang_defaultCodeCompleteOptions() function returns a default set 3796cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * of code-completion options. 3797cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 37981abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \returns If successful, a new \c CXCodeCompleteResults structure 37991abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * containing code-completion results, which should eventually be 38001abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * freed with \c clang_disposeCodeCompleteResults(). If code 38011abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion fails, returns NULL. 38021abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor */ 38031abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCINDEX_LINKAGE 38041abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU, 38051abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor const char *complete_filename, 38061abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_line, 38071abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_column, 38081abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor struct CXUnsavedFile *unsaved_files, 3809cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned num_unsaved_files, 3810cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned options); 38111abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 38121abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor/** 38131e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \brief Sort the code-completion results in case-insensitive alphabetical 38141e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * order. 38151e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * 38161e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param Results The set of results to sort. 38171e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param NumResults The number of results in \p Results. 38181e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor */ 38191e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas GregorCINDEX_LINKAGE 38201e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregorvoid clang_sortCodeCompletionResults(CXCompletionResult *Results, 38211e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor unsigned NumResults); 38221e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor 38231e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor/** 3824ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Free the given set of code-completion results. 38250c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 38261efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE 3827ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregorvoid clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results); 382858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 382920d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor/** 3830a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced prior to the 3831a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * location where code completion was performed. 3832a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 3833896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 3834a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorunsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results); 3835a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 3836a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 3837a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given code completion. 3838a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 3839a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Result the code completion results to query. 3840a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 3841a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 3842a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 3843a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 3844a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 3845896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 3846a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results, 3847a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 3848a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 3849a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 38503da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Determines what compeltions are appropriate for the context 38513da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the given code completion. 38523da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 38533da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \param Results the code completion results to query 38543da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 38553da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \returns the kinds of completions that are appropriate for use 38563da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * along with the given code completion results. 38573da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 38583da626b4f38eb0350de960d71271ca77af7a9cc8Douglas GregorCINDEX_LINKAGE 38593da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregorunsigned long long clang_codeCompleteGetContexts( 38603da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCodeCompleteResults *Results); 3861e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor 3862e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor/** 3863e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \brief Returns the cursor kind for the container for the current code 3864e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * completion context. The container is only guaranteed to be set for 3865e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * contexts where a container exists (i.e. member accesses or Objective-C 3866e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * message sends); if there is not a container, this function will return 3867e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * CXCursor_InvalidCode. 3868e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3869e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param Results the code completion results to query 3870e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3871e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param IsIncomplete on return, this value will be false if Clang has complete 3872e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * information about the container. If Clang does not have complete 3873e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * information, this value will be true. 3874e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3875e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \returns the container kind, or CXCursor_InvalidCode if there is not a 3876e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * container 3877e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor */ 3878e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCINDEX_LINKAGE 3879e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregorenum CXCursorKind clang_codeCompleteGetContainerKind( 3880e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor CXCodeCompleteResults *Results, 3881e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor unsigned *IsIncomplete); 3882e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor 3883e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor/** 3884e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \brief Returns the USR for the container for the current code completion 3885e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * context. If there is not a container for the current context, this 3886e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * function will return the empty string. 3887e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3888e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param Results the code completion results to query 3889e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3890e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \returns the USR for the container 3891e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor */ 3892e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCINDEX_LINKAGE 3893e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results); 38943da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 38950a47d69af8bda945352997af3da4687a3356096aDouglas Gregor 38960a47d69af8bda945352997af3da4687a3356096aDouglas Gregor/** 38970a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \brief Returns the currently-entered selector for an Objective-C message 38980a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * send, formatted like "initWithFoo:bar:". Only guaranteed to return a 38990a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * non-empty string for CXCompletionContext_ObjCInstanceMessage and 39000a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * CXCompletionContext_ObjCClassMessage. 39010a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * 39020a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \param Results the code completion results to query 39030a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * 39040a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \returns the selector (or partial selector) that has been entered thus far 39050a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * for an Objective-C message send. 39060a47d69af8bda945352997af3da4687a3356096aDouglas Gregor */ 39070a47d69af8bda945352997af3da4687a3356096aDouglas GregorCINDEX_LINKAGE 39080a47d69af8bda945352997af3da4687a3356096aDouglas GregorCXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results); 39090a47d69af8bda945352997af3da4687a3356096aDouglas Gregor 39103da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor/** 391120d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * @} 391220d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor */ 39131efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 39141efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 391504bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek/** 391604bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * \defgroup CINDEX_MISC Miscellaneous utility functions 391704bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * 391804bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @{ 391904bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 392023e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek 392123e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek/** 392223e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * \brief Return a version string, suitable for showing to a user, but not 392323e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * intended to be parsed (the format is not guaranteed to be stable). 392423e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek */ 3925a2a9d6e4e5b6001b86b7dfc5db1ea296ce29a3d3Ted KremenekCINDEX_LINKAGE CXString clang_getClangVersion(); 392604bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek 3927d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek 3928d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek/** 3929d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * \brief Enable/disable crash recovery. 3930d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * 3931d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * \param Flag to indicate if crash recovery is enabled. A non-zero value 3932d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * enables crash recovery, while 0 disables it. 3933d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek */ 3934d2427ddf00aacdc288c386f3882e0821ca9bd27bTed KremenekCINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled); 3935d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek 393616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek /** 3937896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Visitor invoked for each file in a translation unit 393816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * (used with clang_getInclusions()). 393916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * 394016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * This visitor function will be invoked by clang_getInclusions() for each 394116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * file included (either at the top-level or by #include directives) within 394216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * a translation unit. The first argument is the file being included, and 394316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the second and third arguments provide the inclusion stack. The 394416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * array is sorted in order of immediate inclusion. For example, 394516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the first element refers to the location that included 'included_file'. 394616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 394716b55a71695a33c094383295cc7b7a2080e098daTed Kremenektypedef void (*CXInclusionVisitor)(CXFile included_file, 394816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXSourceLocation* inclusion_stack, 394916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek unsigned include_len, 395016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 395116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 395216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 395316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * \brief Visit the set of preprocessor inclusions in a translation unit. 395416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * The visitor function is called with the provided data for every included 395516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * file. This does not include headers included by the PCH file (unless one 395616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * is inspecting the inclusions in the PCH file itself). 395716b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 395816b55a71695a33c094383295cc7b7a2080e098daTed KremenekCINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu, 395916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXInclusionVisitor visitor, 396016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 396116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 396216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 396304bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @} 396404bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 39651efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 396697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** \defgroup CINDEX_REMAPPING Remapping functions 396797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 396897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * @{ 396997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 397097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 397197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 397297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief A remapping of original source files and their translated files. 397397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 397497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidistypedef void *CXRemapping; 397597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 397697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 397797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Retrieve a remapping. 397897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 397997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param path the path that contains metadata about remappings. 398097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 398197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \returns the requested remapping. This remapping must be freed 398297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred. 398397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 398497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path); 398597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 398697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 398730660a898545416f0fea2d717f16f75640001e38Ted Kremenek * \brief Retrieve a remapping. 398830660a898545416f0fea2d717f16f75640001e38Ted Kremenek * 398930660a898545416f0fea2d717f16f75640001e38Ted Kremenek * \param filePaths pointer to an array of file paths containing remapping info. 399030660a898545416f0fea2d717f16f75640001e38Ted Kremenek * 399130660a898545416f0fea2d717f16f75640001e38Ted Kremenek * \param numFiles number of file paths. 399230660a898545416f0fea2d717f16f75640001e38Ted Kremenek * 399330660a898545416f0fea2d717f16f75640001e38Ted Kremenek * \returns the requested remapping. This remapping must be freed 399430660a898545416f0fea2d717f16f75640001e38Ted Kremenek * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred. 399530660a898545416f0fea2d717f16f75640001e38Ted Kremenek */ 399630660a898545416f0fea2d717f16f75640001e38Ted KremenekCINDEX_LINKAGE 399730660a898545416f0fea2d717f16f75640001e38Ted KremenekCXRemapping clang_getRemappingsFromFileList(const char **filePaths, 399830660a898545416f0fea2d717f16f75640001e38Ted Kremenek unsigned numFiles); 399930660a898545416f0fea2d717f16f75640001e38Ted Kremenek 400030660a898545416f0fea2d717f16f75640001e38Ted Kremenek/** 400197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Determine the number of remappings. 400297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 400397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping); 400497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 400597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 400697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Get the original and the associated filename from the remapping. 400797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 400897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param original If non-NULL, will be set to the original filename. 400997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 401097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param transformed If non-NULL, will be set to the filename that the original 401197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * is associated with. 401297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 401397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index, 401497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis CXString *original, CXString *transformed); 401597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 401697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 401797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Dispose the remapping. 401897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 401997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE void clang_remap_dispose(CXRemapping); 402097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 402197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 402297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * @} 402397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 402497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 4025aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis/** \defgroup CINDEX_HIGH Higher level API functions 4026aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 4027aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * @{ 4028aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis */ 4029aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4030aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidisenum CXVisitorResult { 4031aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXVisit_Break, 4032aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXVisit_Continue 4033aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis}; 4034aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4035aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidistypedef struct { 4036aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis void *context; 4037aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange); 4038aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis} CXCursorAndRangeVisitor; 4039aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4040aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis/** 4041aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \brief Find references of a declaration in a specific file. 4042aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 4043aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \param cursor pointing to a declaration or a reference of one. 4044aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 4045aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \param file to search for references. 4046aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 4047aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for 4048aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * each reference found. 4049aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * The CXSourceRange will point inside the file; if the reference is inside 4050aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * a macro (and not a macro argument) the CXSourceRange will be invalid. 4051aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis */ 4052aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios KyrtzidisCINDEX_LINKAGE void clang_findReferencesInFile(CXCursor cursor, CXFile file, 4053aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXCursorAndRangeVisitor visitor); 4054aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4055aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis#ifdef __has_feature 4056aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis# if __has_feature(blocks) 4057aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4058aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidistypedef enum CXVisitorResult 4059aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange); 4060aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4061aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios KyrtzidisCINDEX_LINKAGE 4062aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidisvoid clang_findReferencesInFileWithBlock(CXCursor, CXFile, 4063aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXCursorAndRangeVisitorBlock); 4064aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4065aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis# endif 4066aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis#endif 4067aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4068bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4069bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The client's data object that is associated with a CXFile. 4070bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4071dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef void *CXIdxClientFile; 4072bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis 4073bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 40742957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief The client's data object that is associated with a semantic entity. 40752957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 40762957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidistypedef void *CXIdxClientEntity; 40772957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 40782957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 4079bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The client's data object that is associated with a semantic container 4080bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * of entities. 4081bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4082dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef void *CXIdxClientContainer; 4083bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis 4084bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4085bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The client's data object that is associated with an AST file (PCH 4086bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * or module). 4087bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4088dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef void *CXIdxClientASTFile; 40894e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4090bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4091dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis * \brief Source location passed to index callbacks. 4092bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40934e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40944e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void *ptr_data[2]; 40954e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned int_data; 40964e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxLoc; 40974e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4098bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4099bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see ppIncludedFile callback. 4100bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 41014e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4102bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4103bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Location of '#' in the #include/#import directive. 4104bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 41054e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc hashLoc; 4106bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4107bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Filename as written in the #include/#import directive. 4108bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 41094e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *filename; 4110bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4111bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The actual file that the #include/#import directive resolved to. 4112bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4113dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXFile file; 41144e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isImport; 41154e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isAngled; 41164e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxIncludedFileInfo; 41174e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4118bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4119bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see importedASTFile callback. 4120bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 41214e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 41224e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXFile file; 4123bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4124bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Location where the file is imported. It is useful mostly for 4125bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * modules. 4126bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 41274e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 4128bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4129bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Non-zero if the AST file is a module otherwise it's a PCH. 4130bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 41314e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isModule; 41324e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxImportedASTFileInfo; 41334e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4134dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef enum { 4135dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Unexposed = 0, 4136dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Typedef = 1, 4137dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Function = 2, 4138dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Variable = 3, 4139dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Field = 4, 4140dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_EnumConstant = 5, 41414e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4142dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_ObjCClass = 6, 4143dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_ObjCProtocol = 7, 4144dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_ObjCCategory = 8, 41454e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4146c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_ObjCInstanceMethod = 9, 4147c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_ObjCClassMethod = 10, 4148c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_ObjCProperty = 11, 4149c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_ObjCIvar = 12, 41504e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4151c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_Enum = 13, 4152c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_Struct = 14, 4153c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_Union = 15, 41542957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 41552957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXClass = 16, 41562957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXNamespace = 17, 41572957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXNamespaceAlias = 18, 41582957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXStaticVariable = 19, 41592957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXStaticMethod = 20, 41602957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXInstanceMethod = 21, 41612957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXConstructor = 22, 41622957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXDestructor = 23, 41632957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXConversionFunction = 24, 4164838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis CXIdxEntity_CXXTypeAlias = 25 41654e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4166dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxEntityKind; 41674e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4168838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidistypedef enum { 4169838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis CXIdxEntityLang_None = 0, 4170838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis CXIdxEntityLang_C = 1, 4171838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis CXIdxEntityLang_ObjC = 2, 4172838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis CXIdxEntityLang_CXX = 3 4173838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis} CXIdxEntityLanguage; 4174838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis 41752957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 41762957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief Extra C++ template information for an entity. This can apply to: 41772957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_Function 41782957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_CXXClass 41792957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_CXXStaticMethod 41802957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_CXXInstanceMethod 41812957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_CXXConstructor 41822957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_CXXConversionFunction 41832957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_CXXTypeAlias 41842957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 41852957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidistypedef enum { 41862957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_NonTemplate = 0, 41872957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_Template = 1, 41882957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_TemplatePartialSpecialization = 2, 41892957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_TemplateSpecialization = 3 41902957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis} CXIdxEntityCXXTemplateKind; 41912957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 4192b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidistypedef enum { 4193b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxAttr_Unexposed = 0, 4194b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxAttr_IBAction = 1, 4195b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxAttr_IBOutlet = 2, 4196b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxAttr_IBOutletCollection = 3 4197b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis} CXIdxAttrKind; 4198b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis 4199b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidistypedef struct { 4200b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxAttrKind kind; 4201b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXCursor cursor; 4202b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxLoc loc; 4203b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis} CXIdxAttrInfo; 4204b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis 4205b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidistypedef struct { 4206643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis CXIdxEntityKind kind; 4207643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis CXIdxEntityCXXTemplateKind templateKind; 4208643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis CXIdxEntityLanguage lang; 4209643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis const char *name; 4210643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis const char *USR; 4211643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis CXCursor cursor; 4212643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis const CXIdxAttrInfo *const *attributes; 4213643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis unsigned numAttributes; 4214643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis} CXIdxEntityInfo; 4215643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis 4216643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidistypedef struct { 4217643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis CXCursor cursor; 4218643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis} CXIdxContainerInfo; 4219643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis 4220643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidistypedef struct { 4221b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis const CXIdxAttrInfo *attrInfo; 4222b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis const CXIdxEntityInfo *objcClass; 4223b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXCursor classCursor; 4224b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxLoc classLoc; 4225b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis} CXIdxIBOutletCollectionAttrInfo; 4226b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis 42274e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 42286ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxEntityInfo *entityInfo; 4229dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXCursor cursor; 4230dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxLoc loc; 4231b1febb646bf7a2f319ad894c9833968c52d21711Argyrios Kyrtzidis const CXIdxContainerInfo *semanticContainer; 4232b1febb646bf7a2f319ad894c9833968c52d21711Argyrios Kyrtzidis /** 4233b1febb646bf7a2f319ad894c9833968c52d21711Argyrios Kyrtzidis * \brief Generally same as \see semanticContainer but can be different in 4234b1febb646bf7a2f319ad894c9833968c52d21711Argyrios Kyrtzidis * cases like out-of-line C++ member functions. 4235b1febb646bf7a2f319ad894c9833968c52d21711Argyrios Kyrtzidis */ 4236b1febb646bf7a2f319ad894c9833968c52d21711Argyrios Kyrtzidis const CXIdxContainerInfo *lexicalContainer; 4237dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis int isRedeclaration; 42384e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isDefinition; 4239c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis int isContainer; 42402957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis const CXIdxContainerInfo *declAsContainer; 4241c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis /** 4242c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis * \brief Whether the declaration exists in code or was created implicitly 4243c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis * by the compiler, e.g. implicit objc methods for properties. 4244c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis */ 4245c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis int isImplicit; 4246b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis const CXIdxAttrInfo *const *attributes; 4247b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis unsigned numAttributes; 4248dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxDeclInfo; 42494e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4250dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef enum { 4251dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxObjCContainer_ForwardRef = 0, 4252dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxObjCContainer_Interface = 1, 4253dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxObjCContainer_Implementation = 2 4254dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxObjCContainerKind; 42554e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 42564e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 42576ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxDeclInfo *declInfo; 4258dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxObjCContainerKind kind; 4259dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxObjCContainerDeclInfo; 42604e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 42614e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 42626ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxEntityInfo *base; 42636ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis CXCursor cursor; 42644e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 42656ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis} CXIdxBaseClassInfo; 42664e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 42674e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 42686ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxEntityInfo *protocol; 42696ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis CXCursor cursor; 42704e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 42714e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCProtocolRefInfo; 42724e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 42734e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 42746ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxObjCProtocolRefInfo *const *protocols; 42754e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned numProtocols; 4276c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis} CXIdxObjCProtocolRefListInfo; 42774e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 42784e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4279c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis const CXIdxObjCContainerDeclInfo *containerInfo; 4280c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis const CXIdxBaseClassInfo *superInfo; 4281c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis const CXIdxObjCProtocolRefListInfo *protocols; 4282c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis} CXIdxObjCInterfaceDeclInfo; 42834e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 42842957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidistypedef struct { 4285c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis const CXIdxObjCContainerDeclInfo *containerInfo; 4286c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis const CXIdxEntityInfo *objcClass; 4287c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis CXCursor classCursor; 4288c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis CXIdxLoc classLoc; 4289c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis const CXIdxObjCProtocolRefListInfo *protocols; 4290c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis} CXIdxObjCCategoryDeclInfo; 4291c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis 4292c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidistypedef struct { 42932957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis const CXIdxDeclInfo *declInfo; 4294792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidis const CXIdxEntityInfo *getter; 4295792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidis const CXIdxEntityInfo *setter; 4296792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidis} CXIdxObjCPropertyDeclInfo; 4297792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidis 4298792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidistypedef struct { 4299792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidis const CXIdxDeclInfo *declInfo; 43002957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis const CXIdxBaseClassInfo *const *bases; 43012957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis unsigned numBases; 43022957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis} CXIdxCXXClassDeclInfo; 43032957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 4304bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4305bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see indexEntityReference callback. 4306bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4307aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidistypedef enum { 4308bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4309bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The entity is referenced directly in user's code. 4310bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4311aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis CXIdxEntityRef_Direct = 1, 4312bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4313b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis * \brief An implicit reference, e.g. a reference of an ObjC method via the 4314b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis * dot syntax. 4315bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4316b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxEntityRef_Implicit = 2 4317aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis} CXIdxEntityRefKind; 4318aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis 4319bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4320bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see indexEntityReference callback. 4321bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 43224e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4323b1febb646bf7a2f319ad894c9833968c52d21711Argyrios Kyrtzidis CXIdxEntityRefKind kind; 4324bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4325bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Reference cursor. 4326bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 43274e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXCursor cursor; 43284e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 4329bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4330bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The entity that gets referenced. 4331bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 43326ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxEntityInfo *referencedEntity; 4333bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4334bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Immediate "parent" of the reference. For example: 4335bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4336bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \code 4337bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * Foo *var; 4338bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \endcode 4339bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4340bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * The parent of reference of type 'Foo' is the variable 'var'. 4341e422e45a6a89d450b8eca10f671b49874e87617aArgyrios Kyrtzidis * For references inside statement bodies of functions/methods, 4342e422e45a6a89d450b8eca10f671b49874e87617aArgyrios Kyrtzidis * the parentEntity will be the function/method. 4343bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 43446ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxEntityInfo *parentEntity; 4345bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4346e422e45a6a89d450b8eca10f671b49874e87617aArgyrios Kyrtzidis * \brief Lexical container context of the reference. 4347bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 43482957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis const CXIdxContainerInfo *container; 43494e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxEntityRefInfo; 43504e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 43514e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4352bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 43536ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis * \brief Called periodically to check whether indexing should be aborted. 43546ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis * Should return 0 to continue, and non-zero to abort. 43556ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis */ 43566ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis int (*abortQuery)(CXClientData client_data, void *reserved); 43576ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis 43586ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis /** 4359b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis * \brief Called at the end of indexing; passes the complete diagnostic set. 4360bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 43614e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*diagnostic)(CXClientData client_data, 4362b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXDiagnosticSet, void *reserved); 43634e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4364dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientFile (*enteredMainFile)(CXClientData client_data, 4365dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXFile mainFile, void *reserved); 4366dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis 4367bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4368bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called when a file gets #included/#imported. 4369bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4370dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientFile (*ppIncludedFile)(CXClientData client_data, 43716ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxIncludedFileInfo *); 43724e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4373bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4374bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called when a AST file (PCH or module) gets imported. 4375bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4376bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * AST files will not get indexed (there will not be callbacks to index all 4377bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * the entities in an AST file). The recommended action is that, if the AST 4378bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * file is not already indexed, to block further indexing and initiate a new 43796ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis * indexing job specific to the AST file. 4380bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4381dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientASTFile (*importedASTFile)(CXClientData client_data, 43826ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxImportedASTFileInfo *); 43834e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4384bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4385bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called at the beginning of indexing a translation unit. 4386bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4387dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data, 43886ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis void *reserved); 43894e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 43906ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis void (*indexDeclaration)(CXClientData client_data, 43912957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis const CXIdxDeclInfo *); 43924e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4393bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4394bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called to index a reference of an entity. 4395bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 43964e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*indexEntityReference)(CXClientData client_data, 43976ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxEntityRefInfo *); 43984e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 43994e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} IndexerCallbacks; 44004e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4401ab336c1adca7f6920fd886c132f199e469b63fb5NAKAMURA TakumiCINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind); 44026ec43adc39006a7fce94188956d0239bd54c0363Argyrios KyrtzidisCINDEX_LINKAGE const CXIdxObjCContainerDeclInfo * 44036ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidisclang_index_getObjCContainerDeclInfo(const CXIdxDeclInfo *); 44046ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis 44056ec43adc39006a7fce94188956d0239bd54c0363Argyrios KyrtzidisCINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo * 44066ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidisclang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *); 4407dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis 4408ab336c1adca7f6920fd886c132f199e469b63fb5NAKAMURA TakumiCINDEX_LINKAGE 44096ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidisconst CXIdxObjCCategoryDeclInfo * 44106ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidisclang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *); 44116ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis 4412c71d55469e7d5f7b376a30620617a175a9442da9Argyrios KyrtzidisCINDEX_LINKAGE const CXIdxObjCProtocolRefListInfo * 4413c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidisclang_index_getObjCProtocolRefListInfo(const CXIdxDeclInfo *); 4414dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis 4415792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios KyrtzidisCINDEX_LINKAGE const CXIdxObjCPropertyDeclInfo * 4416792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidisclang_index_getObjCPropertyDeclInfo(const CXIdxDeclInfo *); 4417792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidis 4418b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios KyrtzidisCINDEX_LINKAGE const CXIdxIBOutletCollectionAttrInfo * 4419b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidisclang_index_getIBOutletCollectionAttrInfo(const CXIdxAttrInfo *); 4420b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis 44212957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE const CXIdxCXXClassDeclInfo * 44222957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidisclang_index_getCXXClassDeclInfo(const CXIdxDeclInfo *); 44232957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 44242957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 44252957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief For retrieving a custom CXIdxClientContainer attached to a 44262957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * container. 44272957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 44282957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE CXIdxClientContainer 44292957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidisclang_index_getClientContainer(const CXIdxContainerInfo *); 44302957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 44312957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 44322957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief For setting a custom CXIdxClientContainer attached to a 44332957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * container. 44342957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 44352957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE void 44362957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidisclang_index_setClientContainer(const CXIdxContainerInfo *,CXIdxClientContainer); 44372957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 44382957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 44392957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief For retrieving a custom CXIdxClientEntity attached to an entity. 44402957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 44412957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE CXIdxClientEntity 44422957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidisclang_index_getClientEntity(const CXIdxEntityInfo *); 44432957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 44442957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 44452957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief For setting a custom CXIdxClientEntity attached to an entity. 44462957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 44472957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE void 44482957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidisclang_index_setClientEntity(const CXIdxEntityInfo *, CXIdxClientEntity); 44492957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 44502957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 44512957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief An indexing action, to be applied to one or multiple translation units 44522957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * but not on concurrent threads. If there are threads doing indexing 44532957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * concurrently, they should use different CXIndexAction objects. 44542957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 44552957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidistypedef void *CXIndexAction; 44562957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 44572957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 44582957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief An indexing action, to be applied to one or multiple translation units 44592957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * but not on concurrent threads. If there are threads doing indexing 44602957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * concurrently, they should use different CXIndexAction objects. 44612957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * 44622957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \param CIdx The index object with which the index action will be associated. 44632957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 44642957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE CXIndexAction clang_IndexAction_create(CXIndex CIdx); 44652957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 44662957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 44672957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief Destroy the given index action. 44682957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * 44692957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * The index action must not be destroyed until all of the translation units 44702957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * created within that index action have been destroyed. 44712957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 44722957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE void clang_IndexAction_dispose(CXIndexAction); 44732957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 447421ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidistypedef enum { 447521ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis /** 447621ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * \brief Used to indicate that no special indexing options are needed. 447721ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis */ 447821ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis CXIndexOpt_None = 0x0, 447921ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis 448021ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis /** 448121ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * \brief Used to indicate that \see indexEntityReference should be invoked 4482b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis * for only one reference of an entity per source file that does not also 4483b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis * include a declaration/definition of the entity. 448421ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis */ 448522490747c123a78feec089539f30426084d348cfArgyrios Kyrtzidis CXIndexOpt_SuppressRedundantRefs = 0x1, 448622490747c123a78feec089539f30426084d348cfArgyrios Kyrtzidis 448722490747c123a78feec089539f30426084d348cfArgyrios Kyrtzidis /** 448822490747c123a78feec089539f30426084d348cfArgyrios Kyrtzidis * \brief Function-local symbols should be indexed. If this is not set 448922490747c123a78feec089539f30426084d348cfArgyrios Kyrtzidis * function-local symbols will be ignored. 449022490747c123a78feec089539f30426084d348cfArgyrios Kyrtzidis */ 449158d2dbea680a75de266c5eff77cc15c323cfd48aArgyrios Kyrtzidis CXIndexOpt_IndexFunctionLocalSymbols = 0x2, 449258d2dbea680a75de266c5eff77cc15c323cfd48aArgyrios Kyrtzidis 449358d2dbea680a75de266c5eff77cc15c323cfd48aArgyrios Kyrtzidis /** 449458d2dbea680a75de266c5eff77cc15c323cfd48aArgyrios Kyrtzidis * \brief Implicit function/class template instantiations should be indexed. 449558d2dbea680a75de266c5eff77cc15c323cfd48aArgyrios Kyrtzidis * If this is not set, implicit instantiations will be ignored. 449658d2dbea680a75de266c5eff77cc15c323cfd48aArgyrios Kyrtzidis */ 449758d2dbea680a75de266c5eff77cc15c323cfd48aArgyrios Kyrtzidis CXIndexOpt_IndexImplicitTemplateInstantiations = 0x4 449821ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis} CXIndexOptFlags; 449921ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis 4500bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4501bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Index the given source file and the translation unit corresponding 4502bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * to that file via callbacks implemented through \see IndexerCallbacks. 4503bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4504bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \param client_data pointer data supplied by the client, which will 4505bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * be passed to the invoked callbacks. 4506bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4507bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \param index_callbacks Pointer to indexing callbacks that the client 4508bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * implements. 4509bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4510bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \param index_callbacks_size Size of \see IndexerCallbacks structure that gets 4511bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * passed in index_callbacks. 4512bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 451321ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * \param index_options A bitmask of options that affects how indexing is 451421ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags. 4515bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4516bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \param out_TU [out] pointer to store a CXTranslationUnit that can be reused 4517bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * after indexing is finished. Set to NULL if you do not require it. 4518bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 451921ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * \returns If there is a failure from which the there is no recovery, returns 4520bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * non-zero, otherwise returns 0. 452121ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * 4522bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * The rest of the parameters are the same as \see clang_parseTranslationUnit. 4523bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 45242957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE int clang_indexSourceFile(CXIndexAction, 45254e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXClientData client_data, 45264e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis IndexerCallbacks *index_callbacks, 45274e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned index_callbacks_size, 45284e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned index_options, 45294e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *source_filename, 45304e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char * const *command_line_args, 45314e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int num_command_line_args, 45324e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis struct CXUnsavedFile *unsaved_files, 45334e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned num_unsaved_files, 45344e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXTranslationUnit *out_TU, 45354e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned TU_options); 45364e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4537bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 453821ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * \brief Index the given translation unit via callbacks implemented through 453921ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * \see IndexerCallbacks. 454021ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * 454121ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * The order of callback invocations is not guaranteed to be the same as 454221ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * when indexing a source file. The high level order will be: 454321ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * 454421ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * -Preprocessor callbacks invocations 454521ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * -Declaration/reference callbacks invocations 454621ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * -Diagnostic callback invocations 454721ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * 454821ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * The parameters are the same as \see clang_indexSourceFile. 454921ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * 455021ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * \returns If there is a failure from which the there is no recovery, returns 455121ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * non-zero, otherwise returns 0. 455221ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis */ 45532957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE int clang_indexTranslationUnit(CXIndexAction, 455421ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis CXClientData client_data, 455521ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis IndexerCallbacks *index_callbacks, 455621ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis unsigned index_callbacks_size, 45572957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis unsigned index_options, 45582957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXTranslationUnit); 455921ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis 456021ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis/** 4561bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Retrieve the CXIdxFile, file, line, column, and offset represented by 4562bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * the given CXIdxLoc. 4563bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4564bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * If the location refers into a macro expansion, retrieves the 4565bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * location of the macro expansion and if it refers into a macro argument 4566bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * retrieves the location of the argument. 4567bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 45684e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc, 4569dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientFile *indexFile, 45704e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXFile *file, 45714e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned *line, 45724e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned *column, 45734e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned *offset); 45744e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4575bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4576bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Retrieve the CXSourceLocation represented by the given CXIdxLoc. 4577bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 45784e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCINDEX_LINKAGE 45794e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc); 45804e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4581aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis/** 4582aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * @} 4583aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis */ 4584aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4585c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 4586c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 4587c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 45881efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 4589d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifdef __cplusplus 4590d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek} 4591d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 4592d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 4593d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 4594