Index.h revision 995aaf9c8f0131bef0215a9a0bc794b83a49e0b7
1d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek/*===-- clang-c/Index.h - Indexing Public C Interface -------------*- C -*-===*\ 2d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 3d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* The LLVM Compiler Infrastructure *| 4d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 5d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* This file is distributed under the University of Illinois Open Source *| 6d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* License. See LICENSE.TXT for details. *| 7d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 8d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|*===----------------------------------------------------------------------===*| 9d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 10d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* This header provides a public inferface to a Clang library for extracting *| 11d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* high-level symbol information from source files without exposing the full *| 12d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* Clang C++ API. *| 13d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 14d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek\*===----------------------------------------------------------------------===*/ 15d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 16d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifndef CLANG_C_INDEX_H 17d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#define CLANG_C_INDEX_H 18d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 1988145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff#include <sys/stat.h> 203d31560343856c573376a04558a7111e7afad4f7Chandler Carruth#include <time.h> 210a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor#include <stdio.h> 2288145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff 23d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifdef __cplusplus 24d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenekextern "C" { 25d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 26d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 2788145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff/* MSVC DLL import/export. */ 282e06fc877a633abea3b40a64950c7316dac29ca8John Thompson#ifdef _MSC_VER 292e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #ifdef _CINDEX_LIB_ 302e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #define CINDEX_LINKAGE __declspec(dllexport) 312e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #else 322e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #define CINDEX_LINKAGE __declspec(dllimport) 332e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #endif 342e06fc877a633abea3b40a64950c7316dac29ca8John Thompson#else 352e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #define CINDEX_LINKAGE 362e06fc877a633abea3b40a64950c7316dac29ca8John Thompson#endif 372e06fc877a633abea3b40a64950c7316dac29ca8John Thompson 3820d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor/** \defgroup CINDEX C Interface to Clang 3920d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * 401efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The C Interface to Clang provides a relatively small API that exposes 41f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * facilities for parsing source code into an abstract syntax tree (AST), 42f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * loading already-parsed ASTs, traversing the AST, associating 43f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * physical source locations with elements within the AST, and other 44f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * facilities that support Clang-based development tools. 45f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 461efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * This C interface to Clang will never provide all of the information 47f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * representation stored in Clang's C++ AST, nor should it: the intent is to 48f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * maintain an API that is relatively stable from one release to the next, 49f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * providing only the basic functionality needed to support development tools. 501efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 511efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * To avoid namespace pollution, data types are prefixed with "CX" and 52f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * functions are prefixed with "clang_". 5320d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * 5420d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * @{ 5520d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor */ 561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 577f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 587f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief An "index" that consists of a set of translation units that would 597f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * typically be linked together into an executable or library. 607f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 617f17376e0931a337d544b75d9030bc92763be287Douglas Gregortypedef void *CXIndex; 62600866cc7d6d9ec2e27d4b6d6ec461f6463b5ab6Steve Naroff 637f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 647f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief A single translation unit, which resides in an index. 657f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 6650398199fb10e196a8d92fbf7a062dbe42ed88fdSteve Narofftypedef void *CXTranslationUnit; /* A translation unit instance. */ 67600866cc7d6d9ec2e27d4b6d6ec461f6463b5ab6Steve Naroff 687f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 69c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Opaque pointer representing client data that will be passed through 70c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to various callbacks and visitors. 717f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 72c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregortypedef void *CXClientData; 731efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 74735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor/** 75735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * \brief Provides the contents of a file that has not yet been saved to disk. 76735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * 77735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * Each CXUnsavedFile instance provides the name of a file on the 78735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * system along with the current contents of that file that have not 79735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * yet been saved to disk. 80735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 81735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregorstruct CXUnsavedFile { 821efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 831efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief The file whose contents have not yet been saved. 84735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * 85735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * This file must already exist in the file system. 86735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 87735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor const char *Filename; 88735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor 891efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 90c8dfe5ece04e683106eb96c58a2999f70b53ac21Douglas Gregor * \brief A buffer containing the unsaved contents of this file. 91735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 92735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor const char *Contents; 93735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor 94735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor /** 95c8dfe5ece04e683106eb96c58a2999f70b53ac21Douglas Gregor * \brief The length of the unsaved contents of this buffer. 96735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 97735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor unsigned long Length; 98735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor}; 99735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor 100076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne/** 101076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief Describes the availability of a particular entity, which indicates 102076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * whether the use of this entity will result in a warning or error due to 103076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * it being deprecated or unavailable. 104076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 10558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorenum CXAvailabilityKind { 106076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne /** 107076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief The entity is available. 108076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 10958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailability_Available, 110076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne /** 111076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief The entity is available, but has been deprecated (and its use is 112076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * not recommended). 113076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 11458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailability_Deprecated, 115076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne /** 116076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief The entity is not available; any use of it will be an error. 117076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 11858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailability_NotAvailable 11958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor}; 12058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 1217f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1227f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \defgroup CINDEX_STRING String manipulation routines 1237f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * 1247f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * @{ 1257f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 1261efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1277f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1287f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief A character string. 1297f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * 1307f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * The \c CXString type is used to return strings from the interface when 1317f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * the ownership of that string might different from one call to the next. 1327f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * Use \c clang_getCString() to retrieve the string data and, once finished 1337f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * with the string data, call \c clang_disposeString() to free the string. 134ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff */ 135ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Narofftypedef struct { 136ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff const char *Spelling; 137ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff /* A 1 value indicates the clang_ indexing API needed to allocate the string 138ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff (and it must be freed by clang_disposeString()). */ 139ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff int MustFreeString; 140ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff} CXString; 141ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff 1427f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1437f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief Retrieve the character data associated with the given string. 1447f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 145ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve NaroffCINDEX_LINKAGE const char *clang_getCString(CXString string); 146ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff 1477f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1487f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief Free the given string, 1497f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 150ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve NaroffCINDEX_LINKAGE void clang_disposeString(CXString string); 151ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff 1527f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1537f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * @} 1547f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 1551efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 157e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * \brief clang_createIndex() provides a shared context for creating 158e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * translation units. It provides two options: 159e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * 160e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local" 161e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * declarations (when loading any new translation units). A "local" declaration 1621efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * is one that belongs in the translation unit itself and not in a precompiled 163e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * header that was used by the translation unit. If zero, all declarations 164e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * will be enumerated. 165e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * 166b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * Here is an example: 167b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 1680a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * // excludeDeclsFromPCH = 1, displayDiagnostics=1 1690a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * Idx = clang_createIndex(1, 1); 170b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 171b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // IndexTest.pch was produced with the following command: 172b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch" 173b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * TU = clang_createTranslationUnit(Idx, "IndexTest.pch"); 174b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 175b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // This will load all the symbols from 'IndexTest.pch' 1761efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * clang_visitChildren(clang_getTranslationUnitCursor(TU), 177002a528ab0189fc60cfbf9328962c96ccbe567eeDouglas Gregor * TranslationUnitVisitor, 0); 178b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * clang_disposeTranslationUnit(TU); 179b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 180b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // This will load all the symbols from 'IndexTest.c', excluding symbols 181b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // from 'IndexTest.pch'. 182fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" }; 183fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args, 184fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * 0, 0); 185b2cd48756119f4d8d2a865b4b3e0e8efd02e26a0Douglas Gregor * clang_visitChildren(clang_getTranslationUnitCursor(TU), 186b2cd48756119f4d8d2a865b4b3e0e8efd02e26a0Douglas Gregor * TranslationUnitVisitor, 0); 187b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * clang_disposeTranslationUnit(TU); 188b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 189b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * This process of creating the 'pch', loading it separately, and using it (via 190b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks 191b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * (which gives the indexer the same performance benefit as the compiler). 192e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff */ 1930a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH, 1940a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor int displayDiagnostics); 195896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1960087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor/** 1970087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * \brief Destroy the given index. 1980087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * 1990087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * The index must not be destroyed until all of the translation units created 2000087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * within that index have been destroyed. 2010087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor */ 2028506dde586459887b7e14e23a30af8ac5be5adb6Daniel DunbarCINDEX_LINKAGE void clang_disposeIndex(CXIndex index); 2031efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2041efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 205c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_FILES File manipulation routines 206f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 207f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @{ 208f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 2091efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 210f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 211f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief A particular source file that is part of a translation unit. 212f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 213f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregortypedef void *CXFile; 2141efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 215f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor 216f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 217f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief Retrieve the complete file and path name of the given file. 21888145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff */ 21974844072411bae91d5dbb89955d200cbe1e0a1c8Ted KremenekCINDEX_LINKAGE CXString clang_getFileName(CXFile SFile); 2201efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 221f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 222f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief Retrieve the last modification time of the given file. 223f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 22408b0e8daeb683686b876d72674962ad96df21d45Douglas GregorCINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile); 22588145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff 2263c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor/** 227b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a file handle within the given translation unit. 228b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 229b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \param tu the translation unit 2301efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 231b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \param file_name the name of the file. 232b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 233b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns the file handle for the named file in the translation unit \p tu, 234b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * or a NULL file handle if the file was not a part of this translation unit. 235b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 2361efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu, 237b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor const char *file_name); 2381efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 239b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 240f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @} 241f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 242f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor 243f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 244f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \defgroup CINDEX_LOCATIONS Physical source locations 245f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 246f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * Clang represents physical source locations in its abstract syntax tree in 247f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * great detail, with file, line, and column information for the majority of 248f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * the tokens parsed in the source code. These data types and functions are 249f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * used to represent source location information, either for a particular 250f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * point in the program or for a range of points in the program, and extract 251f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * specific location information from those data types. 252f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 253f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @{ 254f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 2551efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 256f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 2571db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * \brief Identifies a specific source location within a translation 2581db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * unit. 2591db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 2601db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * Use clang_getInstantiationLocation() to map a source location to a 2611db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * particular file, line, and column. 2623c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor */ 2633c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregortypedef struct { 2645352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor void *ptr_data[2]; 2651db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned int_data; 2663c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor} CXSourceLocation; 267fe6fd3d41a7f48317d6856c9327b6cead32c3498Ted Kremenek 2683c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor/** 269d52864bd33c66aacc84133460d8c9c0dfcdd5c18Daniel Dunbar * \brief Identifies a half-open character range in the source code. 2703c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor * 2711db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the 2721db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * starting and end locations from a source range, respectively. 2733c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor */ 2743c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregortypedef struct { 2755352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor void *ptr_data[2]; 2761db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned begin_int_data; 2771db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned end_int_data; 2783c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor} CXSourceRange; 279fe6fd3d41a7f48317d6856c9327b6cead32c3498Ted Kremenek 2801db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor/** 281b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a NULL (invalid) source location. 282b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 283b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getNullLocation(); 2841efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 285b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 286b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \determine Determine whether two source locations, which must refer into 2871efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * the same translation unit, refer to exactly the same point in the source 288b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * code. 289b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 290b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns non-zero if the source locations refer to the same location, zero 291b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * if they refer to different locations. 292b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 293b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1, 294b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXSourceLocation loc2); 2951efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 296b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 2971efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieves the source location associated with a given file/line/column 2981efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * in a particular translation unit. 299b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 300b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu, 301b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXFile file, 302b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor unsigned line, 303b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor unsigned column); 30483889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall/** 30583889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall * \brief Retrieves the source location associated with a given character offset 30683889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall * in a particular translation unit. 30783889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall */ 30883889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid ChisnallCINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu, 30983889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall CXFile file, 31083889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall unsigned offset); 3111efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 312b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 3135352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve a NULL (invalid) source range. 3145352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 3155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXSourceRange clang_getNullRange(); 316896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 318b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a source range given the beginning and ending source 319b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * locations. 320b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 321b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin, 322b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXSourceLocation end); 3231efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 324b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 32546766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * \brief Retrieve the file, line, column, and offset represented by 32646766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * the given source location. 3271db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3281efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param location the location within a source file that will be decomposed 3291efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * into its parts. 3301db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3311efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param file [out] if non-NULL, will be set to the file to which the given 3321db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * source location points. 3331db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3341efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param line [out] if non-NULL, will be set to the line to which the given 3351db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * source location points. 3361db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3371efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param column [out] if non-NULL, will be set to the column to which the given 3381efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source location points. 33946766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * 34046766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * \param offset [out] if non-NULL, will be set to the offset into the 34146766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * buffer to which the given source location points. 3421db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 3431db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location, 3441db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor CXFile *file, 3451db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned *line, 34646766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor unsigned *column, 34746766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor unsigned *offset); 348e69517ce61638f12c9abe4605753a45275ac4e37Douglas Gregor 349e69517ce61638f12c9abe4605753a45275ac4e37Douglas Gregor/** 3501efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve a source location representing the first character within a 3511efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source range. 3521db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 3531db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range); 3541db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor 3551db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor/** 3561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve a source location representing the last character within a 3571efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source range. 3581db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 3591db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range); 3601db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor 361f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 362f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @} 363f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 364c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 365c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 3665352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \defgroup CINDEX_DIAG Diagnostic reporting 3675352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 3685352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @{ 3695352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 3705352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 3715352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 3725352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Describes the severity of a particular diagnostic. 3735352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 3745352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorenum CXDiagnosticSeverity { 3755352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 376896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief A diagnostic that has been suppressed, e.g., by a command-line 3775352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * option. 3785352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 3795352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Ignored = 0, 380896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3815352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 3825352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic is a note that should be attached to the 3835352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * previous (non-note) diagnostic. 3845352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 3855352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Note = 1, 3865352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 3875352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 3885352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates suspicious code that may not be 3895352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * wrong. 3905352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 3915352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Warning = 2, 3925352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 3935352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 3945352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates that the code is ill-formed. 3955352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 3965352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Error = 3, 3975352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 3985352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 3995352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates that the code is ill-formed such 4005352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * that future parser recovery is unlikely to produce useful 4015352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * results. 4025352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4035352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Fatal = 4 4045352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor}; 4055352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4065352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 4075352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief A single diagnostic, containing the diagnostic's severity, 4085352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * location, text, source ranges, and fix-it hints. 4095352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4105352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregortypedef void *CXDiagnostic; 4115352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 413a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced for the given 414a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * translation unit. 415a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 416a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit); 417a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 418a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 419a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given translation unit. 4205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 421a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Unit the translation unit to query. 422a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 4235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 424a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 425a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 4265352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 427a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit, 428a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 429a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 430a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 431a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Destroy a diagnostic. 432a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 433a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic); 4345352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4355352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 4360a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Options to control the display of diagnostics. 4370a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4380a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * The values in this enum are meant to be combined to customize the 4390a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * behavior of \c clang_displayDiagnostic(). 4400a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 4410a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregorenum CXDiagnosticDisplayOptions { 4420a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 4430a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Display the source-location information where the 4440a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic was located. 4450a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4460a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * When set, diagnostics will be prefixed by the file, line, and 4470a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * (optionally) column to which the diagnostic refers. For example, 4480a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4490a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \code 4500a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * test.c:28: warning: extra tokens at end of #endif directive 4510a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \endcode 4520a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4530a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-source-location. 4540a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 4550a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplaySourceLocation = 0x01, 4560a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 4570a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 4580a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 4590a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include the column number. 4600a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4610a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-column. 4620a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 4630a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplayColumn = 0x02, 4640a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 4650a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 4660a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 4670a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include information about source ranges in a 4680a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * machine-parsable format. 4690a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 470896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * This option corresponds to the clang flag 4710a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \c -fdiagnostics-print-source-range-info. 4720a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 4730a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplaySourceRanges = 0x04 4740a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor}; 4750a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 4760a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 477274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \brief Format the given diagnostic in a manner that is suitable for display. 4780a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 479274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * This routine will format the given diagnostic to a string, rendering 480896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the diagnostic according to the various options given. The 481896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \c clang_defaultDiagnosticDisplayOptions() function returns the set of 4820a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * options that most closely mimics the behavior of the clang compiler. 4830a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4840a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \param Diagnostic The diagnostic to print. 4850a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 486896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Options A set of options that control the diagnostic display, 4870a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * created by combining \c CXDiagnosticDisplayOptions values. 488274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * 489274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \returns A new string containing for formatted diagnostic. 4900a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 491274f1906f12ebf8fcc179701deeda6d3271120c1Douglas GregorCINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic, 492274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor unsigned Options); 4930a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 4940a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 4950a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Retrieve the set of display options most similar to the 4960a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * default behavior of the clang compiler. 4970a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 4980a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \returns A set of display options suitable for use with \c 4990a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * clang_displayDiagnostic(). 5000a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 5010a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void); 5020a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 5030a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 5040a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Print a diagnostic to the given file. 5050a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 5060a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 5070a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 5085352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the severity of the given diagnostic. 5095352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 510896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE enum CXDiagnosticSeverity 5115352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getDiagnosticSeverity(CXDiagnostic); 5125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5135352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5145352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the source location of the given diagnostic. 5155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 5165352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * This location is where Clang would print the caret ('^') when 5175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * displaying the diagnostic on the command line. 5185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5195352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic); 5205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5215352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5225352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the text of the given diagnostic. 5235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic); 525a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor 526a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor/** 527a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Determine the number of source ranges associated with the given 528a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * diagnostic. 529a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor */ 530a3890baf1256ff26081306c7fef70202f8223f41Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic); 531896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 5325352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 533a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Retrieve a source range associated with the diagnostic. 5345352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 535a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * A diagnostic's source ranges highlight important elements in the source 5365352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * code. On the command line, Clang displays source ranges by 537896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * underlining them with '~' characters. 5385352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 539a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \param Diagnostic the diagnostic whose range is being extracted. 5405352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 541896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Range the zero-based index specifying which range to 5425352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 543a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \returns the requested source range. 5445352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 545896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic, 546a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor unsigned Range); 5475352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5485352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5495352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the number of fix-it hints associated with the 5505352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * given diagnostic. 5515352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5525352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic); 5535352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5545352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 555473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \brief Retrieve the replacement information for a given fix-it. 5565352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 557473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * Fix-its are described in terms of a source range whose contents 558473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * should be replaced by a string. This approach generalizes over 559473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * three kinds of operations: removal of source code (the range covers 560473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * the code to be removed and the replacement string is empty), 561473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replacement of source code (the range covers the code to be 562473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced and the replacement string provides the new code), and 563473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion (both the start and end of the range point at the 564473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion location, and the replacement string provides the text to 565473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insert). 5665352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 567473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param Diagnostic The diagnostic whose fix-its are being queried. 5685352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 569473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param FixIt The zero-based index of the fix-it. 5705352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 571473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param ReplacementRange The source range whose contents will be 572473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced with the returned replacement string. Note that source 573473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * ranges are half-open ranges [a, b), so the source code should be 574473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced from a and up to (but not including) b. 5755352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 576473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \returns A string containing text that should be replace the source 577473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * code indicated by the \c ReplacementRange. 5785352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 579896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic, 580473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor unsigned FixIt, 581473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor CXSourceRange *ReplacementRange); 5825352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5835352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5845352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 5855352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5865352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5875352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5885352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation 5895352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 5905352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * The routines in this group provide the ability to create and destroy 5915352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * translation units from files, either by parsing the contents of the files or 5925352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * by reading in a serialized representation of a translation unit. 5935352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 5945352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @{ 5955352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 596896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 5975352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5985352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Get the original translation unit source file name. 5995352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 6005352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString 6015352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getTranslationUnitSpelling(CXTranslationUnit CTUnit); 6025352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6035352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6045352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Return the CXTranslationUnit for a given source file and the provided 6055352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * command line arguments one would pass to the compiler. 6065352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6075352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: The 'source_filename' argument is optional. If the caller provides a 6085352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * NULL pointer, the name of the source file is expected to reside in the 6095352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * specified command line arguments. 6105352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6115352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: When encountered in 'clang_command_line_args', the following options 6125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * are ignored: 6135352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6145352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-c' 6155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-emit-ast' 6165352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-fsyntax-only' 6175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-o <output file>' (both '-o' and '<output file>' are ignored) 6185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6195352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param source_filename - The name of the source file to load, or NULL if the 6215352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * source file is included in clang_command_line_args. 6225352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 6245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * unsaved_files. 6255352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6265352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 6275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * but may be required for code completion, including the contents of 628c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * those files. The contents and name of these files (as specified by 629c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * CXUnsavedFile) are copied when necessary, so the client only needs to 630c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * guarantee their validity until the call to this function returns. 6315352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6325352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param diag_callback callback function that will receive any diagnostics 6335352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * emitted while processing this source file. If NULL, diagnostics will be 6345352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * suppressed. 6355352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 6365352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param diag_client_data client data that will be passed to the diagnostic 6375352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * callback function. 6385352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 6395352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile( 6405352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXIndex CIdx, 6415352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor const char *source_filename, 6425352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor int num_clang_command_line_args, 6432ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *clang_command_line_args, 6445352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor unsigned num_unsaved_files, 645a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor struct CXUnsavedFile *unsaved_files); 646896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 6475352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6485352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Create a translation unit from an AST file (-emit-ast). 6495352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 650896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(CXIndex, 651a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const char *ast_filename); 6525352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 65344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor/** 65444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Flags that control the creation of translation units. 65544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 65644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * The enumerators in this enumeration type are meant to be bitwise 65744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * ORed together to specify which options should be used when 65844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * constructing the translation unit. 65944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 6605a43021ac491bf091494167127772a20d9a9bb48Douglas Gregorenum CXTranslationUnit_Flags { 6615a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 6625a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that no special translation-unit options are 6635a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * needed. 6645a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 6655a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor CXTranslationUnit_None = 0x0, 6665a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 6675a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 6685a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that the parser should construct a "detailed" 6695a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * preprocessing record, including all macro definitions and instantiations. 6705a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 6715a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * Constructing a detailed preprocessing record requires more memory 6725a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * and time to parse, since the information contained in the record 6735a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is usually not retained. However, it can be useful for 6745a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * applications that require more detailed information about the 6755a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * behavior of the preprocessor. 6765a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 67744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor CXTranslationUnit_DetailedPreprocessingRecord = 0x01, 67844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 67944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 680b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Used to indicate that the translation unit is incomplete. 68144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 682b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * When a translation unit is considered "incomplete", semantic 683b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * analysis that is typically performed at the end of the 684b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * translation unit will be suppressed. For example, this suppresses 685b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * the completion of tentative declarations in C and of 686b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * instantiation of implicitly-instantiation function templates in 687b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * C++. This option is typically used when parsing a header with the 688b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * intent of producing a precompiled header. 68944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 690b1c031be513705d924038f497279b9b599868ba1Douglas Gregor CXTranslationUnit_Incomplete = 0x02, 69144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 69244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 69344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Used to indicate that the translation unit should be built with an 69444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header for the preamble. 69544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 69644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * An implicit precompiled header is used as an optimization when a 69744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * particular translation unit is likely to be reparsed many times 69844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * when the sources aren't changing that often. In this case, an 69944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header will be built containing all of the 70044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * initial includes at the top of the main file (what we refer to as 70144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * the "preamble" of the file). In subsequent parses, if the 70244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * preamble or the files in it have not changed, \c 70344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * clang_reparseTranslationUnit() will re-use the implicit 70444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * precompiled header to improve parsing performance. 70544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 706e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXTranslationUnit_PrecompiledPreamble = 0x04, 707e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 708e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 709e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that the translation unit should cache some 710e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion results with each reparse of the source file. 711e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 712e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * Caching of code-completion results is a performance optimization that 713e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * introduces some overhead to reparsing but improves the performance of 714e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion operations. 715e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 71699ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CacheCompletionResults = 0x08, 71799ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 71899ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * \brief Enable precompiled preambles in C++. 71999ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 72099ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 72199ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * we are testing C++ precompiled preamble support. 72299ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 72399ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CXXPrecompiledPreamble = 0x10, 72499ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor 72599ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 72699ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * \brief Enabled chained precompiled preambles in C++. 72799ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 72899ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 72999ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * we are testing C++ precompiled preamble support. 73099ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 73199ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CXXChainedPCH = 0x20 7325a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor}; 7335a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 7345a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor/** 735b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Returns the set of flags that is suitable for parsing a translation 736b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * unit that is being edited. 737b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * 738b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * The set of flags returned provide options for \c clang_parseTranslationUnit() 739b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * to indicate that the translation unit is likely to be reparsed many times, 740b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly 741b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag 742b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set contains an unspecified set of optimizations (e.g., the precompiled 743b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * preamble) geared toward improving the performance of these routines. The 744b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set of optimizations enabled may change from one version to the next. 745b1c031be513705d924038f497279b9b599868ba1Douglas Gregor */ 746e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void); 747b1c031be513705d924038f497279b9b599868ba1Douglas Gregor 748b1c031be513705d924038f497279b9b599868ba1Douglas Gregor/** 7495a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Parse the given source file and the translation unit corresponding 7505a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * to that file. 7515a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 7525a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * This routine is the main entry point for the Clang C API, providing the 7535a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * ability to parse a source file into a translation unit that can then be 7545a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * queried by other functions in the API. This routine accepts a set of 7555a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * command-line arguments so that the compilation can be configured in the same 7565a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * way that the compiler is configured on the command line. 7575a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 7585a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param CIdx The index object with which the translation unit will be 7595a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * associated. 7605a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 7615a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param source_filename The name of the source file to load, or NULL if the 7625a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * source file is included in \p clang_command_line_args. 7635a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 7645a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param command_line_args The command-line arguments that would be 7655a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * passed to the \c clang executable if it were being invoked out-of-process. 7665a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * These command-line options will be parsed and will affect how the translation 7675a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unit is parsed. Note that the following options are ignored: '-c', 7685a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'. 7695a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 7705a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_command_line_args The number of command-line arguments in 7715a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \p command_line_args. 7725a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 7735a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 7741abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing, including the contents of 7755a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * those files. The contents and name of these files (as specified by 7765a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 7775a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * guarantee their validity until the call to this function returns. 7785a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 7795a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 7805a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unsaved_files. 7815a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 7825a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param options A bitmask of options that affects how the translation unit 7835a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is managed but not its compilation. This should be a bitwise OR of the 7845a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXTranslationUnit_XXX flags. 7855a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 7865a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \returns A new translation unit describing the parsed code and containing 7875a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * any diagnostics produced by the compiler. If there is a failure from which 7885a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * the compiler cannot recover, returns NULL. 7895a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 7905a43021ac491bf091494167127772a20d9a9bb48Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx, 7915a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor const char *source_filename, 7922ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *command_line_args, 7935a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor int num_command_line_args, 7945a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor struct CXUnsavedFile *unsaved_files, 7955a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned num_unsaved_files, 7965a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned options); 7975a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 7985352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7991999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Flags that control how translation units are saved. 8001999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 8011999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 8021999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * ORed together to specify which options should be used when 8031999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * saving the translation unit. 8041999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 8051999844e7a18786e61e619e1dc6c789827541863Douglas Gregorenum CXSaveTranslationUnit_Flags { 8061999844e7a18786e61e619e1dc6c789827541863Douglas Gregor /** 8071999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Used to indicate that no special saving options are needed. 8081999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 8091999844e7a18786e61e619e1dc6c789827541863Douglas Gregor CXSaveTranslationUnit_None = 0x0 8101999844e7a18786e61e619e1dc6c789827541863Douglas Gregor}; 8111999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 8121999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 8131999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Returns the set of flags that is suitable for saving a translation 8141999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * unit. 8151999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 8161999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The set of flags returned provide options for 8171999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \c clang_saveTranslationUnit() by default. The returned flag 8181999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * set contains an unspecified set of options that save translation units with 8191999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * the most commonly-requested data. 8201999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 8211999844e7a18786e61e619e1dc6c789827541863Douglas GregorCINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU); 8221999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 8231999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 8247ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \brief Saves a translation unit into a serialized representation of 8257ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * that translation unit on disk. 8267ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 8277ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * Any translation unit that was parsed without error can be saved 8287ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * into a file. The translation unit can then be deserialized into a 8297ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * new \c CXTranslationUnit with \c clang_createTranslationUnit() or, 8307ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * if it is an incomplete translation unit that corresponds to a 8317ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * header, used as a precompiled header when parsing other translation 8327ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * units. 8337ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 8347ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param TU The translation unit to save. 8351999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 8367ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param FileName The file to which the translation unit will be saved. 8377ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 8381999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \param options A bitmask of options that affects how the translation unit 8391999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * is saved. This should be a bitwise OR of the 8401999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * CXSaveTranslationUnit_XXX flags. 8411999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 8427ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \returns Zero if the translation unit was saved successfully, a 8437ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * non-zero value otherwise. 8447ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor */ 8457ae2faafd30524ef5f863bb3b8701977888839bbDouglas GregorCINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU, 8461999844e7a18786e61e619e1dc6c789827541863Douglas Gregor const char *FileName, 8471999844e7a18786e61e619e1dc6c789827541863Douglas Gregor unsigned options); 8487ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 8497ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor/** 8505352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Destroy the specified CXTranslationUnit object. 8515352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 8525352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit); 853896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 8545352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 855e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Flags that control the reparsing of translation units. 856e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 857e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 858e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * ORed together to specify which options should be used when 859e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * reparsing the translation unit. 860e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 861e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregorenum CXReparse_Flags { 862e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 863e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that no special reparsing options are needed. 864e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 865e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXReparse_None = 0x0 866e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor}; 867e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 868e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 869e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Returns the set of flags that is suitable for reparsing a translation 870e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * unit. 871e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 872e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The set of flags returned provide options for 873e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \c clang_reparseTranslationUnit() by default. The returned flag 874e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * set contains an unspecified set of optimizations geared toward common uses 875e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * of reparsing. The set of optimizations enabled may change from one version 876e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * to the next. 877e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 878e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU); 879e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 880e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 881abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \brief Reparse the source files that produced this translation unit. 882abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 883abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * This routine can be used to re-parse the source files that originally 884abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * created the given translation unit, for example because those source files 885abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * have changed (either on disk or as passed via \p unsaved_files). The 886abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * source code will be reparsed with the same command-line options as it 887abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * was originally parsed. 888abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 889abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * Reparsing a translation unit invalidates all cursors and source locations 890abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * that refer into that translation unit. This makes reparsing a translation 891abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit semantically equivalent to destroying the translation unit and then 892abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * creating a new translation unit with the same command-line arguments. 893abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * However, it may be more efficient to reparse a translation 894abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit using this routine. 895abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 896abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param TU The translation unit whose contents will be re-parsed. The 897abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * translation unit must originally have been built with 898abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_createTranslationUnitFromSourceFile(). 899abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 900abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 901abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unsaved_files. 902abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 903abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param unsaved_files The files that have not yet been saved to disk 904abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * but may be required for parsing, including the contents of 905abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * those files. The contents and name of these files (as specified by 906abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 907abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * guarantee their validity until the call to this function returns. 908abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 909e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \param options A bitset of options composed of the flags in CXReparse_Flags. 910e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The function \c clang_defaultReparseOptions() produces a default set of 911e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * options recommended for most uses, based on the translation unit. 912e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 913abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \returns 0 if the sources could be reparsed. A non-zero value will be 914abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * returned if reparsing was impossible, such that the translation unit is 915abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * invalid. In such cases, the only valid call for \p TU is 916abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_disposeTranslationUnit(TU). 917abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor */ 918abc563f554951259bbe0315055cad92ee14d87e4Douglas GregorCINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU, 919abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned num_unsaved_files, 920e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor struct CXUnsavedFile *unsaved_files, 921e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor unsigned options); 922abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 923abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor/** 9245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 9255352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 926896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 9275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 928c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes the kind of entity that a cursor refers to. 929c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 930c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXCursorKind { 931c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Declarations */ 9321efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 933c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A declaration whose specific kind is not exposed via this 9341efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 935c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 936c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed declarations have the same operations as any other kind 937c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of declaration; one can extract their location information, 938c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, find their definitions, etc. However, the specific kind 939c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of the declaration is not reported. 940c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 941c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedDecl = 1, 942c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ struct. */ 9431efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_StructDecl = 2, 944c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ union. */ 945c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnionDecl = 3, 946c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C++ class. */ 947c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ClassDecl = 4, 948c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumeration. */ 949c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumDecl = 5, 9501efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 951c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A field (in C) or non-static data member (in C++) in a 952c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * struct, union, or C++ class. 953c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 954c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FieldDecl = 6, 955c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumerator constant. */ 956c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumConstantDecl = 7, 957c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function. */ 958c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FunctionDecl = 8, 959c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A variable. */ 960c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_VarDecl = 9, 961c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function or method parameter. */ 962c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ParmDecl = 10, 963c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @interface. */ 964c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInterfaceDecl = 11, 965c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @interface for a category. */ 966c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryDecl = 12, 967c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @protocol declaration. */ 968c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolDecl = 13, 969c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @property declaration. */ 970c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCPropertyDecl = 14, 971c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance variable. */ 972c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCIvarDecl = 15, 973c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance method. */ 974c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInstanceMethodDecl = 16, 975c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C class method. */ 976c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassMethodDecl = 17, 977c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @implementation. */ 978c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCImplementationDecl = 18, 979c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @implementation for a category. */ 980c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryImplDecl = 19, 981c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A typedef */ 982c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypedefDecl = 20, 9838bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek /** \brief A C++ class method. */ 9848bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek CXCursor_CXXMethod = 21, 9858f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek /** \brief A C++ namespace. */ 9868f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek CXCursor_Namespace = 22, 987a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek /** \brief A linkage specification, e.g. 'extern "C"'. */ 988a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek CXCursor_LinkageSpec = 23, 98901829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ constructor. */ 99001829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Constructor = 24, 99101829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ destructor. */ 99201829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Destructor = 25, 99301829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ conversion function. */ 99401829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_ConversionFunction = 26, 995fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template type parameter. */ 996fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTypeParameter = 27, 997fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ non-type template parameter. */ 998fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_NonTypeTemplateParameter = 28, 999fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template template parameter. */ 1000fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTemplateParameter = 29, 1001fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ function template. */ 1002fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_FunctionTemplate = 30, 100339d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor /** \brief A C++ class template. */ 100439d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor CXCursor_ClassTemplate = 31, 100574dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor /** \brief A C++ class template partial specialization. */ 100674dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor CXCursor_ClassTemplatePartialSpecialization = 32, 10076931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** \brief A C++ namespace alias declaration. */ 10086931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceAlias = 33, 10090a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor /** \brief A C++ using directive. */ 10100a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor CXCursor_UsingDirective = 34, 10117e24256c95afb64b4d5abf201a0f9f0527cb4cf3Douglas Gregor /** \brief A using declaration. */ 10127e24256c95afb64b4d5abf201a0f9f0527cb4cf3Douglas Gregor CXCursor_UsingDeclaration = 35, 101350aa6acd0b8d40c8956372a69e0a73f0802a5494Ted Kremenek CXCursor_FirstDecl = CXCursor_UnexposedDecl, 10147e24256c95afb64b4d5abf201a0f9f0527cb4cf3Douglas Gregor CXCursor_LastDecl = CXCursor_UsingDeclaration, 10151efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1016c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* References */ 1017c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstRef = 40, /* Decl references */ 10181efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_ObjCSuperClassRef = 40, 1019c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolRef = 41, 1020c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassRef = 42, 1021c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1022c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A reference to a type declaration. 1023c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1024c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A type reference occurs anywhere where a type is named but not 1025c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * declared. For example, given: 1026c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1027c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \code 1028c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * typedef unsigned size_type; 1029c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * size_type size; 1030c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \endcode 1031c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1032c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The typedef is a declaration of size_type (CXCursor_TypedefDecl), 1033c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * while the type of the variable "size" is referenced. The cursor 1034c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * referenced by the type of size is the typedef for size_type. 1035c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1036c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypeRef = 43, 10373064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CXCursor_CXXBaseSpecifier = 44, 10380b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor /** 1039a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * \brief A reference to a class template, function template, template 1040a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * template parameter, or class template partial specialization. 10410b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor */ 10420b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor CXCursor_TemplateRef = 45, 10436931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** 10446931900f43cea558c6974075256c07728dbfecc6Douglas Gregor * \brief A reference to a namespace or namespace alias. 10456931900f43cea558c6974075256c07728dbfecc6Douglas Gregor */ 10466931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceRef = 46, 1047a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor /** 104836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a member of a struct, union, or class that occurs in 104936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * some non-expression context, e.g., a designated initializer. 1050a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor */ 1051a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor CXCursor_MemberRef = 47, 105236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** 105336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a labeled statement. 105436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 105536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the jump to "start_over" in the 105636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto statement in the following example: 105736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 105836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 105936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 106036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 106136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 106236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto start_over; 106336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 106436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 106536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * A label reference cursor refers to a label statement. 106636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 106736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelRef = 48, 106836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 10691f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor /** 10701f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief A reference to a set of overloaded functions or function templates 10711f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * that has not yet been resolved to a specific function or function template. 10721f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 10731f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * An overloaded declaration reference cursor occurs in C++ templates where 10741f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * a dependent name refers to a function. For example: 10751f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 10761f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \code 10771f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> void swap(T&, T&); 10781f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 10791f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct X { ... }; 10801f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(X&, X&); 10811f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 10821f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> 10831f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void reverse(T* first, T* last) { 10841f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * while (first < last - 1) { 10851f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * swap(*first, *--last); 10861f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * ++first; 10871f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 10881f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 10891f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 10901f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct Y { }; 10911f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(Y&, Y&); 10921f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \endcode 10931f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 10941f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * Here, the identifier "swap" is associated with an overloaded declaration 10951f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * reference. In the template definition, "swap" refers to either of the two 10961f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * "swap" functions declared above, so both results will be available. At 10971f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * instantiation time, "swap" may also refer to other functions found via 10981f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * argument-dependent lookup (e.g., the "swap" function at the end of the 10991f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * example). 11001f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 11011f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * The functions \c clang_getNumOverloadedDecls() and 11021f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c clang_getOverloadedDecl() can be used to retrieve the definitions 11031f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * referenced by this cursor. 11041f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 11051f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor CXCursor_OverloadedDeclRef = 49, 11061f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 11071f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor CXCursor_LastRef = CXCursor_OverloadedDeclRef, 11081efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1109c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Error conditions */ 1110c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstInvalid = 70, 1111c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_InvalidFile = 70, 1112c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NoDeclFound = 71, 1113c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NotImplemented = 72, 1114ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_InvalidCode = 73, 1115ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_LastInvalid = CXCursor_InvalidCode, 11161efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1117c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Expressions */ 1118c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstExpr = 100, 11191efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1120c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1121c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression whose specific kind is not exposed via this 11221efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 1123c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1124c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed expressions have the same operations as any other kind 1125c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of expression; one can extract their location information, 1126c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, children, etc. However, the specific kind of the 1127c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * expression is not reported. 1128c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1129c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedExpr = 100, 11301efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1131c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1132c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to some value declaration, such 1133c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * as a function, varible, or enumerator. 1134c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1135c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_DeclRefExpr = 101, 11361efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1137c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1138c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to a member of a struct, union, 1139c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * class, Objective-C class, etc. 1140c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1141c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_MemberRefExpr = 102, 11421efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1143c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that calls a function. */ 1144c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_CallExpr = 103, 11451efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1146c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that sends a message to an Objective-C 1147c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor object or class. */ 1148c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCMessageExpr = 104, 11491ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 11501ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek /** \brief An expression that represents a block literal. */ 11511ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek CXCursor_BlockExpr = 105, 11521ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 11531ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek CXCursor_LastExpr = 105, 11541efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1155c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Statements */ 1156c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstStmt = 200, 1157c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1158c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A statement whose specific kind is not exposed via this 1159c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * interface. 1160c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1161c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed statements have the same operations as any other kind of 1162c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * statement; one can extract their location information, spelling, 1163c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * children, etc. However, the specific kind of the statement is not 1164c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reported. 1165c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1166c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedStmt = 200, 116736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 116836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** \brief A labelled statement in a function. 116936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 117036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the "start_over:" label statement in 117136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * the following example: 117236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 117336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 117436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 117536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 117636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 117736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 117836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 117936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelStmt = 201, 118036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 118136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LastStmt = CXCursor_LabelStmt, 11821efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1183c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1184c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Cursor that represents the translation unit itself. 1185c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1186c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor exists primarily to act as the root 1187c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor for traversing the contents of a translation unit. 1188c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1189e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_TranslationUnit = 300, 1190e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1191e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /* Attributes */ 1192e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_FirstAttr = 400, 1193e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /** 1194e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * \brief An attribute whose specific kind is not exposed via this 1195e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * interface. 1196e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek */ 1197e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_UnexposedAttr = 400, 1198e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1199e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBActionAttr = 401, 1200e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBOutletAttr = 402, 1201857e918a8a40deb128840308a318bf623d68295fTed Kremenek CXCursor_IBOutletCollectionAttr = 403, 1202857e918a8a40deb128840308a318bf623d68295fTed Kremenek CXCursor_LastAttr = CXCursor_IBOutletCollectionAttr, 12039f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 12049f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor /* Preprocessing */ 12059f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_PreprocessingDirective = 500, 1206572feb2a190b5e8b04fb06c4ac50ee0f61e93ff0Douglas Gregor CXCursor_MacroDefinition = 501, 1207572feb2a190b5e8b04fb06c4ac50ee0f61e93ff0Douglas Gregor CXCursor_MacroInstantiation = 502, 1208ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_InclusionDirective = 503, 12099f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective, 1210ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_LastPreprocessing = CXCursor_InclusionDirective 1211c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 1212c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1213c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1214c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A cursor representing some element in the abstract syntax tree for 1215c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a translation unit. 1216c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 12171efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor abstraction unifies the different kinds of entities in a 1218c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * program--declaration, statements, expressions, references to declarations, 1219c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * etc.--under a single "cursor" abstraction with a common set of operations. 1220c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Common operation for a cursor include: getting the physical location in 1221c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a source file where the cursor points, getting the name associated with a 1222c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor, and retrieving cursors for any child nodes of a particular cursor. 1223c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1224c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors can be produced in two specific ways. 1225c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_getTranslationUnitCursor() produces a cursor for a translation unit, 1226c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * from which one can use clang_visitChildren() to explore the rest of the 1227c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * translation unit. clang_getCursor() maps from a physical source location 1228c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to the entity that resides at that location, allowing one to map from the 1229c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * source code into the AST. 1230c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1231c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregortypedef struct { 1232c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor enum CXCursorKind kind; 1233c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor void *data[3]; 12341efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar} CXCursor; 1235c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1236c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1237c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations 1238c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1239c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 1240c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 12411efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1242c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1243c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the NULL cursor, which represents no entity. 1244c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1245c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getNullCursor(void); 12461efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1247c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1248c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the cursor that represents the given translation unit. 1249c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1250c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor can be used to start traversing the 1251c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * various declarations within the given translation unit. 1252c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1253c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit); 1254c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1255c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1256c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether two cursors are equivalent. 1257c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1258c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor); 12591efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1260c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1261c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the kind of the given cursor. 1262c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1263c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor); 1264c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1265c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1266c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a declaration. 1267c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1268c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind); 1269c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1270c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1271c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a simple 1272c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reference. 1273c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1274c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Note that other kinds of cursors (such as expressions) can also refer to 1275c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * other cursors. Use clang_getCursorReferenced() to determine whether a 1276c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * particular cursor refers to another entity. 1277c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1278c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind); 1279c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1280c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1281c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents an expression. 1282c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1283c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind); 1284c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1285c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1286c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a statement. 1287c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1288c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind); 1289c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1290c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 12911efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents an invalid 1292c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor. 12931efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar */ 1294c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind); 1295c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1296c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 12971efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents a translation 12981efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unit. 1299c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1300c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind); 13011efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1302ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek/*** 13039f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * \brief Determine whether the given cursor represents a preprocessing 13049f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * element, such as a preprocessor directive or macro instantiation. 13059f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor */ 13069f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas GregorCINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind); 13079f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 13089f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor/*** 1309ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * \brief Determine whether the given cursor represents a currently 1310ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt). 1311ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek */ 1312ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted KremenekCINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind); 1313ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek 1314c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 131516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief Describe the linkage of the entity referred to by a cursor. 131616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 131716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenekenum CXLinkageKind { 131816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This value indicates that no linkage information is available 131916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * for a provided CXCursor. */ 132016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Invalid, 132116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** 132216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief This is the linkage for variables, parameters, and so on that 132316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * have automatic storage. This covers normal (non-extern) local variables. 132416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 132516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_NoLinkage, 132616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for static variables and static functions. */ 132716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Internal, 132816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with external linkage that live 132916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * in C++ anonymous namespaces.*/ 133016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_UniqueExternal, 133116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with true, external linkage. */ 133216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_External 133316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek}; 133416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 133516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 133645e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the linkage of the entity referred to by a given cursor. 133716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 133816b4259aecaa22b642d35d36fd89965ed700c1e0Ted KremenekCINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor); 133916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 134016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 134158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \brief Determine the availability of the entity that this cursor refers to. 134258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 134358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param cursor The cursor to query. 134458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 134558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the cursor. 134658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 134758ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 134858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCursorAvailability(CXCursor cursor); 134958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 135058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 135145e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Describe the "language" of the entity referred to by a cursor. 135245e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 135345e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind { 13546cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_Invalid = 0, 135545e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_C, 135645e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_ObjC, 13576cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_CPlusPlus 135845e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek}; 135945e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 136045e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 136145e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the "language" of the entity referred to by a given cursor. 136245e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 136345e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor); 136445e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 13652be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor 13662be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 13672be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the semantic parent of the given cursor. 13682be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 13692be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The semantic parent of a cursor is the cursor that semantically contains 13702be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the given \p cursor. For many declarations, the lexical and semantic parents 13712be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the lexical parent is returned by 13722be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorLexicalParent()). They diverge when declarations or 13732be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 13742be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 13752be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 13762be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 13772be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 13782be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 13792be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 13802be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 13812be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 13822be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 13832be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 13842be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 13852be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 13862be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 13872be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 13882be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 13892be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 13902be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 13912be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 13922be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 13932be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 13942be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 13952be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 13962be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 13972be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor); 13982be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor 13992be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 14002be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the lexical parent of the given cursor. 14012be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 14022be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The lexical parent of a cursor is the cursor in which the given \p cursor 14032be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * was actually written. For many declarations, the lexical and semantic parents 14042be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the semantic parent is returned by 14052be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorSemanticParent()). They diverge when declarations or 14062be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 14072be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 14082be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 14092be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 14102be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 14112be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 14122be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 14132be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 14142be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 14152be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 14162be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 14172be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 14182be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 14192be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 14202be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 14212be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 14222be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 14232be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 14242be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 14252be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 14262be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 14272be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 14282be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 14292be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 14302be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor); 14319f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 14329f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 14339f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Determine the set of methods that are overridden by the given 14349f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. 14359f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 14369f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In both Objective-C and C++, a method (aka virtual member function, 14379f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * in C++) can override a virtual method in a base class. For 14389f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * Objective-C, a method is said to override any method in the class's 14399f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * interface (if we're coming from an implementation), its protocols, 14409f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * or its categories, that has the same selector and is of the same 14419f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * kind (class or instance). If no such method exists, the search 14429f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * continues to the class's superclass, its protocols, and its 14439f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * categories, and so on. 14449f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 14459f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * For C++, a virtual member function overrides any virtual member 14469f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * function with the same signature that occurs in its base 14479f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * classes. With multiple inheritance, a virtual member function can 14489f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * override several virtual member functions coming from different 14499f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * base classes. 14509f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 14519f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In all cases, this function determines the immediate overridden 14529f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method, rather than all of the overridden methods. For example, if 14539f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * a method is originally declared in a class A, then overridden in B 14549f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * (which in inherits from A) and also in C (which inherited from B), 14559f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * then the only overridden method returned from this function when 14569f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoked on C's method will be B's method. The client may then 14579f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoke this function again, given the previously-found overridden 14589f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods, to map out the complete method-override set. 14599f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 14609f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param cursor A cursor representing an Objective-C or C++ 14619f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. This routine will compute the set of methods that this 14629f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method overrides. 14639f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 14649f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param overridden A pointer whose pointee will be replaced with a 14659f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * pointer to an array of cursors, representing the set of overridden 14669f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods. If there are no overridden methods, the pointee will be 14679f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * set to NULL. The pointee must be freed via a call to 14689f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \c clang_disposeOverriddenCursors(). 14699f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 14709f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param num_overridden A pointer to the number of overridden 14719f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * functions, will be set to the number of overridden functions in the 14729f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * array pointed to by \p overridden. 14739f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 14749f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor, 14759f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor CXCursor **overridden, 14769f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor unsigned *num_overridden); 14779f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 14789f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 14799f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Free the set of overridden cursors returned by \c 14809f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * clang_getOverriddenCursors(). 14819f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 14829f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden); 14839f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 148445e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 1485ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * \brief Retrieve the file that is included by the given inclusion directive 1486ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * cursor. 1487ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor */ 1488ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas GregorCINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor); 1489ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor 1490ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor/** 1491c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 1492c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 14931efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1494c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1495c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code 1496c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1497c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors represent a location within the Abstract Syntax Tree (AST). These 1498c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines help map between cursors and the physical locations where the 1499c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * described entities occur in the source code. The mapping is provided in 1500c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * both directions, so one can map from source code to the AST and back. 1501c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1502c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 150350398199fb10e196a8d92fbf7a062dbe42ed88fdSteve Naroff */ 15041efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 15056a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff/** 1506b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Map a source location to the cursor that describes the entity at that 1507b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * location in the source code. 1508b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 1509b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() maps an arbitrary source location within a translation 1510b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * unit down to the most specific cursor that describes the entity at that 15111efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * location. For example, given an expression \c x + y, invoking 1512b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() with a source location pointing to "x" will return the 15131efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * cursor for "x"; similarly for "y". If the cursor points anywhere between 1514b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor() 1515b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * will return a cursor referring to the "+" expression. 1516b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 1517b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns a cursor representing the entity at the given source location, or 1518b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * a NULL cursor if no such entity can be found. 15196a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff */ 1520b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation); 15211efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 152298258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor/** 152398258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * \brief Retrieve the physical location of the source constructor referenced 152498258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * by the given cursor. 152598258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * 152698258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * The location of a declaration is typically the location of the name of that 15271efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * declaration, where the name of that declaration would occur if it is 15281efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unnamed, or some keyword that introduces that particular declaration. 15291efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The location of a reference is where that reference occurs within the 153098258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * source code. 153198258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor */ 153298258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor); 1533c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1534b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor/** 1535b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Retrieve the physical extent of the source construct referenced by 1536a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the given cursor. 1537a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * 1538a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * The extent of a cursor starts with the file/line/column pointing at the 1539a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * first character within the source construct that the cursor refers to and 15401efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * ends with the last character withinin that source construct. For a 1541a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * declaration, the extent covers the declaration itself. For a reference, 1542a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the extent covers the location of the reference (e.g., where the referenced 1543a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * entity was actually used). 1544a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor */ 1545a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas GregorCINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor); 1546c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor 1547c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1548c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 1549c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 155095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 1551c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 15528e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \defgroup CINDEX_TYPES Type information for CXCursors 15538e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 15548e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @{ 15558e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 15568e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 15578e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 15588e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Describes the kind of type 15598e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 15608e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenekenum CXTypeKind { 15618e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 15628e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Reprents an invalid type (e.g., where no type is available). 15638e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 15648e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Invalid = 0, 15658e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 15668e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 15678e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief A type whose specific kind is not exposed via this 15688e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * interface. 15698e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 15708e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Unexposed = 1, 15718e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 15728e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /* Builtin types */ 15738e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Void = 2, 15748e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Bool = 3, 15758e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_U = 4, 15768e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UChar = 5, 15778e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char16 = 6, 15788e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char32 = 7, 15798e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UShort = 8, 15808e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt = 9, 15818e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULong = 10, 15828e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULongLong = 11, 15838e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt128 = 12, 15848e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_S = 13, 15858e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_SChar = 14, 15868e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_WChar = 15, 15878e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Short = 16, 15888e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int = 17, 15898e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Long = 18, 15908e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongLong = 19, 15918e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int128 = 20, 15928e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Float = 21, 15938e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Double = 22, 15948e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongDouble = 23, 15958e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_NullPtr = 24, 15968e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Overload = 25, 15978e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Dependent = 26, 15988e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCId = 27, 15998e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCClass = 28, 16008e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCSel = 29, 16018e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_FirstBuiltin = CXType_Void, 16028e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LastBuiltin = CXType_ObjCSel, 16038e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 16048e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Complex = 100, 16058e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Pointer = 101, 16068e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_BlockPointer = 102, 16078e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LValueReference = 103, 16088e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_RValueReference = 104, 16098e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Record = 105, 16108e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Enum = 106, 16118e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Typedef = 107, 16128e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCInterface = 108, 161304c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_ObjCObjectPointer = 109, 161404c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_FunctionNoProto = 110, 161504c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_FunctionProto = 111 16168e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek}; 16178e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 16188e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 16198e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief The type of an element in the abstract syntax tree. 16208e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 16218e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 16228e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenektypedef struct { 16238e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek enum CXTypeKind kind; 16248e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek void *data[2]; 16258e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek} CXType; 16268e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 16278e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 16288e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the type of a CXCursor (if any). 16298e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 16308e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCursorType(CXCursor C); 16318e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 16328e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 16338e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \determine Determine whether two CXTypes represent the same type. 16348e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 16358e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \returns non-zero if the CXTypes represent the same type and 16368e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek zero otherwise. 16378e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 16388e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B); 16398e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 16408e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 16418e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the canonical type for a CXType. 16428e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 16438e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * Clang's type system explicitly models typedefs and all the ways 16448e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * a specific type can be represented. The canonical type is the underlying 16458e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * type with all the "sugar" removed. For example, if 'T' is a typedef 16468e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * for 'int', the canonical type for 'T' would be 'int'. 16478e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 16488e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCanonicalType(CXType T); 16498e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 16508e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 16518e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief For pointer types, returns the type of the pointee. 16528e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 16538e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 16548e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getPointeeType(CXType T); 16558e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 16568e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 16578e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the cursor for the declaration of the given type. 16588e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 16598e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T); 16608e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 16618e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 16628e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 16638e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the spelling of a given CXTypeKind. 16648e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 16658e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K); 16668e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 16678e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 16689a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * \brief Retrieve the result type associated with a function type. 166904c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek */ 167004c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted KremenekCINDEX_LINKAGE CXType clang_getResultType(CXType T); 167104c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek 167204c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek/** 16739a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * \brief Retrieve the result type associated with a given cursor. This only 16749a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * returns a valid type of the cursor refers to a function or method. 16759a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek */ 16769a140845438c2fc31e7d48a6dedbc695f4c83c68Ted KremenekCINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C); 16779a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek 16789a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek/** 16793ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * \brief Return 1 if the CXType is a POD (plain old data) type, and 0 16803ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * otherwise. 16813ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek */ 16823ce9e7d270e7df86c09c8126b4412d55be7c123bTed KremenekCINDEX_LINKAGE unsigned clang_isPODType(CXType T); 16833ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek 16843ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek/** 16853064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns 1 if the base class specified by the cursor with kind 16863064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * CX_CXXBaseSpecifier is virtual. 16873064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 16883064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor); 16893064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 16903064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 16913064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Represents the C++ access control level to a base class for a 16923064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * cursor with kind CX_CXXBaseSpecifier. 16933064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 16943064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenekenum CX_CXXAccessSpecifier { 16953064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXInvalidAccessSpecifier, 16963064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPublic, 16973064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXProtected, 16983064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPrivate 16993064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek}; 17003064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 17013064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 17023064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns the access control level for the C++ base specifier 17033064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * represented by a cursor with kind CX_CXXBaseSpecifier. 17043064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 17053064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor); 17063064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 17073064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 17081f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Determine the number of overloaded declarations referenced by a 17091f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c CXCursor_OverloadedDeclRef cursor. 17101f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 17111f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 17121f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 17131f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns The number of overloaded declarations referenced by \c cursor. If it 17141f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0. 17151f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 17161f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor); 17171f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 17181f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 17191f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Retrieve a cursor for one of the overloaded declarations referenced 17201f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * by a \c CXCursor_OverloadedDeclRef cursor. 17211f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 17221f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 17231f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 17241f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param index The zero-based index into the set of overloaded declarations in 17251f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * the cursor. 17261f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 17271f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns A cursor representing the declaration referenced by the given 17281f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c cursor at the specified \c index. If the cursor does not have an 17291f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * associated set of overloaded declarations, or if the index is out of bounds, 17301f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * returns \c clang_getNullCursor(); 17311f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 17321f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor, 17331f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor unsigned index); 17341f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 17351f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 17368e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @} 17378e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 173895f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 173995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 1740ad72f4dad4cf0fd2b71eb8f4704d2fe7ac58fb44Ted Kremenek * \defgroup CINDEX_ATTRIBUTES Information for attributes 174195f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 174295f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @{ 174395f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 174495f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 174595f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 174695f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 174795f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * \brief For cursors representing an iboutletcollection attribute, 174895f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * this function returns the collection element type. 174995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 175095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 175195f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted KremenekCINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor); 175295f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 175395f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 175495f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @} 175595f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 17568e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 17578e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 1758c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors 1759c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1760c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines provide the ability to traverse the abstract syntax tree 1761c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * using cursors. 1762c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1763c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 1764c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 17651efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1766c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1767c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes how the traversal of the children of a particular 1768c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor should proceed after visiting a particular child cursor. 1769c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1770c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A value of this enumeration type should be returned by each 1771c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXCursorVisitor to indicate how clang_visitChildren() proceed. 1772c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1773c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXChildVisitResult { 1774c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 17751efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Terminates the cursor traversal. 1776c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1777c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Break, 17781efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1779c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Continues the cursor traversal with the next sibling of 1780c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the cursor just visited, without visiting its children. 1781c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1782c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Continue, 1783c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1784c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Recursively traverse the children of this cursor, using 1785c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the same visitor and client data. 1786c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1787c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Recurse 1788c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 1789c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1790c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1791c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visitor invoked for each cursor found by a traversal. 1792c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1793c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This visitor function will be invoked for each cursor found by 1794c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). Its first argument is the cursor being 1795c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited, its second argument is the parent visitor for that cursor, 1796c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and its third argument is the client data provided to 1797c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). 1798c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1799c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The visitor should return one of the \c CXChildVisitResult values 1800c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to direct clang_visitCursorChildren(). 1801c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 18021efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbartypedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor, 18031efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor parent, 1804c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 1805c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1806c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1807c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visit the children of a particular cursor. 1808c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1809c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This function visits all the direct children of the given cursor, 1810c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * invoking the given \p visitor function with the cursors of each 1811c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited child. The traversal may be recursive, if the visitor returns 1812c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if 1813c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the visitor returns \c CXChildVisit_Break. 1814c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1815c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param parent the cursor whose child may be visited. All kinds of 1816a57259e9d7b30bcce93f0a62eee0488738026172Daniel Dunbar * cursors can be visited, including invalid cursors (which, by 1817c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * definition, have no children). 1818c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1819c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param visitor the visitor function that will be invoked for each 1820c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * child of \p parent. 1821c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1822c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param client_data pointer data supplied by the client, which will 1823c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be passed to the visitor each time it is invoked. 1824c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1825c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \returns a non-zero value if the traversal was terminated 1826c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * prematurely by the visitor returning \c CXChildVisit_Break. 1827c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 18281efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent, 1829c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursorVisitor visitor, 1830c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 18313387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#ifdef __has_feature 18323387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# if __has_feature(blocks) 18333387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 18343387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * \brief Visitor invoked for each cursor found by a traversal. 18353387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 18363387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * This visitor block will be invoked for each cursor found by 18373387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * clang_visitChildrenWithBlock(). Its first argument is the cursor being 18383387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * visited, its second argument is the parent visitor for that cursor. 18393387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 18403387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * The visitor should return one of the \c CXChildVisitResult values 18413387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * to direct clang_visitChildrenWithBlock(). 18423387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 18433387c65a094a02b2a94c05111d035a97d3d5c794David Chisnalltypedef enum CXChildVisitResult 18443387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent); 18453387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall 18463387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 18473387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * Visits the children of a cursor using the specified block. Behaves 18483387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * identically to clang_visitChildren() in all other respects. 18493387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 18503387c65a094a02b2a94c05111d035a97d3d5c794David Chisnallunsigned clang_visitChildrenWithBlock(CXCursor parent, 18513387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall CXCursorVisitorBlock block); 18523387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# endif 18533387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#endif 18541efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1855c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1856c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 1857c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 18581efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1859c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1860c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST 1861c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 18621efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * These routines provide the ability to determine references within and 1863c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * across translation units, by providing the names of the entities referenced 1864c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by cursors, follow reference cursors to the declarations they reference, 1865c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and associate declarations with their definitions. 1866c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1867c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 1868c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 18691efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1870c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1871c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced 1872c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by the given cursor. 1873c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1874c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A Unified Symbol Resolution (USR) is a string that identifies a particular 1875c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * entity (function, class, variable, etc.) within a program. USRs can be 1876c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * compared across translation units to determine, e.g., when references in 1877c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * one translation refer to an entity defined in another translation unit. 1878c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1879c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor); 1880c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1881c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1882896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C class. 1883896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 1884896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name); 1885896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1886896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 1887896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C category. 1888896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 1889896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 189066ccaec73706f3623d2e7d191fe2c944feedcc2bTed Kremenek clang_constructUSR_ObjCCategory(const char *class_name, 1891896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek const char *category_name); 1892896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1893896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 1894896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C protocol. 1895896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 1896896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 1897896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek clang_constructUSR_ObjCProtocol(const char *protocol_name); 1898896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1899896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1900896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 1901896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C instance variable and 1902896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 1903896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 1904896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name, 1905896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 1906896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1907896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 1908896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C method and 1909896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 1910896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 1911896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name, 1912896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek unsigned isInstanceMethod, 1913896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 1914896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1915896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 1916896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C property and the USR 1917896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * for its containing class. 1918896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 1919896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property, 1920896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 1921896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1922896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 1923c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a name for the entity referenced by this cursor. 1924c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1925c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor); 1926c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1927358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor/** 1928358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * \brief Retrieve the display name for the entity referenced by this cursor. 1929358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * 1930358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * The display name contains extra information that helps identify the cursor, 1931358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * such as the parameters of a function or template or the arguments of a 1932358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * class template specialization. 1933358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor */ 1934358559d8d7b458c5f64941842383a16e61f0828dDouglas GregorCINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor); 1935358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor 1936c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor/** \brief For a cursor that is a reference, retrieve a cursor representing the 1937c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * entity that it references. 1938c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * 1939c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Reference cursors refer to other entities in the AST. For example, an 1940c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Objective-C superclass reference cursor refers to an Objective-C class. 19411efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * This function produces the cursor for the Objective-C class from the 1942c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * cursor for the superclass reference. If the input cursor is a declaration or 1943c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * definition, it returns that declaration or definition unchanged. 19441efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Otherwise, returns the NULL cursor. 1945c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor */ 1946c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor); 1947b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 19481efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 1949b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief For a cursor that is either a reference to or a declaration 1950b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * of some entity, retrieve a cursor that describes the definition of 1951b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that entity. 1952b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 1953b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * Some entities can be declared multiple times within a translation 1954b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * unit, but only one of those declarations can also be a 1955b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * definition. For example, given: 1956b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 1957b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \code 1958b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 1959b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int g(int x, int y) { return f(x, y); } 1960b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int a, int b) { return a + b; } 1961b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 1962b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \endcode 1963b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 1964b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * there are three declarations of the function "f", but only the 1965b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * second one is a definition. The clang_getCursorDefinition() 1966b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * function will take any cursor pointing to a declaration of "f" 1967b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * (the first or fourth lines of the example) or a cursor referenced 1968b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that uses "f" (the call to "f' inside "g") and will return a 1969b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration cursor pointing to the definition (the second "f" 1970b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration). 1971b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 1972b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * If given a cursor for which there is no corresponding definition, 1973b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * e.g., because there is no definition of that entity within this 1974b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * translation unit, returns a NULL cursor. 1975b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 1976b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor); 1977b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 19781efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 1979b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Determine whether the declaration pointed to by this cursor 1980b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * is also a definition of that entity. 1981b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 1982b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor); 1983b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 1984c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1985c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 1986c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 19871efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1988c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 19899ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * \defgroup CINDEX_CPP C++ AST introspection 19909ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 19919ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * The routines in this group provide access information in the ASTs specific 19929ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * to C++ language features. 19939ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 19949ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @{ 19959ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 19969ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 19979ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 199849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Determine if a C++ member function or member function template is 199949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared 'static'. 20009ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 20019ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed KremenekCINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C); 20029ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 20039ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 200449f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Given a cursor that represents a template, determine 200549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the cursor kind of the specializations would be generated by instantiating 200649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the template. 200749f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 200849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * This routine can be used to determine what flavor of function template, 200949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * class template, or class template partial specialization is stored in the 201049f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * cursor. For example, it can describe whether a class template cursor is 201149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared with "struct", "class" or "union". 201249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 201349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \param C The cursor to query. This cursor should represent a template 201449f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declaration. 201549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 201649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \returns The cursor kind of the specializations that would be generated 201749f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * by instantiating the template \p C. If \p C is not a template, returns 201849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \c CXCursor_NoDeclFound. 201949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor */ 202049f6f5489483beaffc7ce48dfc000af4e65b9216Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C); 202149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor 202249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor/** 2023e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \brief Given a cursor that may represent a specialization or instantiation 2024e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template, retrieve the cursor that represents the template that it 2025e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializes or from which it was instantiated. 2026e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2027e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * This routine determines the template involved both for explicit 2028e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializations of templates and for implicit instantiations of the template, 2029e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * both of which are referred to as "specializations". For a class template 2030e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specialization (e.g., \c std::vector<bool>), this routine will return 2031e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * either the primary template (\c std::vector) or, if the specialization was 2032e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * instantiated from a class template partial specialization, the class template 2033e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * partial specialization. For a class template partial specialization and a 2034e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * function template specialization (including instantiations), this 2035e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * this routine will return the specialized template. 2036e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2037e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * For members of a class template (e.g., member functions, member classes, or 2038e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * static data members), returns the specialized or instantiated member. 2039e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * Although not strictly "templates" in the C++ language, members of class 2040e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates have the same notions of specializations and instantiations that 2041e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates do, so this routine treats them similarly. 2042e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2043e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \param C A cursor that may be a specialization of a template or a member 2044e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template. 2045e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2046e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \returns If the given cursor is a specialization or instantiation of a 2047e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * template or a member thereof, the template or member that it specializes or 2048e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * from which it was instantiated. Otherwise, returns a NULL cursor. 2049e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor */ 2050e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas GregorCINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C); 2051e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor 2052e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor/** 20539ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @} 20549ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 20559ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 20569ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 20570045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \defgroup CINDEX_LEX Token extraction and manipulation 20580045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 20590045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * The routines in this group provide access to the tokens within a 20600045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * translation unit, along with a semantic mapping of those tokens to 20610045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * their corresponding cursors. 2062fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2063fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @{ 2064fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2065fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2066fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2067fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a kind of token. 2068fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2069fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef enum CXTokenKind { 2070fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2071fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A token that contains some kind of punctuation. 2072fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2073fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Punctuation, 2074896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2075fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 20760045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \brief A language keyword. 2077fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2078fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Keyword, 2079896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2080fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2081fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief An identifier (that is not a keyword). 2082fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2083fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Identifier, 2084896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2085fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2086fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A numeric, string, or character literal. 2087fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2088fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Literal, 2089896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2090fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2091fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A comment. 2092fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2093fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Comment 2094fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXTokenKind; 2095fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2096fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2097fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a single preprocessing token. 2098fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2099fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef struct { 2100fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor unsigned int_data[4]; 2101fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor void *ptr_data; 2102fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXToken; 2103fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2104fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2105fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the kind of the given token. 2106fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2107fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken); 2108896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2109fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2110fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the spelling of the given token. 2111fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2112fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * The spelling of a token is the textual representation of that token, e.g., 2113fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * the text of an identifier or keyword. 2114fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2115fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken); 2116896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2117fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2118fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve the source location of the given token. 2119fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2120896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit, 2121fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken); 2122896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2123fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2124fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve a source range that covers the given token. 2125fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2126fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken); 2127fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2128fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2129fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Tokenize the source code described by the given range into raw 2130fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * lexical tokens. 2131fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2132fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit whose text is being tokenized. 2133fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2134fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Range the source range in which text should be tokenized. All of the 2135fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * tokens produced by tokenization will fall within this source range, 2136fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2137fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens this pointer will be set to point to the array of tokens 2138fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that occur within the given source range. The returned pointer must be 2139fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * freed with clang_disposeTokens() before the translation unit is destroyed. 2140fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2141fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens will be set to the number of tokens in the \c *Tokens 2142fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * array. 2143fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2144fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2145fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range, 2146fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken **Tokens, unsigned *NumTokens); 2147896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2148fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2149fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Annotate the given set of tokens by providing cursors for each token 2150fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that can be mapped to a specific entity within the abstract syntax tree. 2151fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 21520045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * This token-annotation routine is equivalent to invoking 21530045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() for the source locations of each of the 21540045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * tokens. The cursors provided are filtered, so that only those 21550045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * cursors that have a direct correspondence to the token are 21560045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * accepted. For example, given a function call \c f(x), 21570045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() would provide the following cursors: 21580045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 21590045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'. 21600045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'. 21610045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'. 21620045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 21630045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * Only the first and last of these cursors will occur within the 21640045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * annotate, since the tokens "f" and "x' directly refer to a function 21650045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * and a variable, respectively, but the parentheses are just a small 21660045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * part of the full syntax of the function call expression, which is 21670045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * not provided as an annotation. 2168fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2169fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit that owns the given tokens. 2170fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2171fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens the set of tokens to annotate. 2172fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2173fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens the number of tokens in \p Tokens. 2174fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2175fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Cursors an array of \p NumTokens cursors, whose contents will be 2176fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * replaced with the cursors corresponding to each token. 2177fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2178fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU, 2179fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens, 2180fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXCursor *Cursors); 2181896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2182fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2183fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Free the given set of tokens. 2184fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2185896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU, 2186fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens); 2187896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2188fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2189fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @} 2190fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2191896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2192fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2193c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_DEBUG Debugging facilities 2194c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2195c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines are used for testing and debugging, only, and should not 2196c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be relied upon. 2197c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2198c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2199c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 22001efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 22014ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff/* for debug/testing */ 2202e68fff6fc083c6270d835216a3de0b82c6ef0310Ted KremenekCINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind); 22031efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor, 22041efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar const char **startBuf, 22054ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff const char **endBuf, 22064ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startLine, 22074ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startColumn, 22084ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endLine, 22094ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endColumn); 22100a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE void clang_enableStackTraces(void); 2211995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel DunbarCINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data, 2212995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar unsigned stack_size); 2213995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar 22140c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 2215c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2216c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 22171efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2218c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2219c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CODE_COMPLET Code completion 2220c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2221c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Code completion involves taking an (incomplete) source file, along with 2222c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * knowledge of where the user is actively editing that file, and suggesting 2223c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * syntactically- and semantically-valid constructs that the user might want to 2224c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * use at that particular point in the source code. These data structures and 2225c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines provide support for code completion. 2226c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2227c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2228c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 22291efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2230c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 22310c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A semantic string that describes a code-completion result. 22320c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 22330c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A semantic string that describes the formatting of a code-completion 22340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * result as a single "template" of text that should be inserted into the 22350c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * source buffer when a particular code-completion result is selected. 22360c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * Each semantic string is made up of some number of "chunks", each of which 22370c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * contains some text along with a description of what that text means, e.g., 22380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the name of the entity being referenced, whether the text chunk is part of 22390c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the template, or whether it is a "placeholder" that the user should replace 22400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * with actual code,of a specific kind. See \c CXCompletionChunkKind for a 22411efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * description of the different kinds of chunks. 22420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 22430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef void *CXCompletionString; 22441efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 22450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 22460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A single result of code completion. 22470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 22480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef struct { 22490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 22501efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief The kind of entity that this completion refers to. 22510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 22521efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor kind will be a macro, keyword, or a declaration (one of the 22530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * *Decl cursor kinds), describing the entity that the completion is 22540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to. 22550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 22560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \todo In the future, we would like to provide a full cursor, to allow 22570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the client to extract additional information from declaration. 22580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 22590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor enum CXCursorKind CursorKind; 22601efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 22611efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 22620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief The code-completion string that describes how to insert this 22630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion result into the editing buffer. 22640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 22650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionString CompletionString; 22660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor} CXCompletionResult; 22670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 22680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 22690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Describes a single piece of text within a code-completion string. 22700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 22711efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Each "chunk" within a code-completion string (\c CXCompletionString) is 22721efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * either a piece of text with a specific "kind" that describes how that text 22730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * should be interpreted by the client or is another completion string. 22740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 22750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorenum CXCompletionChunkKind { 22760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 22770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A code-completion string that describes "optional" text that 22780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * could be a part of the template (but is not required). 22790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 22800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The Optional chunk is the only kind of chunk that has a code-completion 22811efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * string for its representation, which is accessible via 22820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \c clang_getCompletionChunkCompletionString(). The code-completion string 22830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * describes an additional part of the template that is completely optional. 22840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * For example, optional chunks can be used to describe the placeholders for 22850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * arguments that match up with defaulted function parameters, e.g. given: 22860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 22870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 22880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * void f(int x, float y = 3.14, double z = 2.71828); 22890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 22900c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 22910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The code-completion string for this function would contain: 22920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a TypedText chunk for "f". 22930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a LeftParen chunk for "(". 22940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "int x" 22950c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the remaining defaulted arguments, e.g., 22960c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 229771570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * - a Placeholder chunk for "float y" 22980c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the last defaulted argument: 22990c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 23000c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "double z" 23010c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a RightParen chunk for ")" 23020c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 230371570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * There are many ways to handle Optional chunks. Two simple approaches are: 23040c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Completely ignore optional chunks, in which case the template for the 23050c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would only include the first parameter ("int x"). 23060c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Fully expand all optional chunks, in which case the template for the 23070c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would have all of the parameters. 23080c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23090c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Optional, 23100c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 23110c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that a user would be expected to type to get this 23121efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * code-completion result. 23130c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 23141efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * There will be exactly one "typed text" chunk in a semantic string, which 23151efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * will typically provide the spelling of a keyword or the name of a 23160c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * declaration that could be used at the current code point. Clients are 23170c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * expected to filter the code-completion results based on the text in this 23180c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * chunk. 23190c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23200c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_TypedText, 23210c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 23220c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that should be inserted as part of a code-completion result. 23230c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 23240c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "text" chunk represents text that is part of the template to be 23250c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * inserted into user code should this particular code-completion result 23260c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * be selected. 23270c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23280c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Text, 23290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 23300c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Placeholder text that should be replaced by the user. 23310c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 23320c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "placeholder" chunk marks a place where the user should insert text 23330c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * into the code-completion template. For example, placeholders might mark 23340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the function parameters for a function declaration, to indicate that the 23350c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * user should provide arguments for each of those parameters. The actual 23360c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * text in a placeholder is a suggestion for the text to display before 23370c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the user replaces the placeholder with real code. 23380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23390c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Placeholder, 23400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 23410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Informative text that should be displayed but never inserted as 23420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * part of the template. 23431efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 23440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * An "informative" chunk contains annotations that can be displayed to 23450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * help the user decide whether a particular code-completion result is the 23460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * right option, but which is not part of the actual template to be inserted 23470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * by code completion. 23480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Informative, 23500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 23510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that describes the current parameter when code-completion is 23520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to function call, message send, or template specialization. 23530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 23540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "current parameter" chunk occurs when code-completion is providing 23550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * information about a parameter corresponding to the argument at the 23560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion point. For example, given a function 23570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 23580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 23590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * int add(int x, int y); 23600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 23610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 23620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * and the source code \c add(, where the code-completion point is after the 23630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "(", the code-completion string will contain a "current parameter" chunk 23640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * for "int x", indicating that the current argument will initialize that 23650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * parameter. After typing further, to \c add(17, (where the code-completion 23661efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * point is after the ","), the code-completion string will contain a 23670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "current paremeter" chunk to "int y". 23680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_CurrentParameter, 23700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 23710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left parenthesis ('('), used to initiate a function call or 23720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the beginning of a function parameter list. 23730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftParen, 23750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 23760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right parenthesis (')'), used to finish a function call or 23770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the end of a function parameter list. 23780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightParen, 23800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 23810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left bracket ('['). 23820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBracket, 23840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 23850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right bracket (']'). 23860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBracket, 23880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 23890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left brace ('{'). 23900c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBrace, 23920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 23930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right brace ('}'). 23940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23950c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBrace, 23960c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 23970c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left angle bracket ('<'). 23980c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 23990c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftAngle, 24000c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 24010c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right angle bracket ('>'). 24020c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 24030c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightAngle, 24040c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 24050c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A comma separator (','). 24060c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 2407ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor CXCompletionChunk_Comma, 2408ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor /** 24091efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Text that specifies the result type of a given result. 2410ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * 2411ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * This special kind of informative chunk is not meant to be inserted into 24121efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * the text buffer. Rather, it is meant to illustrate the type that an 2413ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * expression using the given completion string would have. 2414ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor */ 241501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_ResultType, 241601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 241701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A colon (':'). 241801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 241901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Colon, 242001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 242101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A semicolon (';'). 242201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 242301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_SemiColon, 242401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 242501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief An '=' sign. 242601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 242701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Equal, 242801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 242901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Horizontal space (' '). 243001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 243101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_HorizontalSpace, 243201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 243301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Vertical space ('\n'), after which it is generally a good idea to 243401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * perform indentation. 243501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 243601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_VerticalSpace 24370c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor}; 24381efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 24390c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 24400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Determine the kind of a particular chunk within a completion string. 24410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 24430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 24450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the kind of the chunk at the index \c chunk_number. 24470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 24481efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE enum CXCompletionChunkKind 24490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkKind(CXCompletionString completion_string, 24500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 24511efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 24520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 24531efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the text associated with a particular chunk within a 24540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * completion string. 24550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 24570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 24590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the text associated with the chunk at index \c chunk_number. 24610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 24622ef6f8f5a35a60870594c5b04e0aa2bf22c6886fTed KremenekCINDEX_LINKAGE CXString 24630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkText(CXCompletionString completion_string, 24640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 24650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 24660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 24671efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the completion string associated with a particular chunk 24680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * within a completion string. 24690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 24710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 24730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 24740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the completion string associated with the chunk at index 24750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \c chunk_number, or NULL if that chunk is not represented by a completion 24760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * string. 24770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 24780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE CXCompletionString 24790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkCompletionString(CXCompletionString completion_string, 24800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 24811efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 24820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 24830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Retrieve the number of chunks in the given code-completion string. 24840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 24850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE unsigned 24860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getNumCompletionChunks(CXCompletionString completion_string); 24870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 24880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 248912e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \brief Determine the priority of this code completion. 249012e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 249112e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * The priority of a code completion indicates how likely it is that this 249212e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * particular completion is the completion that the user will select. The 249312e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * priority is selected by various internal heuristics. 249412e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 249512e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \param completion_string The completion string to query. 249612e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 249712e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \returns The priority of this completion string. Smaller values indicate 249812e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * higher-priority (more likely) completions. 249912e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor */ 250012e131385e892e3723483a1081a89bcad29c8a84Douglas GregorCINDEX_LINKAGE unsigned 250112e131385e892e3723483a1081a89bcad29c8a84Douglas Gregorclang_getCompletionPriority(CXCompletionString completion_string); 250212e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor 250312e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor/** 250458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \brief Determine the availability of the entity that this code-completion 250558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * string refers to. 250658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 250758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param completion_string The completion string to query. 250858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 250958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the completion string. 251058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 251158ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 251258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCompletionAvailability(CXCompletionString completion_string); 251358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 251458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 2515ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Contains the results of code-completion. 2516ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * 2517ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * This data structure contains the results of code completion, as 2518e0cc52ef8afc8d1cba9c534191b5f0ddaff1d694Douglas Gregor * produced by \c clang_codeCompleteAt(). Its contents must be freed by 2519ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c clang_disposeCodeCompleteResults. 2520ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 2521ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregortypedef struct { 2522ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 2523ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The code-completion results. 2524ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 2525ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor CXCompletionResult *Results; 2526ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 2527ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 2528ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The number of code-completion results stored in the 2529ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c Results array. 2530ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 2531ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor unsigned NumResults; 2532ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor} CXCodeCompleteResults; 2533ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 2534ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor/** 2535cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Flags that can be passed to \c clang_codeCompleteAt() to 2536cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * modify its behavior. 2537cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 2538cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * The enumerators in this enumeration can be bitwise-OR'd together to 2539cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * provide multiple options to \c clang_codeCompleteAt(). 2540cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 2541cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregorenum CXCodeComplete_Flags { 2542cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 2543cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include macros within the set of code 2544cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completions returned. 2545cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 2546cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor CXCodeComplete_IncludeMacros = 0x01, 2547cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 2548cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 2549cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include code patterns for language constructs 2550cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * within the set of code completions, e.g., for loops. 2551cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 2552cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor CXCodeComplete_IncludeCodePatterns = 0x02 2553cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor}; 2554cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 2555cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 2556cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Returns a default set of code-completion options that can be 2557cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * passed to\c clang_codeCompleteAt(). 2558cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 2559cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas GregorCINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void); 2560cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 2561cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 25621abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \brief Perform code completion at a given location in a translation unit. 25631abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 25641abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * This function performs code completion at a particular file, line, and 25651abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * column within source code, providing results that suggest potential 25661abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code snippets based on the context of the completion. The basic model 25671abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * for code completion is that Clang will parse a complete source file, 25681abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * performing syntax checking up to the location where code-completion has 25691abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * been requested. At that point, a special code-completion token is passed 25701abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * to the parser, which recognizes this token and determines, based on the 25711abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * current location in the C/Objective-C/C++ grammar and the state of 25721abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * semantic analysis, what completions to provide. These completions are 25731abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * returned via a new \c CXCodeCompleteResults structure. 25741abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 25751abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Code completion itself is meant to be triggered by the client when the 25761abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * user types punctuation characters or whitespace, at which point the 25771abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code-completion location will coincide with the cursor. For example, if \c p 25781abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is a pointer, code-completion might be triggered after the "-" and then 25791abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * after the ">" in \c p->. When the code-completion location is afer the ">", 25801abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the completion results will provide, e.g., the members of the struct that 25811abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * "p" points to. The client is responsible for placing the cursor at the 25821abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * beginning of the token currently being typed, then filtering the results 25831abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * based on the contents of the token. For example, when code-completing for 25841abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the expression \c p->get, the client should provide the location just after 25851abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the 25861abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client can filter the results based on the current token text ("get"), only 25871abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * showing those results that start with "get". The intent of this interface 25881abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is to separate the relatively high-latency acquisition of code-completion 25891abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * results from the filtering of results on a per-character basis, which must 25901abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * have a lower latency. 25911abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 25921abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param TU The translation unit in which code-completion should 25931abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * occur. The source files for this translation unit need not be 25941abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completely up-to-date (and the contents of those source files may 25951abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * be overridden via \p unsaved_files). Cursors referring into the 25961abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * translation unit may be invalidated by this invocation. 25971abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 25981abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_filename The name of the source file where code 25991abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion should be performed. This filename may be any file 26001abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * included in the translation unit. 26011abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 26021abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_line The line at which code-completion should occur. 26031abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 26041abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_column The column at which code-completion should occur. 26051abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Note that the column should point just after the syntactic construct that 26061abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * initiated code completion, and not in the middle of a lexical token. 26071abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 26081abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param unsaved_files the Tiles that have not yet been saved to disk 26091abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing or code completion, including the 26101abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * contents of those files. The contents and name of these files (as 26111abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * specified by CXUnsavedFile) are copied when necessary, so the 26121abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client only needs to guarantee their validity until the call to 26131abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * this function returns. 26141abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 26151abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 26161abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * unsaved_files. 26171abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 2618cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \param options Extra options that control the behavior of code 2619cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completion, expressed as a bitwise OR of the enumerators of the 2620cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * CXCodeComplete_Flags enumeration. The 2621cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \c clang_defaultCodeCompleteOptions() function returns a default set 2622cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * of code-completion options. 2623cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 26241abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \returns If successful, a new \c CXCodeCompleteResults structure 26251abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * containing code-completion results, which should eventually be 26261abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * freed with \c clang_disposeCodeCompleteResults(). If code 26271abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion fails, returns NULL. 26281abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor */ 26291abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCINDEX_LINKAGE 26301abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU, 26311abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor const char *complete_filename, 26321abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_line, 26331abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_column, 26341abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor struct CXUnsavedFile *unsaved_files, 2635cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned num_unsaved_files, 2636cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned options); 26371abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 26381abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor/** 26391e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \brief Sort the code-completion results in case-insensitive alphabetical 26401e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * order. 26411e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * 26421e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param Results The set of results to sort. 26431e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param NumResults The number of results in \p Results. 26441e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor */ 26451e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas GregorCINDEX_LINKAGE 26461e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregorvoid clang_sortCodeCompletionResults(CXCompletionResult *Results, 26471e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor unsigned NumResults); 26481e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor 26491e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor/** 2650ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Free the given set of code-completion results. 26510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 26521efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE 2653ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregorvoid clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results); 265458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 265520d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor/** 2656a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced prior to the 2657a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * location where code completion was performed. 2658a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 2659896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 2660a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorunsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results); 2661a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 2662a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 2663a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given code completion. 2664a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 2665a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Result the code completion results to query. 2666a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 2667a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 2668a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 2669a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 2670a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 2671896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 2672a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results, 2673a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 2674a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 2675a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 267620d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * @} 267720d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor */ 26781efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 26791efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 268004bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek/** 268104bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * \defgroup CINDEX_MISC Miscellaneous utility functions 268204bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * 268304bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @{ 268404bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 268523e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek 268623e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek/** 268723e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * \brief Return a version string, suitable for showing to a user, but not 268823e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * intended to be parsed (the format is not guaranteed to be stable). 268923e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek */ 2690a2a9d6e4e5b6001b86b7dfc5db1ea296ce29a3d3Ted KremenekCINDEX_LINKAGE CXString clang_getClangVersion(); 269104bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek 269204bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek/** 269316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * \brief Return a version string, suitable for showing to a user, but not 269416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * intended to be parsed (the format is not guaranteed to be stable). 269516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 2696896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2697896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 269816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek /** 2699896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Visitor invoked for each file in a translation unit 270016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * (used with clang_getInclusions()). 270116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * 270216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * This visitor function will be invoked by clang_getInclusions() for each 270316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * file included (either at the top-level or by #include directives) within 270416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * a translation unit. The first argument is the file being included, and 270516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the second and third arguments provide the inclusion stack. The 270616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * array is sorted in order of immediate inclusion. For example, 270716b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the first element refers to the location that included 'included_file'. 270816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 270916b55a71695a33c094383295cc7b7a2080e098daTed Kremenektypedef void (*CXInclusionVisitor)(CXFile included_file, 271016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXSourceLocation* inclusion_stack, 271116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek unsigned include_len, 271216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 271316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 271416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 271516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * \brief Visit the set of preprocessor inclusions in a translation unit. 271616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * The visitor function is called with the provided data for every included 271716b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * file. This does not include headers included by the PCH file (unless one 271816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * is inspecting the inclusions in the PCH file itself). 271916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 272016b55a71695a33c094383295cc7b7a2080e098daTed KremenekCINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu, 272116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXInclusionVisitor visitor, 272216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 272316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 272416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 272504bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @} 272604bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 27271efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2728c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2729c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2730c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 27311efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2732d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifdef __cplusplus 2733d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek} 2734d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 2735d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 2736d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 2737