Index.h revision dd93c596cd95e1b96031ff47efe0a5095ff3d7f1
1d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek/*===-- clang-c/Index.h - Indexing Public C Interface -------------*- C -*-===*\ 2d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 3d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* The LLVM Compiler Infrastructure *| 4d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 5d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* This file is distributed under the University of Illinois Open Source *| 6d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* License. See LICENSE.TXT for details. *| 7d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 8d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|*===----------------------------------------------------------------------===*| 9d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 10d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* This header provides a public inferface to a Clang library for extracting *| 11d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* high-level symbol information from source files without exposing the full *| 12d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* Clang C++ API. *| 13d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek|* *| 14d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek\*===----------------------------------------------------------------------===*/ 15d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 16d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifndef CLANG_C_INDEX_H 17d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#define CLANG_C_INDEX_H 18d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 1988145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff#include <sys/stat.h> 203d31560343856c573376a04558a7111e7afad4f7Chandler Carruth#include <time.h> 210a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor#include <stdio.h> 2288145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff 23d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifdef __cplusplus 24d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenekextern "C" { 25d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 26d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 2788145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff/* MSVC DLL import/export. */ 282e06fc877a633abea3b40a64950c7316dac29ca8John Thompson#ifdef _MSC_VER 292e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #ifdef _CINDEX_LIB_ 302e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #define CINDEX_LINKAGE __declspec(dllexport) 312e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #else 322e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #define CINDEX_LINKAGE __declspec(dllimport) 332e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #endif 342e06fc877a633abea3b40a64950c7316dac29ca8John Thompson#else 352e06fc877a633abea3b40a64950c7316dac29ca8John Thompson #define CINDEX_LINKAGE 362e06fc877a633abea3b40a64950c7316dac29ca8John Thompson#endif 372e06fc877a633abea3b40a64950c7316dac29ca8John Thompson 3887fb9404cd962b78c98947d75d68be1691c4e737Douglas Gregor/** \defgroup CINDEX libclang: C Interface to Clang 3920d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * 401efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The C Interface to Clang provides a relatively small API that exposes 41f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * facilities for parsing source code into an abstract syntax tree (AST), 42f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * loading already-parsed ASTs, traversing the AST, associating 43f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * physical source locations with elements within the AST, and other 44f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * facilities that support Clang-based development tools. 45f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 461efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * This C interface to Clang will never provide all of the information 47f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * representation stored in Clang's C++ AST, nor should it: the intent is to 48f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * maintain an API that is relatively stable from one release to the next, 49f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * providing only the basic functionality needed to support development tools. 501efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 511efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * To avoid namespace pollution, data types are prefixed with "CX" and 52f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * functions are prefixed with "clang_". 5320d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * 5420d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * @{ 5520d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor */ 561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 577f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 587f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief An "index" that consists of a set of translation units that would 597f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * typically be linked together into an executable or library. 607f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 617f17376e0931a337d544b75d9030bc92763be287Douglas Gregortypedef void *CXIndex; 62600866cc7d6d9ec2e27d4b6d6ec461f6463b5ab6Steve Naroff 637f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 647f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief A single translation unit, which resides in an index. 657f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 660a90d32523bfe5fa63e11b648686c9699f786d15Ted Kremenektypedef struct CXTranslationUnitImpl *CXTranslationUnit; 67600866cc7d6d9ec2e27d4b6d6ec461f6463b5ab6Steve Naroff 687f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 69c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Opaque pointer representing client data that will be passed through 70c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to various callbacks and visitors. 717f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 72c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregortypedef void *CXClientData; 731efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 74735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor/** 75735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * \brief Provides the contents of a file that has not yet been saved to disk. 76735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * 77735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * Each CXUnsavedFile instance provides the name of a file on the 78735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * system along with the current contents of that file that have not 79735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * yet been saved to disk. 80735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 81735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregorstruct CXUnsavedFile { 821efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 831efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief The file whose contents have not yet been saved. 84735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * 85735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * This file must already exist in the file system. 86735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 87735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor const char *Filename; 88735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor 891efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 90c8dfe5ece04e683106eb96c58a2999f70b53ac21Douglas Gregor * \brief A buffer containing the unsaved contents of this file. 91735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 92735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor const char *Contents; 93735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor 94735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor /** 95c8dfe5ece04e683106eb96c58a2999f70b53ac21Douglas Gregor * \brief The length of the unsaved contents of this buffer. 96735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 97735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor unsigned long Length; 98735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor}; 99735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor 100076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne/** 101076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief Describes the availability of a particular entity, which indicates 102076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * whether the use of this entity will result in a warning or error due to 103076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * it being deprecated or unavailable. 104076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 10558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorenum CXAvailabilityKind { 106076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne /** 107076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief The entity is available. 108076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 10958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailability_Available, 110076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne /** 111076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief The entity is available, but has been deprecated (and its use is 112076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * not recommended). 113076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 11458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailability_Deprecated, 115076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne /** 116076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief The entity is not available; any use of it will be an error. 117076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 118d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen CXAvailability_NotAvailable, 119d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen /** 120d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen * \brief The entity is available, but not accessible; any use of it will be 121d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen * an error. 122d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen */ 123d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen CXAvailability_NotAccessible 12458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor}; 12558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 1267f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1277f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \defgroup CINDEX_STRING String manipulation routines 1287f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * 1297f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * @{ 1307f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 1311efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1327f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1337f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief A character string. 1347f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * 1357f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * The \c CXString type is used to return strings from the interface when 1367f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * the ownership of that string might different from one call to the next. 1377f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * Use \c clang_getCString() to retrieve the string data and, once finished 1387f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * with the string data, call \c clang_disposeString() to free the string. 139ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff */ 140ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Narofftypedef struct { 141a60ed47da13393796d8552b9fdca12abbb3eea42Ted Kremenek void *data; 142ed122735639d83c10f18c28c7fd117bfcd0f62cbTed Kremenek unsigned private_flags; 143ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff} CXString; 144ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff 1457f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1467f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief Retrieve the character data associated with the given string. 1477f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 148ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve NaroffCINDEX_LINKAGE const char *clang_getCString(CXString string); 149ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff 1507f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1517f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief Free the given string, 1527f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 153ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve NaroffCINDEX_LINKAGE void clang_disposeString(CXString string); 154ef0cef6cec8de5fc60e469a93436eed7212e0dc2Steve Naroff 1557f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1567f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * @} 1577f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 1581efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1591efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 160e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * \brief clang_createIndex() provides a shared context for creating 161e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * translation units. It provides two options: 162e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * 163e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local" 164e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * declarations (when loading any new translation units). A "local" declaration 1651efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * is one that belongs in the translation unit itself and not in a precompiled 166e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * header that was used by the translation unit. If zero, all declarations 167e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * will be enumerated. 168e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * 169b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * Here is an example: 170b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 1710a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * // excludeDeclsFromPCH = 1, displayDiagnostics=1 1720a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * Idx = clang_createIndex(1, 1); 173b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 174b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // IndexTest.pch was produced with the following command: 175b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch" 176b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * TU = clang_createTranslationUnit(Idx, "IndexTest.pch"); 177b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 178b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // This will load all the symbols from 'IndexTest.pch' 1791efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * clang_visitChildren(clang_getTranslationUnitCursor(TU), 180002a528ab0189fc60cfbf9328962c96ccbe567eeDouglas Gregor * TranslationUnitVisitor, 0); 181b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * clang_disposeTranslationUnit(TU); 182b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 183b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // This will load all the symbols from 'IndexTest.c', excluding symbols 184b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // from 'IndexTest.pch'. 185fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" }; 186fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args, 187fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * 0, 0); 188b2cd48756119f4d8d2a865b4b3e0e8efd02e26a0Douglas Gregor * clang_visitChildren(clang_getTranslationUnitCursor(TU), 189b2cd48756119f4d8d2a865b4b3e0e8efd02e26a0Douglas Gregor * TranslationUnitVisitor, 0); 190b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * clang_disposeTranslationUnit(TU); 191b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 192b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * This process of creating the 'pch', loading it separately, and using it (via 193b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks 194b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * (which gives the indexer the same performance benefit as the compiler). 195e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff */ 1960a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH, 1970a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor int displayDiagnostics); 198896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1990087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor/** 2000087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * \brief Destroy the given index. 2010087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * 2020087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * The index must not be destroyed until all of the translation units created 2030087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * within that index have been destroyed. 2040087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor */ 2058506dde586459887b7e14e23a30af8ac5be5adb6Daniel DunbarCINDEX_LINKAGE void clang_disposeIndex(CXIndex index); 2061efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2071efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 208c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_FILES File manipulation routines 209f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 210f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @{ 211f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 2121efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 213f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 214f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief A particular source file that is part of a translation unit. 215f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 216f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregortypedef void *CXFile; 2171efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 218f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor 219f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 220f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief Retrieve the complete file and path name of the given file. 22188145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff */ 22274844072411bae91d5dbb89955d200cbe1e0a1c8Ted KremenekCINDEX_LINKAGE CXString clang_getFileName(CXFile SFile); 2231efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 224f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 225f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief Retrieve the last modification time of the given file. 226f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 22708b0e8daeb683686b876d72674962ad96df21d45Douglas GregorCINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile); 22888145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff 2293c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor/** 230dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor * \brief Determine whether the given header is guarded against 231dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor * multiple inclusions, either with the conventional 232dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor * #ifndef/#define/#endif macro guards or with #pragma once. 233dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor */ 234dd3e5549e3c11e217078938aacf72f042eea5343Douglas GregorCINDEX_LINKAGE unsigned 235dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregorclang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file); 236dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor 237dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor/** 238b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a file handle within the given translation unit. 239b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 240b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \param tu the translation unit 2411efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 242b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \param file_name the name of the file. 243b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 244b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns the file handle for the named file in the translation unit \p tu, 245b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * or a NULL file handle if the file was not a part of this translation unit. 246b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 2471efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu, 248b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor const char *file_name); 2491efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 250b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 251f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @} 252f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 253f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor 254f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 255f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \defgroup CINDEX_LOCATIONS Physical source locations 256f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 257f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * Clang represents physical source locations in its abstract syntax tree in 258f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * great detail, with file, line, and column information for the majority of 259f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * the tokens parsed in the source code. These data types and functions are 260f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * used to represent source location information, either for a particular 261f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * point in the program or for a range of points in the program, and extract 262f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * specific location information from those data types. 263f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 264f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @{ 265f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 2661efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 267f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 2681db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * \brief Identifies a specific source location within a translation 2691db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * unit. 2701db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 27120174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * Use clang_getExpansionLocation() or clang_getSpellingLocation() 272a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * to map a source location to a particular file, line, and column. 2733c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor */ 2743c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregortypedef struct { 2755352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor void *ptr_data[2]; 2761db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned int_data; 2773c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor} CXSourceLocation; 278fe6fd3d41a7f48317d6856c9327b6cead32c3498Ted Kremenek 2793c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor/** 280d52864bd33c66aacc84133460d8c9c0dfcdd5c18Daniel Dunbar * \brief Identifies a half-open character range in the source code. 2813c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor * 2821db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the 2831db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * starting and end locations from a source range, respectively. 2843c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor */ 2853c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregortypedef struct { 2865352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor void *ptr_data[2]; 2871db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned begin_int_data; 2881db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned end_int_data; 2893c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor} CXSourceRange; 290fe6fd3d41a7f48317d6856c9327b6cead32c3498Ted Kremenek 2911db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor/** 292b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a NULL (invalid) source location. 293b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 294b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getNullLocation(); 2951efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 296b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 297b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \determine Determine whether two source locations, which must refer into 2981efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * the same translation unit, refer to exactly the same point in the source 299b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * code. 300b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 301b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns non-zero if the source locations refer to the same location, zero 302b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * if they refer to different locations. 303b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 304b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1, 305b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXSourceLocation loc2); 3061efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 307b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 3081efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieves the source location associated with a given file/line/column 3091efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * in a particular translation unit. 310b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 311b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu, 312b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXFile file, 313b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor unsigned line, 314b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor unsigned column); 31583889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall/** 31683889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall * \brief Retrieves the source location associated with a given character offset 31783889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall * in a particular translation unit. 31883889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall */ 31983889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid ChisnallCINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu, 32083889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall CXFile file, 32183889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall unsigned offset); 3221efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 323b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 3245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve a NULL (invalid) source range. 3255352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 3265352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXSourceRange clang_getNullRange(); 327896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3285352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 329b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a source range given the beginning and ending source 330b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * locations. 331b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 332b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin, 333b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXSourceLocation end); 3341efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 335b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 336ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor * \brief Determine whether two ranges are equivalent. 337ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor * 338ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor * \returns non-zero if the ranges are the same, zero if they differ. 339ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor */ 340ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas GregorCINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1, 341ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor CXSourceRange range2); 342ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor 343ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor/** 344de5db649fd5f9aedde200f443ad73d62517b1c88Argyrios Kyrtzidis * \brief Returns non-zero if \arg range is null. 345de5db649fd5f9aedde200f443ad73d62517b1c88Argyrios Kyrtzidis */ 346733dbc805facad7cebec5420f6c47c83848cee5fErik VerbruggenCINDEX_LINKAGE int clang_Range_isNull(CXSourceRange range); 347de5db649fd5f9aedde200f443ad73d62517b1c88Argyrios Kyrtzidis 348de5db649fd5f9aedde200f443ad73d62517b1c88Argyrios Kyrtzidis/** 34946766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * \brief Retrieve the file, line, column, and offset represented by 35046766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * the given source location. 3511db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 35220174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * If the location refers into a macro expansion, retrieves the 35320174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * location of the macro expansion. 354a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 3551efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param location the location within a source file that will be decomposed 3561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * into its parts. 3571db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3581efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param file [out] if non-NULL, will be set to the file to which the given 3591db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * source location points. 3601db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3611efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param line [out] if non-NULL, will be set to the line to which the given 3621db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * source location points. 3631db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 3641efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param column [out] if non-NULL, will be set to the column to which the given 3651efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source location points. 36646766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * 36746766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * \param offset [out] if non-NULL, will be set to the offset into the 36846766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * buffer to which the given source location points. 3691db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 37020174221af145554b76a0b0f5e4eb3ac70d05945Chandler CarruthCINDEX_LINKAGE void clang_getExpansionLocation(CXSourceLocation location, 37120174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth CXFile *file, 37220174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth unsigned *line, 37320174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth unsigned *column, 37420174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth unsigned *offset); 37520174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth 37620174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth/** 377e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \brief Retrieve the file, line, column, and offset represented by 378e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * the given source location, as specified in a # line directive. 379e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 380e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * Example: given the following source code in a file somefile.c 381e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 382e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * #123 "dummy.c" 1 383e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 384e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * static int func(void) 385e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * { 386e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * return 0; 387e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * } 388e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 389e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * the location information returned by this function would be 390e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 391e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * File: dummy.c Line: 124 Column: 12 392e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 393e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * whereas clang_getExpansionLocation would have returned 394e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 395e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * File: somefile.c Line: 3 Column: 12 396e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 397e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \param location the location within a source file that will be decomposed 398e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * into its parts. 399e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 400e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \param filename [out] if non-NULL, will be set to the filename of the 401e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * source location. Note that filenames returned will be for "virtual" files, 402e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * which don't necessarily exist on the machine running clang - e.g. when 403e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * parsing preprocessed output obtained from a different environment. If 404e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * a non-NULL value is passed in, remember to dispose of the returned value 405e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * using \c clang_disposeString() once you've finished with it. For an invalid 406e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * source location, an empty string is returned. 407e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 408e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \param line [out] if non-NULL, will be set to the line number of the 409e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * source location. For an invalid source location, zero is returned. 410e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 411e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \param column [out] if non-NULL, will be set to the column number of the 412e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * source location. For an invalid source location, zero is returned. 413e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis */ 414e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios KyrtzidisCINDEX_LINKAGE void clang_getPresumedLocation(CXSourceLocation location, 415e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis CXString *filename, 416e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis unsigned *line, 417e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis unsigned *column); 418e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis 419e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis/** 42020174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * \brief Legacy API to retrieve the file, line, column, and offset represented 42120174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * by the given source location. 42220174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * 42320174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * This interface has been replaced by the newer interface 42420174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * \see clang_getExpansionLocation(). See that interface's documentation for 42520174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * details. 42620174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth */ 4271db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location, 4281db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor CXFile *file, 4291db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned *line, 43046766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor unsigned *column, 43146766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor unsigned *offset); 432e69517ce61638f12c9abe4605753a45275ac4e37Douglas Gregor 433e69517ce61638f12c9abe4605753a45275ac4e37Douglas Gregor/** 434a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \brief Retrieve the file, line, column, and offset represented by 435a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * the given source location. 436a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 437a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * If the location refers into a macro instantiation, return where the 438a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * location was originally spelled in the source file. 439a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 440a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param location the location within a source file that will be decomposed 441a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * into its parts. 442a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 443a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param file [out] if non-NULL, will be set to the file to which the given 444a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 445a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 446a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param line [out] if non-NULL, will be set to the line to which the given 447a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 448a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 449a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param column [out] if non-NULL, will be set to the column to which the given 450a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 451a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 452a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param offset [out] if non-NULL, will be set to the offset into the 453a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * buffer to which the given source location points. 454a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor */ 455a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas GregorCINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location, 456a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor CXFile *file, 457a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *line, 458a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *column, 459a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *offset); 460a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor 461a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor/** 4621efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve a source location representing the first character within a 4631efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source range. 4641db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 4651db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range); 4661db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor 4671db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor/** 4681efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve a source location representing the last character within a 4691efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source range. 4701db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 4711db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range); 4721db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor 473f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 474f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @} 475f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 476c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 477c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 4785352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \defgroup CINDEX_DIAG Diagnostic reporting 4795352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 4805352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @{ 4815352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4825352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4835352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 4845352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Describes the severity of a particular diagnostic. 4855352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4865352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorenum CXDiagnosticSeverity { 4875352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 488896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief A diagnostic that has been suppressed, e.g., by a command-line 4895352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * option. 4905352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4915352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Ignored = 0, 492896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 4935352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 4945352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic is a note that should be attached to the 4955352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * previous (non-note) diagnostic. 4965352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 4975352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Note = 1, 4985352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 4995352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 5005352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates suspicious code that may not be 5015352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * wrong. 5025352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5035352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Warning = 2, 5045352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5055352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 5065352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates that the code is ill-formed. 5075352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5085352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Error = 3, 5095352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5105352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 5115352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates that the code is ill-formed such 5125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * that future parser recovery is unlikely to produce useful 5135352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * results. 5145352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Fatal = 4 5165352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor}; 5175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5195352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief A single diagnostic, containing the diagnostic's severity, 5205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * location, text, source ranges, and fix-it hints. 5215352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5225352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregortypedef void *CXDiagnostic; 5235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 525153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief A group of CXDiagnostics. 526153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 527153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenektypedef void *CXDiagnosticSet; 528153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 529153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 530153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Determine the number of diagnostics in a CXDiagnosticSet. 531153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 532153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags); 533153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 534153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 535153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet. 536153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * 537153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \param Unit the CXDiagnosticSet to query. 538153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \param Index the zero-based diagnostic number to retrieve. 539153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * 540153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \returns the requested diagnostic. This diagnostic must be freed 541153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * via a call to \c clang_disposeDiagnostic(). 542153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 543153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags, 544153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek unsigned Index); 545153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 546153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 547153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 548153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Describes the kind of error that occurred (if any) in a call to 549153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \c clang_loadDiagnostics. 550153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 551153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenekenum CXLoadDiag_Error { 552153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek /** 553153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Indicates that no error occurred. 554153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 555153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXLoadDiag_None = 0, 556153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 557153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek /** 558153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Indicates that an unknown error occurred while attempting to 559153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * deserialize diagnostics. 560153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 561153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXLoadDiag_Unknown = 1, 562153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 563153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek /** 564153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Indicates that the file containing the serialized diagnostics 565153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * could not be opened. 566153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 567153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXLoadDiag_CannotLoad = 2, 568153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 569153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek /** 570153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Indicates that the serialized diagnostics file is invalid or 571153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * corrupt. 572153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 573153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXLoadDiag_InvalidFile = 3 574153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek}; 575153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 576153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 577153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode 578153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * file. 579153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * 580153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \param The name of the file to deserialize. 581153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \param A pointer to a enum value recording if there was a problem 582153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * deserializing the diagnostics. 583153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \param A pointer to a CXString for recording the error string 584153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * if the file was not successfully loaded. 585153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * 586153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise. These 587153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * diagnostics should be released using clang_disposeDiagnosticSet(). 588153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 589153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file, 590153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek enum CXLoadDiag_Error *error, 591153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXString *errorString); 592153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 593153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 594153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Release a CXDiagnosticSet and all of its contained diagnostics. 595153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 596153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags); 597153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 598153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 599153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Retrieve the child diagnostics of a CXDiagnostic. This 600153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * CXDiagnosticSet does not need to be released by clang_diposeDiagnosticSet. 601153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 602153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D); 603153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 604153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 605a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced for the given 606a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * translation unit. 607a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 608a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit); 609a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 610a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 611a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given translation unit. 6125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 613a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Unit the translation unit to query. 614a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 6155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 616a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 617a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 6185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 619a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit, 620a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 621a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 622a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 623a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Destroy a diagnostic. 624a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 625a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic); 6265352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6280a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Options to control the display of diagnostics. 6290a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6300a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * The values in this enum are meant to be combined to customize the 6310a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * behavior of \c clang_displayDiagnostic(). 6320a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 6330a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregorenum CXDiagnosticDisplayOptions { 6340a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 6350a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Display the source-location information where the 6360a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic was located. 6370a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6380a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * When set, diagnostics will be prefixed by the file, line, and 6390a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * (optionally) column to which the diagnostic refers. For example, 6400a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6410a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \code 6420a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * test.c:28: warning: extra tokens at end of #endif directive 6430a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \endcode 6440a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6450a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-source-location. 6460a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 6470a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplaySourceLocation = 0x01, 6480a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 6490a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 6500a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 6510a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include the column number. 6520a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6530a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-column. 6540a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 6550a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplayColumn = 0x02, 6560a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 6570a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 6580a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 6590a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include information about source ranges in a 6600a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * machine-parsable format. 6610a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 662896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * This option corresponds to the clang flag 6630a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \c -fdiagnostics-print-source-range-info. 6640a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 665aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplaySourceRanges = 0x04, 666aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 667aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 668aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the option name associated with this diagnostic, if any. 669aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 670aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The option name displayed (e.g., -Wconversion) will be placed in brackets 671aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * after the diagnostic text. This option corresponds to the clang flag 672aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-option. 673aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 674aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayOption = 0x08, 675aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 676aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 677aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the category number associated with this diagnostic, if any. 678aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 679aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The category number is displayed within brackets after the diagnostic text. 680aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * This option corresponds to the clang flag 681aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-category=id. 682aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 683aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayCategoryId = 0x10, 684aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 685aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 686aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the category name associated with this diagnostic, if any. 687aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 688aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The category name is displayed within brackets after the diagnostic text. 689aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * This option corresponds to the clang flag 690aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-category=name. 691aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 692aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayCategoryName = 0x20 6930a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor}; 6940a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 6950a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 696274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \brief Format the given diagnostic in a manner that is suitable for display. 6970a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 698274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * This routine will format the given diagnostic to a string, rendering 699896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the diagnostic according to the various options given. The 700896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \c clang_defaultDiagnosticDisplayOptions() function returns the set of 7010a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * options that most closely mimics the behavior of the clang compiler. 7020a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 7030a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \param Diagnostic The diagnostic to print. 7040a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 705896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Options A set of options that control the diagnostic display, 7060a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * created by combining \c CXDiagnosticDisplayOptions values. 707274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * 708274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \returns A new string containing for formatted diagnostic. 7090a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 710274f1906f12ebf8fcc179701deeda6d3271120c1Douglas GregorCINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic, 711274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor unsigned Options); 7120a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 7130a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 7140a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Retrieve the set of display options most similar to the 7150a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * default behavior of the clang compiler. 7160a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 7170a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \returns A set of display options suitable for use with \c 7180a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * clang_displayDiagnostic(). 7190a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 7200a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void); 7210a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 7220a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 7235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the severity of the given diagnostic. 7245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 725896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE enum CXDiagnosticSeverity 7265352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getDiagnosticSeverity(CXDiagnostic); 7275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 7285352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7295352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the source location of the given diagnostic. 7305352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7315352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * This location is where Clang would print the caret ('^') when 7325352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * displaying the diagnostic on the command line. 7335352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 7345352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic); 7355352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 7365352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7375352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the text of the given diagnostic. 7385352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 7395352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic); 740a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor 741a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor/** 742aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the name of the command-line option that enabled this 743aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostic. 744aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 745aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Diag The diagnostic to be queried. 746aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 747aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Disable If non-NULL, will be set to the option that disables this 748aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostic (if any). 749aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 750aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns A string that contains the command-line option used to enable this 751aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * warning, such as "-Wconversion" or "-pedantic". 752aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 753aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag, 754aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXString *Disable); 755aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 756aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 757aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the category number for this diagnostic. 758aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 759aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * Diagnostics can be categorized into groups along with other, related 760aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostics (e.g., diagnostics under the same warning flag). This routine 761aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * retrieves the category number for the given diagnostic. 762aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 763aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns The number of the category that contains this diagnostic, or zero 764aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * if this diagnostic is uncategorized. 765aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 766aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic); 767aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 768aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 769aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the name of a particular diagnostic category. 770aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 771aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Category A diagnostic category number, as returned by 772aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c clang_getDiagnosticCategory(). 773aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 774aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns The name of the given diagnostic category. 775aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 776aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticCategoryName(unsigned Category); 777aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 778aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 779a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Determine the number of source ranges associated with the given 780a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * diagnostic. 781a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor */ 782a3890baf1256ff26081306c7fef70202f8223f41Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic); 783896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 7845352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 785a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Retrieve a source range associated with the diagnostic. 7865352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 787a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * A diagnostic's source ranges highlight important elements in the source 7885352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * code. On the command line, Clang displays source ranges by 789896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * underlining them with '~' characters. 7905352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 791a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \param Diagnostic the diagnostic whose range is being extracted. 7925352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 793896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Range the zero-based index specifying which range to 7945352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 795a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \returns the requested source range. 7965352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 797896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic, 798a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor unsigned Range); 7995352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 8005352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 8015352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the number of fix-it hints associated with the 8025352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * given diagnostic. 8035352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 8045352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic); 8055352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 8065352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 807473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \brief Retrieve the replacement information for a given fix-it. 8085352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 809473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * Fix-its are described in terms of a source range whose contents 810473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * should be replaced by a string. This approach generalizes over 811473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * three kinds of operations: removal of source code (the range covers 812473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * the code to be removed and the replacement string is empty), 813473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replacement of source code (the range covers the code to be 814473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced and the replacement string provides the new code), and 815473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion (both the start and end of the range point at the 816473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion location, and the replacement string provides the text to 817473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insert). 8185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 819473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param Diagnostic The diagnostic whose fix-its are being queried. 8205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 821473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param FixIt The zero-based index of the fix-it. 8225352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 823473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param ReplacementRange The source range whose contents will be 824473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced with the returned replacement string. Note that source 825473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * ranges are half-open ranges [a, b), so the source code should be 826473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced from a and up to (but not including) b. 8275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 828473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \returns A string containing text that should be replace the source 829473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * code indicated by the \c ReplacementRange. 8305352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 831896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic, 832473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor unsigned FixIt, 833473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor CXSourceRange *ReplacementRange); 8345352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 8355352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 8365352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 8375352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 8385352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 8395352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 8405352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation 8415352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8425352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * The routines in this group provide the ability to create and destroy 8435352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * translation units from files, either by parsing the contents of the files or 8445352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * by reading in a serialized representation of a translation unit. 8455352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8465352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @{ 8475352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 848896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 8495352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 8505352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Get the original translation unit source file name. 8515352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 8525352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString 8535352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getTranslationUnitSpelling(CXTranslationUnit CTUnit); 8545352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 8555352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 8565352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Return the CXTranslationUnit for a given source file and the provided 8575352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * command line arguments one would pass to the compiler. 8585352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8595352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: The 'source_filename' argument is optional. If the caller provides a 8605352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * NULL pointer, the name of the source file is expected to reside in the 8615352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * specified command line arguments. 8625352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8635352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: When encountered in 'clang_command_line_args', the following options 8645352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * are ignored: 8655352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8665352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-c' 8675352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-emit-ast' 8685352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-fsyntax-only' 8695352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-o <output file>' (both '-o' and '<output file>' are ignored) 8705352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8711ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param CIdx The index object with which the translation unit will be 8721ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * associated. 8735352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8745352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param source_filename - The name of the source file to load, or NULL if the 8751ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * source file is included in \p clang_command_line_args. 8761ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * 8771ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param num_clang_command_line_args The number of command-line arguments in 8781ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \p clang_command_line_args. 8791ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * 8801ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param clang_command_line_args The command-line arguments that would be 8811ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * passed to the \c clang executable if it were being invoked out-of-process. 8821ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * These command-line options will be parsed and will affect how the translation 8831ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * unit is parsed. Note that the following options are ignored: '-c', 8841ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'. 8855352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8865352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 8875352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * unsaved_files. 8885352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 8895352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 8905352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * but may be required for code completion, including the contents of 891c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * those files. The contents and name of these files (as specified by 892c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * CXUnsavedFile) are copied when necessary, so the client only needs to 893c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * guarantee their validity until the call to this function returns. 8945352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 8955352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile( 8965352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXIndex CIdx, 8975352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor const char *source_filename, 8985352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor int num_clang_command_line_args, 8992ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *clang_command_line_args, 9005352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor unsigned num_unsaved_files, 901a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor struct CXUnsavedFile *unsaved_files); 902896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 9035352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 9045352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Create a translation unit from an AST file (-emit-ast). 9055352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 906896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(CXIndex, 907a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const char *ast_filename); 9085352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 90944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor/** 91044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Flags that control the creation of translation units. 91144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 91244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * The enumerators in this enumeration type are meant to be bitwise 91344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * ORed together to specify which options should be used when 91444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * constructing the translation unit. 91544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 9165a43021ac491bf091494167127772a20d9a9bb48Douglas Gregorenum CXTranslationUnit_Flags { 9175a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 9185a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that no special translation-unit options are 9195a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * needed. 9205a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 9215a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor CXTranslationUnit_None = 0x0, 9225a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 9235a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 9245a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that the parser should construct a "detailed" 9255a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * preprocessing record, including all macro definitions and instantiations. 9265a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9275a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * Constructing a detailed preprocessing record requires more memory 9285a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * and time to parse, since the information contained in the record 9295a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is usually not retained. However, it can be useful for 9305a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * applications that require more detailed information about the 9315a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * behavior of the preprocessor. 9325a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 93344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor CXTranslationUnit_DetailedPreprocessingRecord = 0x01, 93444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 93544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 936b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Used to indicate that the translation unit is incomplete. 93744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 938b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * When a translation unit is considered "incomplete", semantic 939b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * analysis that is typically performed at the end of the 940b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * translation unit will be suppressed. For example, this suppresses 941b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * the completion of tentative declarations in C and of 942b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * instantiation of implicitly-instantiation function templates in 943b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * C++. This option is typically used when parsing a header with the 944b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * intent of producing a precompiled header. 94544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 946b1c031be513705d924038f497279b9b599868ba1Douglas Gregor CXTranslationUnit_Incomplete = 0x02, 94744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 94844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 94944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Used to indicate that the translation unit should be built with an 95044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header for the preamble. 95144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 95244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * An implicit precompiled header is used as an optimization when a 95344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * particular translation unit is likely to be reparsed many times 95444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * when the sources aren't changing that often. In this case, an 95544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header will be built containing all of the 95644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * initial includes at the top of the main file (what we refer to as 95744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * the "preamble" of the file). In subsequent parses, if the 95844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * preamble or the files in it have not changed, \c 95944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * clang_reparseTranslationUnit() will re-use the implicit 96044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * precompiled header to improve parsing performance. 96144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 962e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXTranslationUnit_PrecompiledPreamble = 0x04, 963e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 964e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 965e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that the translation unit should cache some 966e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion results with each reparse of the source file. 967e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 968e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * Caching of code-completion results is a performance optimization that 969e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * introduces some overhead to reparsing but improves the performance of 970e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion operations. 971e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 97299ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CacheCompletionResults = 0x08, 97399ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 974b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * \brief DEPRECATED: Enable precompiled preambles in C++. 97599ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 97699ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 977b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * we are testing C++ precompiled preamble support. It is deprecated. 97899ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 97999ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CXXPrecompiledPreamble = 0x10, 98099ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor 98199ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 982b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * \brief DEPRECATED: Enabled chained precompiled preambles in C++. 98399ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 98499ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 985b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * we are testing C++ precompiled preamble support. It is deprecated. 98699ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 987dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor CXTranslationUnit_CXXChainedPCH = 0x20, 988dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor 989dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor /** 990dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor * \brief Used to indicate that the "detailed" preprocessing record, 991fd14e91dc0ac5db175c4b30af98e7f8adabcb508Chandler Carruth * if requested, should also contain nested macro expansions. 992dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor * 993fd14e91dc0ac5db175c4b30af98e7f8adabcb508Chandler Carruth * Nested macro expansions (i.e., macro expansions that occur 994fd14e91dc0ac5db175c4b30af98e7f8adabcb508Chandler Carruth * inside another macro expansion) can, in some code bases, require 995dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor * a large amount of storage to due preprocessor metaprogramming. Moreover, 996dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor * its fairly rare that this information is useful for libclang clients. 997dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor */ 998ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth CXTranslationUnit_NestedMacroExpansions = 0x40, 999ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth 1000ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth /** 1001ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth * \brief Legacy name to indicate that the "detailed" preprocessing record, 1002fd14e91dc0ac5db175c4b30af98e7f8adabcb508Chandler Carruth * if requested, should contain nested macro expansions. 1003ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth * 1004ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth * \see CXTranslationUnit_NestedMacroExpansions for the current name for this 1005ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth * value, and its semantics. This is just an alias. 1006ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth */ 1007ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth CXTranslationUnit_NestedMacroInstantiations = 1008ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth CXTranslationUnit_NestedMacroExpansions 10095a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor}; 10105a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 10115a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor/** 1012b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Returns the set of flags that is suitable for parsing a translation 1013b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * unit that is being edited. 1014b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * 1015b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * The set of flags returned provide options for \c clang_parseTranslationUnit() 1016b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * to indicate that the translation unit is likely to be reparsed many times, 1017b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly 1018b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag 1019b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set contains an unspecified set of optimizations (e.g., the precompiled 1020b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * preamble) geared toward improving the performance of these routines. The 1021b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set of optimizations enabled may change from one version to the next. 1022b1c031be513705d924038f497279b9b599868ba1Douglas Gregor */ 1023e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void); 1024b1c031be513705d924038f497279b9b599868ba1Douglas Gregor 1025b1c031be513705d924038f497279b9b599868ba1Douglas Gregor/** 10265a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Parse the given source file and the translation unit corresponding 10275a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * to that file. 10285a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10295a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * This routine is the main entry point for the Clang C API, providing the 10305a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * ability to parse a source file into a translation unit that can then be 10315a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * queried by other functions in the API. This routine accepts a set of 10325a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * command-line arguments so that the compilation can be configured in the same 10335a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * way that the compiler is configured on the command line. 10345a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10355a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param CIdx The index object with which the translation unit will be 10365a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * associated. 10375a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10385a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param source_filename The name of the source file to load, or NULL if the 10391ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * source file is included in \p command_line_args. 10405a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10415a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param command_line_args The command-line arguments that would be 10425a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * passed to the \c clang executable if it were being invoked out-of-process. 10435a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * These command-line options will be parsed and will affect how the translation 10445a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unit is parsed. Note that the following options are ignored: '-c', 10455a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'. 10465a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10475a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_command_line_args The number of command-line arguments in 10485a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \p command_line_args. 10495a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10505a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 10511abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing, including the contents of 10525a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * those files. The contents and name of these files (as specified by 10535a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 10545a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * guarantee their validity until the call to this function returns. 10555a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10565a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 10575a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unsaved_files. 10585a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10595a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param options A bitmask of options that affects how the translation unit 10605a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is managed but not its compilation. This should be a bitwise OR of the 10615a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXTranslationUnit_XXX flags. 10625a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10635a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \returns A new translation unit describing the parsed code and containing 10645a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * any diagnostics produced by the compiler. If there is a failure from which 10655a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * the compiler cannot recover, returns NULL. 10665a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 10675a43021ac491bf091494167127772a20d9a9bb48Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx, 10685a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor const char *source_filename, 10692ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *command_line_args, 10705a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor int num_command_line_args, 10715a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor struct CXUnsavedFile *unsaved_files, 10725a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned num_unsaved_files, 10735a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned options); 10745a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 10755352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 10761999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Flags that control how translation units are saved. 10771999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 10781999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 10791999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * ORed together to specify which options should be used when 10801999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * saving the translation unit. 10811999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 10821999844e7a18786e61e619e1dc6c789827541863Douglas Gregorenum CXSaveTranslationUnit_Flags { 10831999844e7a18786e61e619e1dc6c789827541863Douglas Gregor /** 10841999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Used to indicate that no special saving options are needed. 10851999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 10861999844e7a18786e61e619e1dc6c789827541863Douglas Gregor CXSaveTranslationUnit_None = 0x0 10871999844e7a18786e61e619e1dc6c789827541863Douglas Gregor}; 10881999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 10891999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 10901999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Returns the set of flags that is suitable for saving a translation 10911999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * unit. 10921999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 10931999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The set of flags returned provide options for 10941999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \c clang_saveTranslationUnit() by default. The returned flag 10951999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * set contains an unspecified set of options that save translation units with 10961999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * the most commonly-requested data. 10971999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 10981999844e7a18786e61e619e1dc6c789827541863Douglas GregorCINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU); 10991999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 11001999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 110139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Describes the kind of error that occurred (if any) in a call to 110239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \c clang_saveTranslationUnit(). 110339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 110439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregorenum CXSaveError { 110539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 110639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that no error occurred while saving a translation unit. 110739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 110839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_None = 0, 110939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 111039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 111139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that an unknown error occurred while attempting to save 111239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * the file. 111339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * 111439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * This error typically indicates that file I/O failed when attempting to 111539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * write the file. 111639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 111739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_Unknown = 1, 111839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 111939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 112039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that errors during translation prevented this attempt 112139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * to save the translation unit. 112239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * 112339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * Errors that prevent the translation unit from being saved can be 112439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic(). 112539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 112639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_TranslationErrors = 2, 112739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 112839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 112939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that the translation unit to be saved was somehow 113039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * invalid (e.g., NULL). 113139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 113239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_InvalidTU = 3 113339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor}; 113439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 113539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor/** 11367ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \brief Saves a translation unit into a serialized representation of 11377ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * that translation unit on disk. 11387ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 11397ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * Any translation unit that was parsed without error can be saved 11407ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * into a file. The translation unit can then be deserialized into a 11417ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * new \c CXTranslationUnit with \c clang_createTranslationUnit() or, 11427ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * if it is an incomplete translation unit that corresponds to a 11437ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * header, used as a precompiled header when parsing other translation 11447ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * units. 11457ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 11467ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param TU The translation unit to save. 11471999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 11487ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param FileName The file to which the translation unit will be saved. 11497ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 11501999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \param options A bitmask of options that affects how the translation unit 11511999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * is saved. This should be a bitwise OR of the 11521999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * CXSaveTranslationUnit_XXX flags. 11531999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 115439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \returns A value that will match one of the enumerators of the CXSaveError 115539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * enumeration. Zero (CXSaveError_None) indicates that the translation unit was 115639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * saved successfully, while a non-zero value indicates that a problem occurred. 11577ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor */ 11587ae2faafd30524ef5f863bb3b8701977888839bbDouglas GregorCINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU, 11591999844e7a18786e61e619e1dc6c789827541863Douglas Gregor const char *FileName, 11601999844e7a18786e61e619e1dc6c789827541863Douglas Gregor unsigned options); 11617ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 11627ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor/** 11635352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Destroy the specified CXTranslationUnit object. 11645352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 11655352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit); 1166896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 11675352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 1168e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Flags that control the reparsing of translation units. 1169e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1170e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 1171e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * ORed together to specify which options should be used when 1172e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * reparsing the translation unit. 1173e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1174e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregorenum CXReparse_Flags { 1175e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 1176e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that no special reparsing options are needed. 1177e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1178e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXReparse_None = 0x0 1179e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor}; 1180e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 1181e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 1182e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Returns the set of flags that is suitable for reparsing a translation 1183e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * unit. 1184e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1185e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The set of flags returned provide options for 1186e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \c clang_reparseTranslationUnit() by default. The returned flag 1187e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * set contains an unspecified set of optimizations geared toward common uses 1188e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * of reparsing. The set of optimizations enabled may change from one version 1189e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * to the next. 1190e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1191e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU); 1192e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 1193e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 1194abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \brief Reparse the source files that produced this translation unit. 1195abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1196abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * This routine can be used to re-parse the source files that originally 1197abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * created the given translation unit, for example because those source files 1198abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * have changed (either on disk or as passed via \p unsaved_files). The 1199abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * source code will be reparsed with the same command-line options as it 1200abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * was originally parsed. 1201abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1202abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * Reparsing a translation unit invalidates all cursors and source locations 1203abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * that refer into that translation unit. This makes reparsing a translation 1204abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit semantically equivalent to destroying the translation unit and then 1205abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * creating a new translation unit with the same command-line arguments. 1206abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * However, it may be more efficient to reparse a translation 1207abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit using this routine. 1208abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1209abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param TU The translation unit whose contents will be re-parsed. The 1210abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * translation unit must originally have been built with 1211abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_createTranslationUnitFromSourceFile(). 1212abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1213abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 1214abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unsaved_files. 1215abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1216abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param unsaved_files The files that have not yet been saved to disk 1217abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * but may be required for parsing, including the contents of 1218abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * those files. The contents and name of these files (as specified by 1219abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 1220abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * guarantee their validity until the call to this function returns. 1221abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1222e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \param options A bitset of options composed of the flags in CXReparse_Flags. 1223e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The function \c clang_defaultReparseOptions() produces a default set of 1224e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * options recommended for most uses, based on the translation unit. 1225e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1226abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \returns 0 if the sources could be reparsed. A non-zero value will be 1227abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * returned if reparsing was impossible, such that the translation unit is 1228abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * invalid. In such cases, the only valid call for \p TU is 1229abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_disposeTranslationUnit(TU). 1230abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor */ 1231abc563f554951259bbe0315055cad92ee14d87e4Douglas GregorCINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU, 1232abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned num_unsaved_files, 1233e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor struct CXUnsavedFile *unsaved_files, 1234e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor unsigned options); 123559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 123659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 123759fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Categorizes how memory is being used by a translation unit. 123859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1239f787002478f09af1741fb0f82a562002e6799c49Ted Kremenekenum CXTUResourceUsageKind { 1240f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_AST = 1, 1241f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_Identifiers = 2, 1242f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_Selectors = 3, 1243f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_GlobalCompletionResults = 4, 1244457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek CXTUResourceUsage_SourceManagerContentCache = 5, 1245ba29bd25515fbd99e98ba0fedb9d93617b27609eTed Kremenek CXTUResourceUsage_AST_SideTables = 6, 1246f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7, 1247e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_SourceManager_Membuffer_MMap = 8, 1248e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9, 1249e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10, 12505e1db6a434d0e3fe0fbde0bca2ec44552818fb22Ted Kremenek CXTUResourceUsage_Preprocessor = 11, 12515e1db6a434d0e3fe0fbde0bca2ec44552818fb22Ted Kremenek CXTUResourceUsage_PreprocessingRecord = 12, 1252ca7dc2b755eb81ac95121ce1a1f1aa44a4a0fe12Ted Kremenek CXTUResourceUsage_SourceManager_DataStructures = 13, 1253d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Preprocessor_HeaderSearch = 14, 1254f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST, 1255f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_MEMORY_IN_BYTES_END = 1256d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Preprocessor_HeaderSearch, 1257f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek 1258f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_First = CXTUResourceUsage_AST, 1259d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch 126059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek}; 126159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 126259fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 126359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Returns the human-readable null-terminated C string that represents 1264f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek * the name of the memory category. This string should never be freed. 126559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 126659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted KremenekCINDEX_LINKAGE 1267f787002478f09af1741fb0f82a562002e6799c49Ted Kremenekconst char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind); 126859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1269f787002478f09af1741fb0f82a562002e6799c49Ted Kremenektypedef struct CXTUResourceUsageEntry { 127059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief The memory usage category. */ 1271f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek enum CXTUResourceUsageKind kind; 1272f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek /* \brief Amount of resources used. 1273f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek The units will depend on the resource kind. */ 127459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek unsigned long amount; 1275f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek} CXTUResourceUsageEntry; 127659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 127759fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 127859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief The memory usage of a CXTranslationUnit, broken into categories. 127959fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1280f787002478f09af1741fb0f82a562002e6799c49Ted Kremenektypedef struct CXTUResourceUsage { 128159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief Private data member, used for queries. */ 128259fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek void *data; 128359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 128459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief The number of entries in the 'entries' array. */ 128559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek unsigned numEntries; 128659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 128759fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief An array of key-value pairs, representing the breakdown of memory 128859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek usage. */ 1289f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsageEntry *entries; 129059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1291f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek} CXTUResourceUsage; 129259fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 129359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 129459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Return the memory usage of a translation unit. This object 1295f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek * should be released with clang_disposeCXTUResourceUsage(). 129659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1297f787002478f09af1741fb0f82a562002e6799c49Ted KremenekCINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU); 129859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1299f787002478f09af1741fb0f82a562002e6799c49Ted KremenekCINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage); 130059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1301abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor/** 13025352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 13035352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 1304896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 13055352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 1306c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes the kind of entity that a cursor refers to. 1307c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1308c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXCursorKind { 1309c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Declarations */ 13101efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1311c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A declaration whose specific kind is not exposed via this 13121efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 1313c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1314c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed declarations have the same operations as any other kind 1315c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of declaration; one can extract their location information, 1316c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, find their definitions, etc. However, the specific kind 1317c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of the declaration is not reported. 1318c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1319c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedDecl = 1, 1320c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ struct. */ 13211efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_StructDecl = 2, 1322c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ union. */ 1323c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnionDecl = 3, 1324c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C++ class. */ 1325c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ClassDecl = 4, 1326c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumeration. */ 1327c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumDecl = 5, 13281efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1329c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A field (in C) or non-static data member (in C++) in a 1330c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * struct, union, or C++ class. 1331c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1332c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FieldDecl = 6, 1333c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumerator constant. */ 1334c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumConstantDecl = 7, 1335c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function. */ 1336c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FunctionDecl = 8, 1337c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A variable. */ 1338c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_VarDecl = 9, 1339c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function or method parameter. */ 1340c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ParmDecl = 10, 1341c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @interface. */ 1342c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInterfaceDecl = 11, 1343c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @interface for a category. */ 1344c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryDecl = 12, 1345c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @protocol declaration. */ 1346c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolDecl = 13, 1347c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @property declaration. */ 1348c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCPropertyDecl = 14, 1349c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance variable. */ 1350c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCIvarDecl = 15, 1351c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance method. */ 1352c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInstanceMethodDecl = 16, 1353c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C class method. */ 1354c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassMethodDecl = 17, 1355c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @implementation. */ 1356c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCImplementationDecl = 18, 1357c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C @implementation for a category. */ 1358c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryImplDecl = 19, 1359c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A typedef */ 1360c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypedefDecl = 20, 13618bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek /** \brief A C++ class method. */ 13628bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek CXCursor_CXXMethod = 21, 13638f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek /** \brief A C++ namespace. */ 13648f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek CXCursor_Namespace = 22, 1365a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek /** \brief A linkage specification, e.g. 'extern "C"'. */ 1366a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek CXCursor_LinkageSpec = 23, 136701829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ constructor. */ 136801829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Constructor = 24, 136901829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ destructor. */ 137001829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Destructor = 25, 137101829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ conversion function. */ 137201829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_ConversionFunction = 26, 1373fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template type parameter. */ 1374fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTypeParameter = 27, 1375fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ non-type template parameter. */ 1376fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_NonTypeTemplateParameter = 28, 1377fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template template parameter. */ 1378fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTemplateParameter = 29, 1379fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ function template. */ 1380fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_FunctionTemplate = 30, 138139d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor /** \brief A C++ class template. */ 138239d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor CXCursor_ClassTemplate = 31, 138374dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor /** \brief A C++ class template partial specialization. */ 138474dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor CXCursor_ClassTemplatePartialSpecialization = 32, 13856931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** \brief A C++ namespace alias declaration. */ 13866931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceAlias = 33, 13870a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor /** \brief A C++ using directive. */ 13880a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor CXCursor_UsingDirective = 34, 1389162e1c1b487352434552147967c3dd296ebee2f7Richard Smith /** \brief A C++ using declaration. */ 13907e24256c95afb64b4d5abf201a0f9f0527cb4cf3Douglas Gregor CXCursor_UsingDeclaration = 35, 1391162e1c1b487352434552147967c3dd296ebee2f7Richard Smith /** \brief A C++ alias declaration */ 1392162e1c1b487352434552147967c3dd296ebee2f7Richard Smith CXCursor_TypeAliasDecl = 36, 1393352697a87bca664356f21a838b162084013625eaDouglas Gregor /** \brief An Objective-C @synthesize definition. */ 1394352697a87bca664356f21a838b162084013625eaDouglas Gregor CXCursor_ObjCSynthesizeDecl = 37, 1395352697a87bca664356f21a838b162084013625eaDouglas Gregor /** \brief An Objective-C @dynamic definition. */ 1396352697a87bca664356f21a838b162084013625eaDouglas Gregor CXCursor_ObjCDynamicDecl = 38, 13972dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis /** \brief An access specifier. */ 13982dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis CXCursor_CXXAccessSpecifier = 39, 139942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 140050aa6acd0b8d40c8956372a69e0a73f0802a5494Ted Kremenek CXCursor_FirstDecl = CXCursor_UnexposedDecl, 14012dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis CXCursor_LastDecl = CXCursor_CXXAccessSpecifier, 14021efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1403c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* References */ 1404c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstRef = 40, /* Decl references */ 14051efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_ObjCSuperClassRef = 40, 1406c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolRef = 41, 1407c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassRef = 42, 1408c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1409c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A reference to a type declaration. 1410c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1411c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A type reference occurs anywhere where a type is named but not 1412c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * declared. For example, given: 1413c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1414c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \code 1415c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * typedef unsigned size_type; 1416c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * size_type size; 1417c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \endcode 1418c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1419c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The typedef is a declaration of size_type (CXCursor_TypedefDecl), 1420c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * while the type of the variable "size" is referenced. The cursor 1421c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * referenced by the type of size is the typedef for size_type. 1422c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1423c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypeRef = 43, 14243064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CXCursor_CXXBaseSpecifier = 44, 14250b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor /** 1426a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * \brief A reference to a class template, function template, template 1427a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * template parameter, or class template partial specialization. 14280b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor */ 14290b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor CXCursor_TemplateRef = 45, 14306931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** 14316931900f43cea558c6974075256c07728dbfecc6Douglas Gregor * \brief A reference to a namespace or namespace alias. 14326931900f43cea558c6974075256c07728dbfecc6Douglas Gregor */ 14336931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceRef = 46, 1434a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor /** 143536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a member of a struct, union, or class that occurs in 143636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * some non-expression context, e.g., a designated initializer. 1437a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor */ 1438a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor CXCursor_MemberRef = 47, 143936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** 144036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a labeled statement. 144136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 144236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the jump to "start_over" in the 144336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto statement in the following example: 144436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 144536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 144636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 144736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 144836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 144936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto start_over; 145036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 145136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 145236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * A label reference cursor refers to a label statement. 145336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 145436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelRef = 48, 145536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 14561f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor /** 14571f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief A reference to a set of overloaded functions or function templates 14581f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * that has not yet been resolved to a specific function or function template. 14591f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14601f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * An overloaded declaration reference cursor occurs in C++ templates where 14611f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * a dependent name refers to a function. For example: 14621f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14631f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \code 14641f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> void swap(T&, T&); 14651f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14661f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct X { ... }; 14671f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(X&, X&); 14681f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14691f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> 14701f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void reverse(T* first, T* last) { 14711f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * while (first < last - 1) { 14721f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * swap(*first, *--last); 14731f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * ++first; 14741f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 14751f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 14761f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14771f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct Y { }; 14781f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(Y&, Y&); 14791f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \endcode 14801f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14811f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * Here, the identifier "swap" is associated with an overloaded declaration 14821f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * reference. In the template definition, "swap" refers to either of the two 14831f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * "swap" functions declared above, so both results will be available. At 14841f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * instantiation time, "swap" may also refer to other functions found via 14851f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * argument-dependent lookup (e.g., the "swap" function at the end of the 14861f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * example). 14871f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 14881f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * The functions \c clang_getNumOverloadedDecls() and 14891f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c clang_getOverloadedDecl() can be used to retrieve the definitions 14901f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * referenced by this cursor. 14911f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 14921f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor CXCursor_OverloadedDeclRef = 49, 14931f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 14941f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor CXCursor_LastRef = CXCursor_OverloadedDeclRef, 14951efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1496c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Error conditions */ 1497c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstInvalid = 70, 1498c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_InvalidFile = 70, 1499c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NoDeclFound = 71, 1500c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NotImplemented = 72, 1501ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_InvalidCode = 73, 1502ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_LastInvalid = CXCursor_InvalidCode, 15031efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1504c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Expressions */ 1505c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstExpr = 100, 15061efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1507c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1508c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression whose specific kind is not exposed via this 15091efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 1510c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1511c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed expressions have the same operations as any other kind 1512c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of expression; one can extract their location information, 1513c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, children, etc. However, the specific kind of the 1514c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * expression is not reported. 1515c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1516c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedExpr = 100, 15171efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1518c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1519c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to some value declaration, such 1520c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * as a function, varible, or enumerator. 1521c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1522c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_DeclRefExpr = 101, 15231efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1524c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1525c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to a member of a struct, union, 1526c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * class, Objective-C class, etc. 1527c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1528c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_MemberRefExpr = 102, 15291efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1530c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that calls a function. */ 1531c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_CallExpr = 103, 15321efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1533c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that sends a message to an Objective-C 1534c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor object or class. */ 1535c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCMessageExpr = 104, 15361ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 15371ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek /** \brief An expression that represents a block literal. */ 15381ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek CXCursor_BlockExpr = 105, 15391ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 154042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An integer literal. 154142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 154242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_IntegerLiteral = 106, 154342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 154442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A floating point number literal. 154542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 154642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_FloatingLiteral = 107, 154742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 154842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An imaginary number literal. 154942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 155042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ImaginaryLiteral = 108, 155142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 155242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A string literal. 155342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 155442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_StringLiteral = 109, 155542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 155642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A character literal. 155742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 155842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CharacterLiteral = 110, 155942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 156042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A parenthesized expression, e.g. "(1)". 156142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 156242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This AST node is only formed if full location information is requested. 156342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 156442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ParenExpr = 111, 156542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 156642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief This represents the unary-expression's (except sizeof and 156742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * alignof). 156842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 156942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_UnaryOperator = 112, 157042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 157142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C99 6.5.2.1] Array Subscripting. 157242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 157342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ArraySubscriptExpr = 113, 157442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 157542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A builtin binary operation expression such as "x + y" or 157642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * "x <= y". 157742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 157842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_BinaryOperator = 114, 157942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 158042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Compound assignment such as "+=". 158142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 158242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CompoundAssignOperator = 115, 158342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 158442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief The ?: ternary operator. 158542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 158642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ConditionalOperator = 116, 158742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 158842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++ 158942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * (C++ [expr.cast]), which uses the syntax (Type)expr. 159042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 159142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * For example: (int)f. 159242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 159342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CStyleCastExpr = 117, 159442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 159542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C99 6.5.2.5] 159642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 159742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CompoundLiteralExpr = 118, 159842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 159942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Describes an C or C++ initializer list. 160042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 160142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_InitListExpr = 119, 160242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 160342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief The GNU address of label extension, representing &&label. 160442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 160542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_AddrLabelExpr = 120, 160642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 160742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief This is the GNU Statement Expression extension: ({int X=4; X;}) 160842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 160942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_StmtExpr = 121, 161042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 161142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents a C1X generic selection. 161242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 161342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_GenericSelectionExpr = 122, 161442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 161542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Implements the GNU __null extension, which is a name for a null 161642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * pointer constant that has integral type (e.g., int or long) and is the same 161742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * size and alignment as a pointer. 161842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 161942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * The __null extension is typically only used by system headers, which define 162042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * NULL as __null in C++ rather than using 0 (which is an integer that may not 162142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * match the size of a pointer). 162242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 162342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_GNUNullExpr = 123, 162442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 162542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s static_cast<> expression. 162642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 162742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXStaticCastExpr = 124, 162842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 162942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s dynamic_cast<> expression. 163042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 163142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXDynamicCastExpr = 125, 163242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 163342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s reinterpret_cast<> expression. 163442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 163542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXReinterpretCastExpr = 126, 163642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 163742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s const_cast<> expression. 163842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 163942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXConstCastExpr = 127, 164042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 164142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents an explicit C++ type conversion that uses "functional" 164242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * notion (C++ [expr.type.conv]). 164342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 164442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * Example: 164542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 164642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * x = int(0.5); 164742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 164842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 164942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXFunctionalCastExpr = 128, 165042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 165142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A C++ typeid expression (C++ [expr.typeid]). 165242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 165342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXTypeidExpr = 129, 165442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 165542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C++ 2.13.5] C++ Boolean Literal. 165642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 165742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXBoolLiteralExpr = 130, 165842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 165942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C++0x 2.14.7] C++ Pointer Literal. 166042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 166142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXNullPtrLiteralExpr = 131, 166242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 166342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents the "this" expression in C++ 166442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 166542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXThisExpr = 132, 166642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 166742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C++ 15] C++ Throw Expression. 166842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 166942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This handles 'throw' and 'throw' assignment-expression. When 167042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * assignment-expression isn't present, Op will be null. 167142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 167242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXThrowExpr = 133, 167342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 167442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A new expression for memory allocation and constructor calls, e.g: 167542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * "new CXXNewExpr(foo)". 167642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 167742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXNewExpr = 134, 167842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 167942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A delete expression for memory deallocation and destructor calls, 168042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * e.g. "delete[] pArray". 168142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 168242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXDeleteExpr = 135, 168342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 168442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A unary expression. 168542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 168642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_UnaryExpr = 136, 168742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 168842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief ObjCStringLiteral, used for Objective-C string literals i.e. "foo". 168942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 169042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCStringLiteral = 137, 169142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 169242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief ObjCEncodeExpr, used for in Objective-C. 169342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 169442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCEncodeExpr = 138, 169542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 169642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief ObjCSelectorExpr used for in Objective-C. 169742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 169842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCSelectorExpr = 139, 169942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 170042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's protocol expression. 170142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 170242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCProtocolExpr = 140, 170342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 170442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An Objective-C "bridged" cast expression, which casts between 170542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * Objective-C pointers and C pointers, transferring ownership in the process. 170642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 170742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 170842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * NSString *str = (__bridge_transfer NSString *)CFCreateString(); 170942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 171042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 171142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCBridgedCastExpr = 141, 171242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 171342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents a C++0x pack expansion that produces a sequence of 171442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * expressions. 171542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 171642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * A pack expansion expression contains a pattern (which itself is an 171742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * expression) followed by an ellipsis. For example: 171842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 171942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 172042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * template<typename F, typename ...Types> 172142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * void forward(F f, Types &&...args) { 172242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * f(static_cast<Types&&>(args)...); 172342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * } 172442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 172542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 172642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_PackExpansionExpr = 142, 172742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 172842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents an expression that computes the length of a parameter 172942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * pack. 173042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 173142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 173242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * template<typename ...Types> 173342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * struct count { 173442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * static const unsigned value = sizeof...(Types); 173542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * }; 173642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 173742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 173842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SizeOfPackExpr = 143, 173942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 174042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_LastExpr = CXCursor_SizeOfPackExpr, 17411efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1742c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Statements */ 1743c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstStmt = 200, 1744c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1745c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A statement whose specific kind is not exposed via this 1746c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * interface. 1747c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1748c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed statements have the same operations as any other kind of 1749c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * statement; one can extract their location information, spelling, 1750c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * children, etc. However, the specific kind of the statement is not 1751c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reported. 1752c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1753c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedStmt = 200, 175436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 175536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** \brief A labelled statement in a function. 175636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 175736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the "start_over:" label statement in 175836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * the following example: 175936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 176036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 176136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 176236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 176336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 176436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 176536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 176636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelStmt = 201, 176742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 176842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A group of statements like { stmt stmt }. 176942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 177042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This cursor kind is used to describe compound statements, e.g. function 177142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * bodies. 177242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 177342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CompoundStmt = 202, 177442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 177542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A case statment. 177642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 177742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CaseStmt = 203, 177842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 177942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A default statement. 178042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 178142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_DefaultStmt = 204, 178242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 178342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An if statement 178442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 178542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_IfStmt = 205, 178642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 178742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A switch statement. 178842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 178942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SwitchStmt = 206, 179042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 179142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A while statement. 179242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 179342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_WhileStmt = 207, 179442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 179542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A do statement. 179642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 179742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_DoStmt = 208, 179842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 179942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A for statement. 180042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 180142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ForStmt = 209, 180242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 180342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A goto statement. 180442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 180542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_GotoStmt = 210, 180642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 180742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An indirect goto statement. 180842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 180942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_IndirectGotoStmt = 211, 181042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 181142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A continue statement. 181242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 181342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ContinueStmt = 212, 181442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 181542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A break statement. 181642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 181742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_BreakStmt = 213, 181842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 181942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A return statement. 182042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 182142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ReturnStmt = 214, 182242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 182342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A GNU inline assembly statement extension. 182442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 182542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_AsmStmt = 215, 182642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 18273f54d48a75234efdbbfcd503fd316a78ffd4b50dDouglas Gregor /** \brief Objective-C's overall @try-@catch-@finally statement. 182842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 182942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtTryStmt = 216, 183042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 183142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's @catch statement. 183242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 183342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtCatchStmt = 217, 183442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 183542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's @finally statement. 183642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 183742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtFinallyStmt = 218, 183842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 183942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's @throw statement. 184042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 184142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtThrowStmt = 219, 184242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 184342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's @synchronized statement. 184442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 184542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtSynchronizedStmt = 220, 184642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 184742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's autorelease pool statement. 184842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 184942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAutoreleasePoolStmt = 221, 185042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 185142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's collection statement. 185242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 185342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCForCollectionStmt = 222, 185442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 185542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s catch statement. 185642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 185742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXCatchStmt = 223, 185842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 185942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s try statement. 186042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 186142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXTryStmt = 224, 186242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 186342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s for (* : *) statement. 186442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 186542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXForRangeStmt = 225, 186642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 186742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Windows Structured Exception Handling's try statement. 186842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 186942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SEHTryStmt = 226, 187042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 187142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Windows Structured Exception Handling's except statement. 187242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 187342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SEHExceptStmt = 227, 187442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 187542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Windows Structured Exception Handling's finally statement. 187642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 187742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SEHFinallyStmt = 228, 187842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 187942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief The null satement ";": C99 6.8.3p3. 188042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 188142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This cursor kind is used to describe the null statement. 188242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 188342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_NullStmt = 230, 188442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 188542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Adaptor class for mixing declarations with statements and 188642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * expressions. 188742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 188842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_DeclStmt = 231, 188942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 189042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_LastStmt = CXCursor_DeclStmt, 18911efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1892c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1893c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Cursor that represents the translation unit itself. 1894c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1895c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor exists primarily to act as the root 1896c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor for traversing the contents of a translation unit. 1897c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1898e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_TranslationUnit = 300, 1899e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1900e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /* Attributes */ 1901e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_FirstAttr = 400, 1902e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /** 1903e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * \brief An attribute whose specific kind is not exposed via this 1904e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * interface. 1905e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek */ 1906e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_UnexposedAttr = 400, 1907e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1908e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBActionAttr = 401, 1909e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBOutletAttr = 402, 1910857e918a8a40deb128840308a318bf623d68295fTed Kremenek CXCursor_IBOutletCollectionAttr = 403, 19116639e9255489ad8e10278d5658fdd4b3c0e1e4cdArgyrios Kyrtzidis CXCursor_CXXFinalAttr = 404, 19126639e9255489ad8e10278d5658fdd4b3c0e1e4cdArgyrios Kyrtzidis CXCursor_CXXOverrideAttr = 405, 19135f1c822def3efffe1d8f7299fbbbc3b1cdd4833dErik Verbruggen CXCursor_AnnotateAttr = 406, 19145f1c822def3efffe1d8f7299fbbbc3b1cdd4833dErik Verbruggen CXCursor_LastAttr = CXCursor_AnnotateAttr, 19159f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 19169f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor /* Preprocessing */ 19179f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_PreprocessingDirective = 500, 1918572feb2a190b5e8b04fb06c4ac50ee0f61e93ff0Douglas Gregor CXCursor_MacroDefinition = 501, 19199b2a0ac970a077bdc0bf08c6c682f80ad733c892Chandler Carruth CXCursor_MacroExpansion = 502, 19209b2a0ac970a077bdc0bf08c6c682f80ad733c892Chandler Carruth CXCursor_MacroInstantiation = CXCursor_MacroExpansion, 1921ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_InclusionDirective = 503, 19229f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective, 1923ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_LastPreprocessing = CXCursor_InclusionDirective 1924c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 1925c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1926c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1927c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A cursor representing some element in the abstract syntax tree for 1928c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a translation unit. 1929c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 19301efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor abstraction unifies the different kinds of entities in a 1931c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * program--declaration, statements, expressions, references to declarations, 1932c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * etc.--under a single "cursor" abstraction with a common set of operations. 1933c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Common operation for a cursor include: getting the physical location in 1934c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a source file where the cursor points, getting the name associated with a 1935c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor, and retrieving cursors for any child nodes of a particular cursor. 1936c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1937c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors can be produced in two specific ways. 1938c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_getTranslationUnitCursor() produces a cursor for a translation unit, 1939c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * from which one can use clang_visitChildren() to explore the rest of the 1940c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * translation unit. clang_getCursor() maps from a physical source location 1941c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to the entity that resides at that location, allowing one to map from the 1942c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * source code into the AST. 1943c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1944c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregortypedef struct { 1945c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor enum CXCursorKind kind; 1946aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis int xdata; 1947c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor void *data[3]; 19481efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar} CXCursor; 1949c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1950c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1951c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations 1952c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1953c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 1954c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 19551efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1956c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1957c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the NULL cursor, which represents no entity. 1958c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1959c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getNullCursor(void); 19601efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1961c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1962c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the cursor that represents the given translation unit. 1963c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1964c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor can be used to start traversing the 1965c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * various declarations within the given translation unit. 1966c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1967c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit); 1968c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1969c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1970c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether two cursors are equivalent. 1971c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1972c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor); 19731efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1974c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1975b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis * \brief Returns non-zero if \arg cursor is null. 1976b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis */ 1977fa865df489fe68668c554dece36c68b4ce03920fArgyrios Kyrtzidisint clang_Cursor_isNull(CXCursor); 1978b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis 1979b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis/** 19809ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor * \brief Compute a hash value for the given cursor. 19819ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor */ 19829ce5584553054d0cb934940586aca0186e87fa57Douglas GregorCINDEX_LINKAGE unsigned clang_hashCursor(CXCursor); 19839ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor 19849ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor/** 1985c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the kind of the given cursor. 1986c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1987c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor); 1988c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1989c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1990c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a declaration. 1991c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1992c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind); 1993c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 1994c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 1995c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a simple 1996c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reference. 1997c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1998c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Note that other kinds of cursors (such as expressions) can also refer to 1999c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * other cursors. Use clang_getCursorReferenced() to determine whether a 2000c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * particular cursor refers to another entity. 2001c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2002c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind); 2003c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2004c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2005c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents an expression. 2006c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2007c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind); 2008c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2009c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2010c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a statement. 2011c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2012c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind); 2013c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2014c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 20158be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor * \brief Determine whether the given cursor kind represents an attribute. 20168be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor */ 20178be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas GregorCINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind); 20188be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor 20198be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor/** 20201efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents an invalid 2021c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor. 20221efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar */ 2023c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind); 2024c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2025c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 20261efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents a translation 20271efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unit. 2028c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2029c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind); 20301efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2031ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek/*** 20329f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * \brief Determine whether the given cursor represents a preprocessing 20339f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * element, such as a preprocessor directive or macro instantiation. 20349f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor */ 20359f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas GregorCINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind); 20369f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 20379f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor/*** 2038ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * \brief Determine whether the given cursor represents a currently 2039ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt). 2040ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek */ 2041ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted KremenekCINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind); 2042ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek 2043c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 204416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief Describe the linkage of the entity referred to by a cursor. 204516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 204616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenekenum CXLinkageKind { 204716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This value indicates that no linkage information is available 204816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * for a provided CXCursor. */ 204916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Invalid, 205016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** 205116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief This is the linkage for variables, parameters, and so on that 205216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * have automatic storage. This covers normal (non-extern) local variables. 205316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 205416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_NoLinkage, 205516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for static variables and static functions. */ 205616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Internal, 205716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with external linkage that live 205816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * in C++ anonymous namespaces.*/ 205916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_UniqueExternal, 206016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with true, external linkage. */ 206116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_External 206216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek}; 206316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 206416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 206545e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the linkage of the entity referred to by a given cursor. 206616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 206716b4259aecaa22b642d35d36fd89965ed700c1e0Ted KremenekCINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor); 206816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 206916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 207058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \brief Determine the availability of the entity that this cursor refers to. 207158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 207258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param cursor The cursor to query. 207358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 207458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the cursor. 207558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 207658ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 207758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCursorAvailability(CXCursor cursor); 207858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 207958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 208045e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Describe the "language" of the entity referred to by a cursor. 208145e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 208245e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind { 20836cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_Invalid = 0, 208445e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_C, 208545e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_ObjC, 20866cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_CPlusPlus 208745e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek}; 208845e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 208945e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 209045e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the "language" of the entity referred to by a given cursor. 209145e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 209245e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor); 209345e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 2094b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis/** 2095b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis * \brief Returns the translation unit that a cursor originated from. 2096b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis */ 2097b0d6eaa6b646c18c49923aefc76973801f561701Argyrios KyrtzidisCINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor); 2098b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis 2099eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2100eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2101eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief A fast container representing a set of CXCursors. 2102eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 2103eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenektypedef struct CXCursorSetImpl *CXCursorSet; 2104eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2105eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2106eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Creates an empty CXCursorSet. 2107eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 2108eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(); 2109eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2110eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2111eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Disposes a CXCursorSet and releases its associated memory. 2112eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 2113eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset); 2114eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2115eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2116eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Queries a CXCursorSet to see if it contains a specific CXCursor. 2117eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * 2118eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \returns non-zero if the set contains the specified cursor. 2119eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek*/ 2120eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset, 2121eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek CXCursor cursor); 2122eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2123eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2124eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Inserts a CXCursor into a CXCursorSet. 2125eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * 2126eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \returns zero if the CXCursor was already in the set, and non-zero otherwise. 2127eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek*/ 2128eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset, 2129eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek CXCursor cursor); 2130eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 21312be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 21322be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the semantic parent of the given cursor. 21332be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21342be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The semantic parent of a cursor is the cursor that semantically contains 21352be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the given \p cursor. For many declarations, the lexical and semantic parents 21362be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the lexical parent is returned by 21372be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorLexicalParent()). They diverge when declarations or 21382be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 21392be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21402be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 21412be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 21422be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 21432be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 21442be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21452be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 21462be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 21472be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21482be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 21492be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 21502be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 21512be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 21522be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 21532be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 21542be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 21552be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 21562be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 21572be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21582be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 21592be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 21602be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 21613910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * 21623910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * For global declarations, the semantic parent is the translation unit. 21632be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 21642be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor); 21652be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor 21662be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 21672be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the lexical parent of the given cursor. 21682be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21692be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The lexical parent of a cursor is the cursor in which the given \p cursor 21702be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * was actually written. For many declarations, the lexical and semantic parents 21712be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the semantic parent is returned by 21722be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorSemanticParent()). They diverge when declarations or 21732be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 21742be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21752be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 21762be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 21772be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 21782be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 21792be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21802be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 21812be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 21822be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21832be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 21842be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 21852be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 21862be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 21872be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 21882be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 21892be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 21902be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 21912be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 21922be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 21932be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 21942be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 21952be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 21963910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * 21973910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * For declarations written in the global scope, the lexical parent is 21983910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * the translation unit. 21992be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 22002be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor); 22019f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 22029f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 22039f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Determine the set of methods that are overridden by the given 22049f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. 22059f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 22069f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In both Objective-C and C++, a method (aka virtual member function, 22079f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * in C++) can override a virtual method in a base class. For 22089f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * Objective-C, a method is said to override any method in the class's 22099f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * interface (if we're coming from an implementation), its protocols, 22109f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * or its categories, that has the same selector and is of the same 22119f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * kind (class or instance). If no such method exists, the search 22129f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * continues to the class's superclass, its protocols, and its 22139f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * categories, and so on. 22149f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 22159f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * For C++, a virtual member function overrides any virtual member 22169f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * function with the same signature that occurs in its base 22179f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * classes. With multiple inheritance, a virtual member function can 22189f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * override several virtual member functions coming from different 22199f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * base classes. 22209f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 22219f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In all cases, this function determines the immediate overridden 22229f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method, rather than all of the overridden methods. For example, if 22239f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * a method is originally declared in a class A, then overridden in B 22249f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * (which in inherits from A) and also in C (which inherited from B), 22259f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * then the only overridden method returned from this function when 22269f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoked on C's method will be B's method. The client may then 22279f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoke this function again, given the previously-found overridden 22289f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods, to map out the complete method-override set. 22299f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 22309f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param cursor A cursor representing an Objective-C or C++ 22319f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. This routine will compute the set of methods that this 22329f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method overrides. 22339f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 22349f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param overridden A pointer whose pointee will be replaced with a 22359f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * pointer to an array of cursors, representing the set of overridden 22369f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods. If there are no overridden methods, the pointee will be 22379f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * set to NULL. The pointee must be freed via a call to 22389f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \c clang_disposeOverriddenCursors(). 22399f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 22409f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param num_overridden A pointer to the number of overridden 22419f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * functions, will be set to the number of overridden functions in the 22429f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * array pointed to by \p overridden. 22439f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 22449f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor, 22459f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor CXCursor **overridden, 22469f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor unsigned *num_overridden); 22479f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 22489f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 22499f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Free the set of overridden cursors returned by \c 22509f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * clang_getOverriddenCursors(). 22519f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 22529f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden); 22539f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 225445e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 2255ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * \brief Retrieve the file that is included by the given inclusion directive 2256ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * cursor. 2257ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor */ 2258ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas GregorCINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor); 2259ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor 2260ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor/** 2261c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2262c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 22631efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2264c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2265c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code 2266c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2267c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors represent a location within the Abstract Syntax Tree (AST). These 2268c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines help map between cursors and the physical locations where the 2269c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * described entities occur in the source code. The mapping is provided in 2270c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * both directions, so one can map from source code to the AST and back. 2271c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2272c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 227350398199fb10e196a8d92fbf7a062dbe42ed88fdSteve Naroff */ 22741efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 22756a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff/** 2276b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Map a source location to the cursor that describes the entity at that 2277b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * location in the source code. 2278b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 2279b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() maps an arbitrary source location within a translation 2280b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * unit down to the most specific cursor that describes the entity at that 22811efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * location. For example, given an expression \c x + y, invoking 2282b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() with a source location pointing to "x" will return the 22831efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * cursor for "x"; similarly for "y". If the cursor points anywhere between 2284b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor() 2285b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * will return a cursor referring to the "+" expression. 2286b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 2287b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns a cursor representing the entity at the given source location, or 2288b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * a NULL cursor if no such entity can be found. 22896a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff */ 2290b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation); 22911efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 229298258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor/** 229398258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * \brief Retrieve the physical location of the source constructor referenced 229498258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * by the given cursor. 229598258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * 229698258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * The location of a declaration is typically the location of the name of that 22971efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * declaration, where the name of that declaration would occur if it is 22981efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unnamed, or some keyword that introduces that particular declaration. 22991efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The location of a reference is where that reference occurs within the 230098258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * source code. 230198258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor */ 230298258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor); 2303c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2304b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor/** 2305b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Retrieve the physical extent of the source construct referenced by 2306a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the given cursor. 2307a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * 2308a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * The extent of a cursor starts with the file/line/column pointing at the 2309a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * first character within the source construct that the cursor refers to and 23101efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * ends with the last character withinin that source construct. For a 2311a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * declaration, the extent covers the declaration itself. For a reference, 2312a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the extent covers the location of the reference (e.g., where the referenced 2313a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * entity was actually used). 2314a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor */ 2315a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas GregorCINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor); 2316c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor 2317c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2318c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2319c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 232095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 2321c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 23228e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \defgroup CINDEX_TYPES Type information for CXCursors 23238e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 23248e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @{ 23258e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23268e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23278e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 23288e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Describes the kind of type 23298e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23308e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenekenum CXTypeKind { 23318e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 23328e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Reprents an invalid type (e.g., where no type is available). 23338e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23348e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Invalid = 0, 23358e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23368e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 23378e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief A type whose specific kind is not exposed via this 23388e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * interface. 23398e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23408e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Unexposed = 1, 23418e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23428e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /* Builtin types */ 23438e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Void = 2, 23448e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Bool = 3, 23458e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_U = 4, 23468e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UChar = 5, 23478e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char16 = 6, 23488e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char32 = 7, 23498e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UShort = 8, 23508e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt = 9, 23518e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULong = 10, 23528e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULongLong = 11, 23538e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt128 = 12, 23548e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_S = 13, 23558e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_SChar = 14, 23568e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_WChar = 15, 23578e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Short = 16, 23588e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int = 17, 23598e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Long = 18, 23608e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongLong = 19, 23618e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int128 = 20, 23628e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Float = 21, 23638e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Double = 22, 23648e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongDouble = 23, 23658e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_NullPtr = 24, 23668e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Overload = 25, 23678e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Dependent = 26, 23688e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCId = 27, 23698e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCClass = 28, 23708e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCSel = 29, 23718e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_FirstBuiltin = CXType_Void, 23728e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LastBuiltin = CXType_ObjCSel, 23738e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23748e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Complex = 100, 23758e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Pointer = 101, 23768e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_BlockPointer = 102, 23778e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LValueReference = 103, 23788e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_RValueReference = 104, 23798e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Record = 105, 23808e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Enum = 106, 23818e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Typedef = 107, 23828e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCInterface = 108, 238304c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_ObjCObjectPointer = 109, 238404c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_FunctionNoProto = 110, 23855f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis CXType_FunctionProto = 111, 23865f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis CXType_ConstantArray = 112 23878e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek}; 23888e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23898e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 23908e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief The type of an element in the abstract syntax tree. 23918e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 23928e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 23938e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenektypedef struct { 23948e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek enum CXTypeKind kind; 23958e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek void *data[2]; 23968e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek} CXType; 23978e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 23988e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 23998e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the type of a CXCursor (if any). 24008e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 24018e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCursorType(CXCursor C); 24028e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 24038e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 24048e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \determine Determine whether two CXTypes represent the same type. 24058e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 24068e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \returns non-zero if the CXTypes represent the same type and 24078e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek zero otherwise. 24088e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 24098e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B); 24108e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 24118e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 24128e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the canonical type for a CXType. 24138e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 24148e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * Clang's type system explicitly models typedefs and all the ways 24158e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * a specific type can be represented. The canonical type is the underlying 24168e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * type with all the "sugar" removed. For example, if 'T' is a typedef 24178e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * for 'int', the canonical type for 'T' would be 'int'. 24188e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 24198e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCanonicalType(CXType T); 24208e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 24218e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 2422e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * \determine Determine whether a CXType has the "const" qualifier set, 2423e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * without looking through typedefs that may have added "const" at a different level. 2424e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 2425e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T); 2426e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 2427e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 2428e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * \determine Determine whether a CXType has the "volatile" qualifier set, 2429e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * without looking through typedefs that may have added "volatile" at a different level. 2430e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 2431e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T); 2432e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 2433e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 2434e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * \determine Determine whether a CXType has the "restrict" qualifier set, 2435e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor * without looking through typedefs that may have added "restrict" at a different level. 2436e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 2437e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T); 2438e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 2439e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 24408e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief For pointer types, returns the type of the pointee. 24418e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 24428e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 24438e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getPointeeType(CXType T); 24448e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 24458e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 24468e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the cursor for the declaration of the given type. 24478e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 24488e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T); 24498e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 24505389f48b24937ad7b4093307128b3cbf25235654David Chisnall/** 24515389f48b24937ad7b4093307128b3cbf25235654David Chisnall * Returns the Objective-C type encoding for the specified declaration. 24525389f48b24937ad7b4093307128b3cbf25235654David Chisnall */ 24535389f48b24937ad7b4093307128b3cbf25235654David ChisnallCINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C); 24548e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 24558e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 24568e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the spelling of a given CXTypeKind. 24578e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 24588e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K); 24598e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 24608e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 24619a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * \brief Retrieve the result type associated with a function type. 246204c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek */ 246304c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted KremenekCINDEX_LINKAGE CXType clang_getResultType(CXType T); 246404c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek 246504c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek/** 24669a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * \brief Retrieve the result type associated with a given cursor. This only 24679a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * returns a valid type of the cursor refers to a function or method. 24689a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek */ 24699a140845438c2fc31e7d48a6dedbc695f4c83c68Ted KremenekCINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C); 24709a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek 24719a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek/** 24723ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * \brief Return 1 if the CXType is a POD (plain old data) type, and 0 24733ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * otherwise. 24743ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek */ 24753ce9e7d270e7df86c09c8126b4412d55be7c123bTed KremenekCINDEX_LINKAGE unsigned clang_isPODType(CXType T); 24763ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek 24773ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek/** 24785f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * \brief Return the element type of an array type. 24795f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * 24805f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * If a non-array type is passed in, an invalid type is returned. 24815f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis */ 24825f0bfc522266f3319c4a6262b016a552de058c7fArgyrios KyrtzidisCINDEX_LINKAGE CXType clang_getArrayElementType(CXType T); 24835f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis 24845f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis/** 24855f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * \brief Return the the array size of a constant array. 24865f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * 24875f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * If a non-array type is passed in, -1 is returned. 24885f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis */ 24895f0bfc522266f3319c4a6262b016a552de058c7fArgyrios KyrtzidisCINDEX_LINKAGE long long clang_getArraySize(CXType T); 24905f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis 24915f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis/** 24923064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns 1 if the base class specified by the cursor with kind 24933064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * CX_CXXBaseSpecifier is virtual. 24943064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 24953064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor); 24963064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 24973064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 24983064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Represents the C++ access control level to a base class for a 24993064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * cursor with kind CX_CXXBaseSpecifier. 25003064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 25013064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenekenum CX_CXXAccessSpecifier { 25023064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXInvalidAccessSpecifier, 25033064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPublic, 25043064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXProtected, 25053064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPrivate 25063064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek}; 25073064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 25083064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 25093064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns the access control level for the C++ base specifier 25102dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis * represented by a cursor with kind CXCursor_CXXBaseSpecifier or 25112dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis * CXCursor_AccessSpecifier. 25123064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 25133064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor); 25143064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 25153064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 25161f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Determine the number of overloaded declarations referenced by a 25171f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c CXCursor_OverloadedDeclRef cursor. 25181f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 25191f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 25201f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 25211f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns The number of overloaded declarations referenced by \c cursor. If it 25221f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0. 25231f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 25241f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor); 25251f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 25261f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 25271f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Retrieve a cursor for one of the overloaded declarations referenced 25281f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * by a \c CXCursor_OverloadedDeclRef cursor. 25291f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 25301f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 25311f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 25321f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param index The zero-based index into the set of overloaded declarations in 25331f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * the cursor. 25341f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 25351f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns A cursor representing the declaration referenced by the given 25361f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c cursor at the specified \c index. If the cursor does not have an 25371f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * associated set of overloaded declarations, or if the index is out of bounds, 25381f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * returns \c clang_getNullCursor(); 25391f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 25401f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor, 25411f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor unsigned index); 25421f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 25431f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 25448e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @} 25458e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 254695f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 254795f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 2548ad72f4dad4cf0fd2b71eb8f4704d2fe7ac58fb44Ted Kremenek * \defgroup CINDEX_ATTRIBUTES Information for attributes 254995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 255095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @{ 255195f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 255295f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 255395f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 255495f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 255595f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * \brief For cursors representing an iboutletcollection attribute, 255695f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * this function returns the collection element type. 255795f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 255895f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 255995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted KremenekCINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor); 256095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 256195f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 256295f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @} 256395f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 25648e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 25658e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 2566c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors 2567c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2568c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines provide the ability to traverse the abstract syntax tree 2569c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * using cursors. 2570c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2571c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2572c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 25731efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2574c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2575c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes how the traversal of the children of a particular 2576c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor should proceed after visiting a particular child cursor. 2577c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2578c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A value of this enumeration type should be returned by each 2579c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXCursorVisitor to indicate how clang_visitChildren() proceed. 2580c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2581c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXChildVisitResult { 2582c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 25831efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Terminates the cursor traversal. 2584c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2585c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Break, 25861efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 2587c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Continues the cursor traversal with the next sibling of 2588c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the cursor just visited, without visiting its children. 2589c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2590c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Continue, 2591c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 2592c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Recursively traverse the children of this cursor, using 2593c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the same visitor and client data. 2594c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2595c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Recurse 2596c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 2597c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2598c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2599c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visitor invoked for each cursor found by a traversal. 2600c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2601c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This visitor function will be invoked for each cursor found by 2602c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). Its first argument is the cursor being 2603c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited, its second argument is the parent visitor for that cursor, 2604c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and its third argument is the client data provided to 2605c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). 2606c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2607c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The visitor should return one of the \c CXChildVisitResult values 2608c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to direct clang_visitCursorChildren(). 2609c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 26101efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbartypedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor, 26111efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor parent, 2612c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 2613c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2614c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2615c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visit the children of a particular cursor. 2616c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2617c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This function visits all the direct children of the given cursor, 2618c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * invoking the given \p visitor function with the cursors of each 2619c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited child. The traversal may be recursive, if the visitor returns 2620c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if 2621c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the visitor returns \c CXChildVisit_Break. 2622c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2623c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param parent the cursor whose child may be visited. All kinds of 2624a57259e9d7b30bcce93f0a62eee0488738026172Daniel Dunbar * cursors can be visited, including invalid cursors (which, by 2625c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * definition, have no children). 2626c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2627c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param visitor the visitor function that will be invoked for each 2628c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * child of \p parent. 2629c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2630c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param client_data pointer data supplied by the client, which will 2631c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be passed to the visitor each time it is invoked. 2632c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2633c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \returns a non-zero value if the traversal was terminated 2634c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * prematurely by the visitor returning \c CXChildVisit_Break. 2635c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 26361efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent, 2637c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursorVisitor visitor, 2638c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 26393387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#ifdef __has_feature 26403387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# if __has_feature(blocks) 26413387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 26423387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * \brief Visitor invoked for each cursor found by a traversal. 26433387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 26443387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * This visitor block will be invoked for each cursor found by 26453387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * clang_visitChildrenWithBlock(). Its first argument is the cursor being 26463387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * visited, its second argument is the parent visitor for that cursor. 26473387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 26483387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * The visitor should return one of the \c CXChildVisitResult values 26493387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * to direct clang_visitChildrenWithBlock(). 26503387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 26513387c65a094a02b2a94c05111d035a97d3d5c794David Chisnalltypedef enum CXChildVisitResult 26523387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent); 26533387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall 26543387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 26553387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * Visits the children of a cursor using the specified block. Behaves 26563387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * identically to clang_visitChildren() in all other respects. 26573387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 26583387c65a094a02b2a94c05111d035a97d3d5c794David Chisnallunsigned clang_visitChildrenWithBlock(CXCursor parent, 26593387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall CXCursorVisitorBlock block); 26603387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# endif 26613387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#endif 26621efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2663c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2664c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2665c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 26661efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2667c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2668c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST 2669c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 26701efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * These routines provide the ability to determine references within and 2671c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * across translation units, by providing the names of the entities referenced 2672c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by cursors, follow reference cursors to the declarations they reference, 2673c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and associate declarations with their definitions. 2674c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2675c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2676c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 26771efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2678c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2679c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced 2680c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by the given cursor. 2681c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2682c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A Unified Symbol Resolution (USR) is a string that identifies a particular 2683c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * entity (function, class, variable, etc.) within a program. USRs can be 2684c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * compared across translation units to determine, e.g., when references in 2685c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * one translation refer to an entity defined in another translation unit. 2686c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2687c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor); 2688c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2689c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2690896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C class. 2691896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2692896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name); 2693896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2694896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2695896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C category. 2696896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2697896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 269866ccaec73706f3623d2e7d191fe2c944feedcc2bTed Kremenek clang_constructUSR_ObjCCategory(const char *class_name, 2699896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek const char *category_name); 2700896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2701896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2702896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C protocol. 2703896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2704896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 2705896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek clang_constructUSR_ObjCProtocol(const char *protocol_name); 2706896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2707896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2708896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2709896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C instance variable and 2710896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 2711896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2712896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name, 2713896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2714896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2715896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2716896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C method and 2717896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 2718896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2719896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name, 2720896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek unsigned isInstanceMethod, 2721896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2722896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2723896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2724896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C property and the USR 2725896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * for its containing class. 2726896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2727896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property, 2728896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 2729896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2730896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 2731c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a name for the entity referenced by this cursor. 2732c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2733c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor); 2734c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2735358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor/** 2736358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * \brief Retrieve the display name for the entity referenced by this cursor. 2737358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * 2738358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * The display name contains extra information that helps identify the cursor, 2739358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * such as the parameters of a function or template or the arguments of a 2740358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * class template specialization. 2741358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor */ 2742358559d8d7b458c5f64941842383a16e61f0828dDouglas GregorCINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor); 2743358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor 2744c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor/** \brief For a cursor that is a reference, retrieve a cursor representing the 2745c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * entity that it references. 2746c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * 2747c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Reference cursors refer to other entities in the AST. For example, an 2748c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Objective-C superclass reference cursor refers to an Objective-C class. 27491efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * This function produces the cursor for the Objective-C class from the 2750c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * cursor for the superclass reference. If the input cursor is a declaration or 2751c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * definition, it returns that declaration or definition unchanged. 27521efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Otherwise, returns the NULL cursor. 2753c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor */ 2754c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor); 2755b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 27561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 2757b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief For a cursor that is either a reference to or a declaration 2758b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * of some entity, retrieve a cursor that describes the definition of 2759b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that entity. 2760b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2761b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * Some entities can be declared multiple times within a translation 2762b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * unit, but only one of those declarations can also be a 2763b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * definition. For example, given: 2764b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2765b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \code 2766b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 2767b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int g(int x, int y) { return f(x, y); } 2768b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int a, int b) { return a + b; } 2769b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 2770b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \endcode 2771b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2772b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * there are three declarations of the function "f", but only the 2773b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * second one is a definition. The clang_getCursorDefinition() 2774b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * function will take any cursor pointing to a declaration of "f" 2775b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * (the first or fourth lines of the example) or a cursor referenced 2776b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that uses "f" (the call to "f' inside "g") and will return a 2777b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration cursor pointing to the definition (the second "f" 2778b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration). 2779b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 2780b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * If given a cursor for which there is no corresponding definition, 2781b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * e.g., because there is no definition of that entity within this 2782b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * translation unit, returns a NULL cursor. 2783b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 2784b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor); 2785b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 27861efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 2787b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Determine whether the declaration pointed to by this cursor 2788b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * is also a definition of that entity. 2789b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 2790b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor); 2791b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 2792c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 27931a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \brief Retrieve the canonical cursor corresponding to the given cursor. 27941a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 27951a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * In the C family of languages, many kinds of entities can be declared several 27961a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * times within a single translation unit. For example, a structure type can 27971a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * be forward-declared (possibly multiple times) and later defined: 27981a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 27991a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \code 28001a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X; 28011a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X; 28021a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X { 28031a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * int member; 28041a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * }; 28051a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \endcode 28061a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 28071a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * The declarations and the definition of \c X are represented by three 28081a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * different cursors, all of which are declarations of the same underlying 28091a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * entity. One of these cursor is considered the "canonical" cursor, which 28101a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * is effectively the representative for the underlying entity. One can 28111a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * determine if two cursors are declarations of the same underlying entity by 28121a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * comparing their canonical cursors. 28131a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 28141a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \returns The canonical cursor for the entity referred to by the given cursor. 28151a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor */ 28161a9d0503b67a499797141af0fd6d315d5045f0eaDouglas GregorCINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor); 28171a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor 28181a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor/** 2819c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2820c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 28211efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2822c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 28239ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * \defgroup CINDEX_CPP C++ AST introspection 28249ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 28259ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * The routines in this group provide access information in the ASTs specific 28269ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * to C++ language features. 28279ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 28289ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @{ 28299ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 28309ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 28319ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 283249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Determine if a C++ member function or member function template is 283349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared 'static'. 28349ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 28359ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed KremenekCINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C); 28369ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 28379ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 2838211924b563aa31421836cee7655be729ad02733fDouglas Gregor * \brief Determine if a C++ member function or member function template is 2839211924b563aa31421836cee7655be729ad02733fDouglas Gregor * explicitly declared 'virtual' or if it overrides a virtual method from 2840211924b563aa31421836cee7655be729ad02733fDouglas Gregor * one of the base classes. 2841211924b563aa31421836cee7655be729ad02733fDouglas Gregor */ 2842211924b563aa31421836cee7655be729ad02733fDouglas GregorCINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C); 2843211924b563aa31421836cee7655be729ad02733fDouglas Gregor 2844211924b563aa31421836cee7655be729ad02733fDouglas Gregor/** 284549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Given a cursor that represents a template, determine 284649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the cursor kind of the specializations would be generated by instantiating 284749f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the template. 284849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 284949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * This routine can be used to determine what flavor of function template, 285049f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * class template, or class template partial specialization is stored in the 285149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * cursor. For example, it can describe whether a class template cursor is 285249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared with "struct", "class" or "union". 285349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 285449f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \param C The cursor to query. This cursor should represent a template 285549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declaration. 285649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 285749f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \returns The cursor kind of the specializations that would be generated 285849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * by instantiating the template \p C. If \p C is not a template, returns 285949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \c CXCursor_NoDeclFound. 286049f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor */ 286149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C); 286249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor 286349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor/** 2864e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \brief Given a cursor that may represent a specialization or instantiation 2865e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template, retrieve the cursor that represents the template that it 2866e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializes or from which it was instantiated. 2867e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2868e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * This routine determines the template involved both for explicit 2869e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializations of templates and for implicit instantiations of the template, 2870e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * both of which are referred to as "specializations". For a class template 2871e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specialization (e.g., \c std::vector<bool>), this routine will return 2872e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * either the primary template (\c std::vector) or, if the specialization was 2873e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * instantiated from a class template partial specialization, the class template 2874e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * partial specialization. For a class template partial specialization and a 2875e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * function template specialization (including instantiations), this 2876e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * this routine will return the specialized template. 2877e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2878e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * For members of a class template (e.g., member functions, member classes, or 2879e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * static data members), returns the specialized or instantiated member. 2880e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * Although not strictly "templates" in the C++ language, members of class 2881e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates have the same notions of specializations and instantiations that 2882e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates do, so this routine treats them similarly. 2883e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2884e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \param C A cursor that may be a specialization of a template or a member 2885e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template. 2886e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 2887e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \returns If the given cursor is a specialization or instantiation of a 2888e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * template or a member thereof, the template or member that it specializes or 2889e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * from which it was instantiated. Otherwise, returns a NULL cursor. 2890e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor */ 2891e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas GregorCINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C); 2892430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 2893430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor/** 2894430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Given a cursor that references something else, return the source range 2895430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * covering that reference. 2896430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 2897430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param C A cursor pointing to a member reference, a declaration reference, or 2898430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * an operator call. 2899430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param NameFlags A bitset with three independent flags: 2900430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and 2901430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantSinglePiece. 2902430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param PieceIndex For contiguous names or when passing the flag 2903430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantSinglePiece, only one piece with index 0 is 2904430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * available. When the CXNameRange_WantSinglePiece flag is not passed for a 2905430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * non-contiguous names, this index can be used to retreive the individual 2906430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * pieces of the name. See also CXNameRange_WantSinglePiece. 2907430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 2908430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \returns The piece of the name pointed to by the given cursor. If there is no 2909430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * name, or if the PieceIndex is out-of-range, a null-cursor will be returned. 2910430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 291148a8d14fc6f064a5297024c2b34733a4080b2efeFrancois PichetCINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, 291248a8d14fc6f064a5297024c2b34733a4080b2efeFrancois Pichet unsigned NameFlags, 2913430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor unsigned PieceIndex); 2914430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 2915430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregorenum CXNameRefFlags { 2916430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 2917430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the 2918430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * range. 2919430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 2920430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantQualifier = 0x1, 2921430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 2922430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 2923430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Include the explicit template arguments, e.g. <int> in x.f<int>, in 2924430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * the range. 2925430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 2926430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantTemplateArgs = 0x2, 2927430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 2928430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 2929430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief If the name is non-contiguous, return the full spanning range. 2930430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 2931430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * Non-contiguous names occur in Objective-C when a selector with two or more 2932430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * parameters is used, or in C++ when using an operator: 2933430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \code 2934430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * [object doSomething:here withValue:there]; // ObjC 2935430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * return some_vector[1]; // C++ 2936430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \endcode 2937430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 2938430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantSinglePiece = 0x4 2939430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor}; 2940e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor 2941e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor/** 29429ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @} 29439ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 29449ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 29459ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 29460045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \defgroup CINDEX_LEX Token extraction and manipulation 29470045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 29480045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * The routines in this group provide access to the tokens within a 29490045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * translation unit, along with a semantic mapping of those tokens to 29500045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * their corresponding cursors. 2951fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 2952fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @{ 2953fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2954fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2955fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2956fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a kind of token. 2957fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2958fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef enum CXTokenKind { 2959fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2960fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A token that contains some kind of punctuation. 2961fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2962fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Punctuation, 2963896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2964fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 29650045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \brief A language keyword. 2966fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2967fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Keyword, 2968896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2969fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2970fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief An identifier (that is not a keyword). 2971fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2972fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Identifier, 2973896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2974fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2975fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A numeric, string, or character literal. 2976fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2977fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Literal, 2978896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2979fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 2980fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A comment. 2981fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2982fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Comment 2983fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXTokenKind; 2984fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2985fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2986fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a single preprocessing token. 2987fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2988fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef struct { 2989fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor unsigned int_data[4]; 2990fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor void *ptr_data; 2991fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXToken; 2992fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 2993fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2994fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the kind of the given token. 2995fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 2996fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken); 2997896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 2998fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 2999fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the spelling of the given token. 3000fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3001fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * The spelling of a token is the textual representation of that token, e.g., 3002fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * the text of an identifier or keyword. 3003fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3004fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken); 3005896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3006fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3007fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve the source location of the given token. 3008fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3009896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit, 3010fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken); 3011896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3012fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3013fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve a source range that covers the given token. 3014fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3015fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken); 3016fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 3017fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3018fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Tokenize the source code described by the given range into raw 3019fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * lexical tokens. 3020fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3021fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit whose text is being tokenized. 3022fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3023fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Range the source range in which text should be tokenized. All of the 3024fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * tokens produced by tokenization will fall within this source range, 3025fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3026fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens this pointer will be set to point to the array of tokens 3027fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that occur within the given source range. The returned pointer must be 3028fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * freed with clang_disposeTokens() before the translation unit is destroyed. 3029fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3030fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens will be set to the number of tokens in the \c *Tokens 3031fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * array. 3032fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3033fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3034fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range, 3035fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken **Tokens, unsigned *NumTokens); 3036896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3037fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3038fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Annotate the given set of tokens by providing cursors for each token 3039fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that can be mapped to a specific entity within the abstract syntax tree. 3040fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 30410045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * This token-annotation routine is equivalent to invoking 30420045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() for the source locations of each of the 30430045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * tokens. The cursors provided are filtered, so that only those 30440045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * cursors that have a direct correspondence to the token are 30450045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * accepted. For example, given a function call \c f(x), 30460045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() would provide the following cursors: 30470045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 30480045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'. 30490045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'. 30500045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'. 30510045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 30520045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * Only the first and last of these cursors will occur within the 30530045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * annotate, since the tokens "f" and "x' directly refer to a function 30540045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * and a variable, respectively, but the parentheses are just a small 30550045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * part of the full syntax of the function call expression, which is 30560045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * not provided as an annotation. 3057fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3058fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit that owns the given tokens. 3059fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3060fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens the set of tokens to annotate. 3061fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3062fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens the number of tokens in \p Tokens. 3063fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3064fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Cursors an array of \p NumTokens cursors, whose contents will be 3065fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * replaced with the cursors corresponding to each token. 3066fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3067fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU, 3068fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens, 3069fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXCursor *Cursors); 3070896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3071fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3072fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Free the given set of tokens. 3073fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3074896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU, 3075fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens); 3076896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3077fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3078fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @} 3079fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3080896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3081fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3082c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_DEBUG Debugging facilities 3083c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3084c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines are used for testing and debugging, only, and should not 3085c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be relied upon. 3086c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3087c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 3088c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 30891efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 30904ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff/* for debug/testing */ 3091e68fff6fc083c6270d835216a3de0b82c6ef0310Ted KremenekCINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind); 30921efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor, 30931efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar const char **startBuf, 30944ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff const char **endBuf, 30954ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startLine, 30964ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startColumn, 30974ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endLine, 30984ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endColumn); 30990a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE void clang_enableStackTraces(void); 3100995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel DunbarCINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data, 3101995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar unsigned stack_size); 3102995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar 31030c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 3104c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 3105c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 31061efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 3107c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 3108c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CODE_COMPLET Code completion 3109c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3110c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Code completion involves taking an (incomplete) source file, along with 3111c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * knowledge of where the user is actively editing that file, and suggesting 3112c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * syntactically- and semantically-valid constructs that the user might want to 3113c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * use at that particular point in the source code. These data structures and 3114c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines provide support for code completion. 3115c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3116c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 3117c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 31181efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 3119c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 31200c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A semantic string that describes a code-completion result. 31210c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31220c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A semantic string that describes the formatting of a code-completion 31230c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * result as a single "template" of text that should be inserted into the 31240c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * source buffer when a particular code-completion result is selected. 31250c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * Each semantic string is made up of some number of "chunks", each of which 31260c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * contains some text along with a description of what that text means, e.g., 31270c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the name of the entity being referenced, whether the text chunk is part of 31280c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the template, or whether it is a "placeholder" that the user should replace 31290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * with actual code,of a specific kind. See \c CXCompletionChunkKind for a 31301efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * description of the different kinds of chunks. 31310c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31320c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef void *CXCompletionString; 31331efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 31340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 31350c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A single result of code completion. 31360c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31370c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef struct { 31380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 31391efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief The kind of entity that this completion refers to. 31400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31411efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor kind will be a macro, keyword, or a declaration (one of the 31420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * *Decl cursor kinds), describing the entity that the completion is 31430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to. 31440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \todo In the future, we would like to provide a full cursor, to allow 31460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the client to extract additional information from declaration. 31470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor enum CXCursorKind CursorKind; 31491efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 31501efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 31510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief The code-completion string that describes how to insert this 31520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion result into the editing buffer. 31530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionString CompletionString; 31550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor} CXCompletionResult; 31560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 31570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 31580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Describes a single piece of text within a code-completion string. 31590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31601efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Each "chunk" within a code-completion string (\c CXCompletionString) is 31611efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * either a piece of text with a specific "kind" that describes how that text 31620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * should be interpreted by the client or is another completion string. 31630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorenum CXCompletionChunkKind { 31650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 31660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A code-completion string that describes "optional" text that 31670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * could be a part of the template (but is not required). 31680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The Optional chunk is the only kind of chunk that has a code-completion 31701efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * string for its representation, which is accessible via 31710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \c clang_getCompletionChunkCompletionString(). The code-completion string 31720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * describes an additional part of the template that is completely optional. 31730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * For example, optional chunks can be used to describe the placeholders for 31740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * arguments that match up with defaulted function parameters, e.g. given: 31750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 31770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * void f(int x, float y = 3.14, double z = 2.71828); 31780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 31790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 31800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The code-completion string for this function would contain: 31810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a TypedText chunk for "f". 31820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a LeftParen chunk for "(". 31830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "int x" 31840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the remaining defaulted arguments, e.g., 31850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 318671570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * - a Placeholder chunk for "float y" 31870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the last defaulted argument: 31880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 31890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "double z" 31900c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a RightParen chunk for ")" 31910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 319271570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * There are many ways to handle Optional chunks. Two simple approaches are: 31930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Completely ignore optional chunks, in which case the template for the 31940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would only include the first parameter ("int x"). 31950c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Fully expand all optional chunks, in which case the template for the 31960c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would have all of the parameters. 31970c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 31980c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Optional, 31990c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32000c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that a user would be expected to type to get this 32011efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * code-completion result. 32020c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32031efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * There will be exactly one "typed text" chunk in a semantic string, which 32041efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * will typically provide the spelling of a keyword or the name of a 32050c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * declaration that could be used at the current code point. Clients are 32060c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * expected to filter the code-completion results based on the text in this 32070c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * chunk. 32080c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32090c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_TypedText, 32100c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32110c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that should be inserted as part of a code-completion result. 32120c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32130c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "text" chunk represents text that is part of the template to be 32140c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * inserted into user code should this particular code-completion result 32150c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * be selected. 32160c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32170c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Text, 32180c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32190c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Placeholder text that should be replaced by the user. 32200c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32210c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "placeholder" chunk marks a place where the user should insert text 32220c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * into the code-completion template. For example, placeholders might mark 32230c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the function parameters for a function declaration, to indicate that the 32240c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * user should provide arguments for each of those parameters. The actual 32250c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * text in a placeholder is a suggestion for the text to display before 32260c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the user replaces the placeholder with real code. 32270c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32280c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Placeholder, 32290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32300c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Informative text that should be displayed but never inserted as 32310c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * part of the template. 32321efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 32330c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * An "informative" chunk contains annotations that can be displayed to 32340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * help the user decide whether a particular code-completion result is the 32350c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * right option, but which is not part of the actual template to be inserted 32360c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * by code completion. 32370c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Informative, 32390c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that describes the current parameter when code-completion is 32410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to function call, message send, or template specialization. 32420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "current parameter" chunk occurs when code-completion is providing 32440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * information about a parameter corresponding to the argument at the 32450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion point. For example, given a function 32460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 32480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * int add(int x, int y); 32490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 32500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 32510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * and the source code \c add(, where the code-completion point is after the 32520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "(", the code-completion string will contain a "current parameter" chunk 32530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * for "int x", indicating that the current argument will initialize that 32540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * parameter. After typing further, to \c add(17, (where the code-completion 32551efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * point is after the ","), the code-completion string will contain a 32560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "current paremeter" chunk to "int y". 32570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_CurrentParameter, 32590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left parenthesis ('('), used to initiate a function call or 32610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the beginning of a function parameter list. 32620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftParen, 32640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right parenthesis (')'), used to finish a function call or 32660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the end of a function parameter list. 32670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightParen, 32690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left bracket ('['). 32710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBracket, 32730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right bracket (']'). 32750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBracket, 32770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left brace ('{'). 32790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBrace, 32810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right brace ('}'). 32830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBrace, 32850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left angle bracket ('<'). 32870c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftAngle, 32890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32900c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right angle bracket ('>'). 32910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 32920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightAngle, 32930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 32940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A comma separator (','). 32950c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 3296ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor CXCompletionChunk_Comma, 3297ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor /** 32981efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Text that specifies the result type of a given result. 3299ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * 3300ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * This special kind of informative chunk is not meant to be inserted into 33011efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * the text buffer. Rather, it is meant to illustrate the type that an 3302ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * expression using the given completion string would have. 3303ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor */ 330401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_ResultType, 330501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 330601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A colon (':'). 330701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 330801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Colon, 330901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 331001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A semicolon (';'). 331101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 331201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_SemiColon, 331301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 331401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief An '=' sign. 331501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 331601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Equal, 331701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 331801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Horizontal space (' '). 331901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 332001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_HorizontalSpace, 332101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 332201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Vertical space ('\n'), after which it is generally a good idea to 332301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * perform indentation. 332401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 332501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_VerticalSpace 33260c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor}; 33271efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 33280c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 33290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Determine the kind of a particular chunk within a completion string. 33300c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33310c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 33320c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33330c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 33340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33350c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the kind of the chunk at the index \c chunk_number. 33360c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33371efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE enum CXCompletionChunkKind 33380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkKind(CXCompletionString completion_string, 33390c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 33401efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 33410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 33421efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the text associated with a particular chunk within a 33430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * completion string. 33440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 33460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 33480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the text associated with the chunk at index \c chunk_number. 33500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33512ef6f8f5a35a60870594c5b04e0aa2bf22c6886fTed KremenekCINDEX_LINKAGE CXString 33520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkText(CXCompletionString completion_string, 33530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 33540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 33550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 33561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the completion string associated with a particular chunk 33570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * within a completion string. 33580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 33600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 33620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 33630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the completion string associated with the chunk at index 33646164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \c chunk_number. 33650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE CXCompletionString 33670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkCompletionString(CXCompletionString completion_string, 33680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 33691efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 33700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 33710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Retrieve the number of chunks in the given code-completion string. 33720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 33730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE unsigned 33740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getNumCompletionChunks(CXCompletionString completion_string); 33750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 33760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 337712e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \brief Determine the priority of this code completion. 337812e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 337912e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * The priority of a code completion indicates how likely it is that this 338012e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * particular completion is the completion that the user will select. The 338112e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * priority is selected by various internal heuristics. 338212e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 338312e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \param completion_string The completion string to query. 338412e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 338512e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \returns The priority of this completion string. Smaller values indicate 338612e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * higher-priority (more likely) completions. 338712e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor */ 338812e131385e892e3723483a1081a89bcad29c8a84Douglas GregorCINDEX_LINKAGE unsigned 338912e131385e892e3723483a1081a89bcad29c8a84Douglas Gregorclang_getCompletionPriority(CXCompletionString completion_string); 339012e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor 339112e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor/** 339258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \brief Determine the availability of the entity that this code-completion 339358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * string refers to. 339458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 339558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param completion_string The completion string to query. 339658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 339758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the completion string. 339858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 339958ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 340058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCompletionAvailability(CXCompletionString completion_string); 340158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 340258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 34036164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \brief Retrieve the number of annotations associated with the given 34046164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * completion string. 34056164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 34066164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \param completion_string the completion string to query. 34076164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 34086164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \returns the number of annotations associated with the given completion 34096164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * string. 34106164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen */ 34116164ea1d75385b6fc3c19e5ab9bb686298436a5aErik VerbruggenCINDEX_LINKAGE unsigned 34126164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggenclang_getCompletionNumAnnotations(CXCompletionString completion_string); 34136164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen 34146164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen/** 34156164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \brief Retrieve the annotation associated with the given completion string. 34166164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 34176164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \param completion_string the completion string to query. 34186164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 34196164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \param annotation_number the 0-based index of the annotation of the 34206164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * completion string. 34216164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 34226164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \returns annotation string associated with the completion at index 34236164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \c annotation_number, or a NULL string if that annotation is not available. 34246164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen */ 34256164ea1d75385b6fc3c19e5ab9bb686298436a5aErik VerbruggenCINDEX_LINKAGE CXString 34266164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggenclang_getCompletionAnnotation(CXCompletionString completion_string, 34276164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen unsigned annotation_number); 34286164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen 34296164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen/** 34308fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \brief Retrieve a completion string for an arbitrary declaration or macro 34318fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * definition cursor. 34328fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * 34338fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \param cursor The cursor to query. 34348fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * 34358fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \returns A non-context-sensitive completion string for declaration and macro 34368fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * definition cursors, or NULL for other kinds of cursors. 34378fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor */ 34388fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas GregorCINDEX_LINKAGE CXCompletionString 34398fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregorclang_getCursorCompletionString(CXCursor cursor); 34408fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 34418fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor/** 3442ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Contains the results of code-completion. 3443ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * 3444ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * This data structure contains the results of code completion, as 3445e0cc52ef8afc8d1cba9c534191b5f0ddaff1d694Douglas Gregor * produced by \c clang_codeCompleteAt(). Its contents must be freed by 3446ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c clang_disposeCodeCompleteResults. 3447ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 3448ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregortypedef struct { 3449ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 3450ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The code-completion results. 3451ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 3452ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor CXCompletionResult *Results; 3453ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 3454ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 3455ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The number of code-completion results stored in the 3456ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c Results array. 3457ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 3458ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor unsigned NumResults; 3459ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor} CXCodeCompleteResults; 3460ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 3461ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor/** 3462cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Flags that can be passed to \c clang_codeCompleteAt() to 3463cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * modify its behavior. 3464cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 3465cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * The enumerators in this enumeration can be bitwise-OR'd together to 3466cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * provide multiple options to \c clang_codeCompleteAt(). 3467cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 3468cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregorenum CXCodeComplete_Flags { 3469cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 3470cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include macros within the set of code 3471cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completions returned. 3472cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 3473cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor CXCodeComplete_IncludeMacros = 0x01, 3474cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 3475cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 3476cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include code patterns for language constructs 3477cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * within the set of code completions, e.g., for loops. 3478cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 3479cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor CXCodeComplete_IncludeCodePatterns = 0x02 3480cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor}; 3481cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 3482cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 34833da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Bits that represent the context under which completion is occurring. 34843da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 34853da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * The enumerators in this enumeration may be bitwise-OR'd together if multiple 34863da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * contexts are occurring simultaneously. 34873da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34883da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregorenum CXCompletionContext { 34893da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34903da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief The context for completions is unexposed, as only Clang results 34913da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included. (This is equivalent to having no context bits set.) 34923da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34933da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Unexposed = 0, 34943da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 34953da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 34963da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for any possible type should be included in the results. 34973da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 34983da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_AnyType = 1 << 0, 34993da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 35003da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35013da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for any possible value (variables, function calls, etc.) 35023da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included in the results. 35033da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35043da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_AnyValue = 1 << 1, 35053da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35063da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to an Objective-C object should 35073da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * be included in the results. 35083da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35093da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCObjectValue = 1 << 2, 35103da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35113da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to an Objective-C selector 35123da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included in the results. 35133da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35143da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCSelectorValue = 1 << 3, 35153da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35163da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to a C++ class type should be 35173da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * included in the results. 35183da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35193da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_CXXClassTypeValue = 1 << 4, 35203da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 35213da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35223da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for fields of the member being accessed using the dot 35233da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * operator should be included in the results. 35243da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35253da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_DotMemberAccess = 1 << 5, 35263da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35273da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for fields of the member being accessed using the arrow 35283da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * operator should be included in the results. 35293da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35303da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ArrowMemberAccess = 1 << 6, 35313da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35323da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for properties of the Objective-C object being accessed 35333da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * using the dot operator should be included in the results. 35343da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35353da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCPropertyAccess = 1 << 7, 35363da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 35373da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35383da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for enum tags should be included in the results. 35393da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35403da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_EnumTag = 1 << 8, 35413da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35423da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for union tags should be included in the results. 35433da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35443da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_UnionTag = 1 << 9, 35453da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35463da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for struct tags should be included in the results. 35473da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35483da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_StructTag = 1 << 10, 35493da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 35503da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35513da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ class names should be included in the results. 35523da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35533da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ClassTag = 1 << 11, 35543da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35553da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ namespaces and namespace aliases should be 35563da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * included in the results. 35573da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35583da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Namespace = 1 << 12, 35593da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35603da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ nested name specifiers should be included in 35613da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 35623da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35633da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_NestedNameSpecifier = 1 << 13, 35643da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 35653da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35663da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C interfaces (classes) should be included 35673da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * in the results. 35683da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35693da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCInterface = 1 << 14, 35703da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35713da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C protocols should be included in 35723da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 35733da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35743da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCProtocol = 1 << 15, 35753da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35763da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C categories should be included in 35773da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 35783da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35793da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCCategory = 1 << 16, 35803da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35813da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C instance messages should be included 35823da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * in the results. 35833da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35843da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCInstanceMessage = 1 << 17, 35853da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35863da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C class messages should be included in 35873da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 35883da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35893da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCClassMessage = 1 << 18, 35903da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35913da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C selector names should be included in 35923da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 35933da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 35943da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCSelectorName = 1 << 19, 35953da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 35963da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 35973da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for preprocessor macro names should be included in 35983da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 35993da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36003da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_MacroName = 1 << 20, 36013da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 36023da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36033da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Natural language completions should be included in the results. 36043da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36053da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_NaturalLanguage = 1 << 21, 36063da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 36073da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 36083da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief The current context is unknown, so set all contexts. 36093da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 36103da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Unknown = ((1 << 22) - 1) 36113da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor}; 36123da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 36133da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor/** 3614cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Returns a default set of code-completion options that can be 3615cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * passed to\c clang_codeCompleteAt(). 3616cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 3617cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas GregorCINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void); 3618cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 3619cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 36201abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \brief Perform code completion at a given location in a translation unit. 36211abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 36221abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * This function performs code completion at a particular file, line, and 36231abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * column within source code, providing results that suggest potential 36241abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code snippets based on the context of the completion. The basic model 36251abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * for code completion is that Clang will parse a complete source file, 36261abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * performing syntax checking up to the location where code-completion has 36271abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * been requested. At that point, a special code-completion token is passed 36281abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * to the parser, which recognizes this token and determines, based on the 36291abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * current location in the C/Objective-C/C++ grammar and the state of 36301abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * semantic analysis, what completions to provide. These completions are 36311abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * returned via a new \c CXCodeCompleteResults structure. 36321abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 36331abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Code completion itself is meant to be triggered by the client when the 36341abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * user types punctuation characters or whitespace, at which point the 36351abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code-completion location will coincide with the cursor. For example, if \c p 36361abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is a pointer, code-completion might be triggered after the "-" and then 36371abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * after the ">" in \c p->. When the code-completion location is afer the ">", 36381abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the completion results will provide, e.g., the members of the struct that 36391abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * "p" points to. The client is responsible for placing the cursor at the 36401abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * beginning of the token currently being typed, then filtering the results 36411abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * based on the contents of the token. For example, when code-completing for 36421abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the expression \c p->get, the client should provide the location just after 36431abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the 36441abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client can filter the results based on the current token text ("get"), only 36451abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * showing those results that start with "get". The intent of this interface 36461abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is to separate the relatively high-latency acquisition of code-completion 36471abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * results from the filtering of results on a per-character basis, which must 36481abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * have a lower latency. 36491abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 36501abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param TU The translation unit in which code-completion should 36511abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * occur. The source files for this translation unit need not be 36521abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completely up-to-date (and the contents of those source files may 36531abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * be overridden via \p unsaved_files). Cursors referring into the 36541abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * translation unit may be invalidated by this invocation. 36551abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 36561abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_filename The name of the source file where code 36571abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion should be performed. This filename may be any file 36581abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * included in the translation unit. 36591abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 36601abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_line The line at which code-completion should occur. 36611abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 36621abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_column The column at which code-completion should occur. 36631abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Note that the column should point just after the syntactic construct that 36641abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * initiated code completion, and not in the middle of a lexical token. 36651abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 36661abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param unsaved_files the Tiles that have not yet been saved to disk 36671abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing or code completion, including the 36681abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * contents of those files. The contents and name of these files (as 36691abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * specified by CXUnsavedFile) are copied when necessary, so the 36701abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client only needs to guarantee their validity until the call to 36711abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * this function returns. 36721abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 36731abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 36741abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * unsaved_files. 36751abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 3676cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \param options Extra options that control the behavior of code 3677cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completion, expressed as a bitwise OR of the enumerators of the 3678cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * CXCodeComplete_Flags enumeration. The 3679cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \c clang_defaultCodeCompleteOptions() function returns a default set 3680cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * of code-completion options. 3681cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 36821abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \returns If successful, a new \c CXCodeCompleteResults structure 36831abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * containing code-completion results, which should eventually be 36841abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * freed with \c clang_disposeCodeCompleteResults(). If code 36851abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion fails, returns NULL. 36861abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor */ 36871abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCINDEX_LINKAGE 36881abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU, 36891abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor const char *complete_filename, 36901abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_line, 36911abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_column, 36921abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor struct CXUnsavedFile *unsaved_files, 3693cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned num_unsaved_files, 3694cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned options); 36951abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 36961abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor/** 36971e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \brief Sort the code-completion results in case-insensitive alphabetical 36981e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * order. 36991e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * 37001e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param Results The set of results to sort. 37011e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param NumResults The number of results in \p Results. 37021e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor */ 37031e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas GregorCINDEX_LINKAGE 37041e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregorvoid clang_sortCodeCompletionResults(CXCompletionResult *Results, 37051e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor unsigned NumResults); 37061e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor 37071e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor/** 3708ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Free the given set of code-completion results. 37090c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 37101efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE 3711ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregorvoid clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results); 371258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 371320d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor/** 3714a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced prior to the 3715a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * location where code completion was performed. 3716a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 3717896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 3718a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorunsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results); 3719a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 3720a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 3721a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given code completion. 3722a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 3723a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Result the code completion results to query. 3724a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 3725a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 3726a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 3727a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 3728a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 3729896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 3730a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results, 3731a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 3732a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 3733a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 37343da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Determines what compeltions are appropriate for the context 37353da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the given code completion. 37363da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 37373da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \param Results the code completion results to query 37383da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 37393da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \returns the kinds of completions that are appropriate for use 37403da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * along with the given code completion results. 37413da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 37423da626b4f38eb0350de960d71271ca77af7a9cc8Douglas GregorCINDEX_LINKAGE 37433da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregorunsigned long long clang_codeCompleteGetContexts( 37443da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCodeCompleteResults *Results); 3745e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor 3746e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor/** 3747e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \brief Returns the cursor kind for the container for the current code 3748e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * completion context. The container is only guaranteed to be set for 3749e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * contexts where a container exists (i.e. member accesses or Objective-C 3750e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * message sends); if there is not a container, this function will return 3751e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * CXCursor_InvalidCode. 3752e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3753e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param Results the code completion results to query 3754e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3755e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param IsIncomplete on return, this value will be false if Clang has complete 3756e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * information about the container. If Clang does not have complete 3757e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * information, this value will be true. 3758e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3759e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \returns the container kind, or CXCursor_InvalidCode if there is not a 3760e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * container 3761e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor */ 3762e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCINDEX_LINKAGE 3763e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregorenum CXCursorKind clang_codeCompleteGetContainerKind( 3764e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor CXCodeCompleteResults *Results, 3765e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor unsigned *IsIncomplete); 3766e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor 3767e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor/** 3768e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \brief Returns the USR for the container for the current code completion 3769e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * context. If there is not a container for the current context, this 3770e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * function will return the empty string. 3771e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3772e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param Results the code completion results to query 3773e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 3774e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \returns the USR for the container 3775e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor */ 3776e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCINDEX_LINKAGE 3777e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results); 37783da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 37790a47d69af8bda945352997af3da4687a3356096aDouglas Gregor 37800a47d69af8bda945352997af3da4687a3356096aDouglas Gregor/** 37810a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \brief Returns the currently-entered selector for an Objective-C message 37820a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * send, formatted like "initWithFoo:bar:". Only guaranteed to return a 37830a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * non-empty string for CXCompletionContext_ObjCInstanceMessage and 37840a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * CXCompletionContext_ObjCClassMessage. 37850a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * 37860a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \param Results the code completion results to query 37870a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * 37880a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \returns the selector (or partial selector) that has been entered thus far 37890a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * for an Objective-C message send. 37900a47d69af8bda945352997af3da4687a3356096aDouglas Gregor */ 37910a47d69af8bda945352997af3da4687a3356096aDouglas GregorCINDEX_LINKAGE 37920a47d69af8bda945352997af3da4687a3356096aDouglas GregorCXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results); 37930a47d69af8bda945352997af3da4687a3356096aDouglas Gregor 37943da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor/** 379520d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * @} 379620d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor */ 37971efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 37981efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 379904bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek/** 380004bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * \defgroup CINDEX_MISC Miscellaneous utility functions 380104bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * 380204bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @{ 380304bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 380423e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek 380523e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek/** 380623e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * \brief Return a version string, suitable for showing to a user, but not 380723e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * intended to be parsed (the format is not guaranteed to be stable). 380823e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek */ 3809a2a9d6e4e5b6001b86b7dfc5db1ea296ce29a3d3Ted KremenekCINDEX_LINKAGE CXString clang_getClangVersion(); 381004bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek 3811d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek 3812d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek/** 3813d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * \brief Enable/disable crash recovery. 3814d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * 3815d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * \param Flag to indicate if crash recovery is enabled. A non-zero value 3816d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * enables crash recovery, while 0 disables it. 3817d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek */ 3818d2427ddf00aacdc288c386f3882e0821ca9bd27bTed KremenekCINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled); 3819d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek 382016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek /** 3821896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Visitor invoked for each file in a translation unit 382216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * (used with clang_getInclusions()). 382316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * 382416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * This visitor function will be invoked by clang_getInclusions() for each 382516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * file included (either at the top-level or by #include directives) within 382616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * a translation unit. The first argument is the file being included, and 382716b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the second and third arguments provide the inclusion stack. The 382816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * array is sorted in order of immediate inclusion. For example, 382916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the first element refers to the location that included 'included_file'. 383016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 383116b55a71695a33c094383295cc7b7a2080e098daTed Kremenektypedef void (*CXInclusionVisitor)(CXFile included_file, 383216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXSourceLocation* inclusion_stack, 383316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek unsigned include_len, 383416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 383516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 383616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 383716b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * \brief Visit the set of preprocessor inclusions in a translation unit. 383816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * The visitor function is called with the provided data for every included 383916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * file. This does not include headers included by the PCH file (unless one 384016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * is inspecting the inclusions in the PCH file itself). 384116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 384216b55a71695a33c094383295cc7b7a2080e098daTed KremenekCINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu, 384316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXInclusionVisitor visitor, 384416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 384516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 384616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 384704bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @} 384804bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 38491efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 385097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** \defgroup CINDEX_REMAPPING Remapping functions 385197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 385297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * @{ 385397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 385497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 385597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 385697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief A remapping of original source files and their translated files. 385797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 385897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidistypedef void *CXRemapping; 385997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 386097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 386197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Retrieve a remapping. 386297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 386397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param path the path that contains metadata about remappings. 386497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 386597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \returns the requested remapping. This remapping must be freed 386697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred. 386797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 386897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path); 386997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 387097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 387197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Determine the number of remappings. 387297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 387397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping); 387497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 387597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 387697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Get the original and the associated filename from the remapping. 387797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 387897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param original If non-NULL, will be set to the original filename. 387997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 388097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param transformed If non-NULL, will be set to the filename that the original 388197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * is associated with. 388297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 388397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index, 388497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis CXString *original, CXString *transformed); 388597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 388697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 388797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Dispose the remapping. 388897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 388997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE void clang_remap_dispose(CXRemapping); 389097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 389197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 389297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * @} 389397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 389497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 3895aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis/** \defgroup CINDEX_HIGH Higher level API functions 3896aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 3897aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * @{ 3898aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis */ 3899aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3900aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidisenum CXVisitorResult { 3901aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXVisit_Break, 3902aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXVisit_Continue 3903aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis}; 3904aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3905aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidistypedef struct { 3906aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis void *context; 3907aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange); 3908aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis} CXCursorAndRangeVisitor; 3909aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3910aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis/** 3911aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \brief Find references of a declaration in a specific file. 3912aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 3913aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \param cursor pointing to a declaration or a reference of one. 3914aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 3915aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \param file to search for references. 3916aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 3917aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for 3918aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * each reference found. 3919aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * The CXSourceRange will point inside the file; if the reference is inside 3920aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * a macro (and not a macro argument) the CXSourceRange will be invalid. 3921aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis */ 3922aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios KyrtzidisCINDEX_LINKAGE void clang_findReferencesInFile(CXCursor cursor, CXFile file, 3923aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXCursorAndRangeVisitor visitor); 3924aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3925aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis#ifdef __has_feature 3926aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis# if __has_feature(blocks) 3927aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3928aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidistypedef enum CXVisitorResult 3929aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange); 3930aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3931aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios KyrtzidisCINDEX_LINKAGE 3932aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidisvoid clang_findReferencesInFileWithBlock(CXCursor, CXFile, 3933aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXCursorAndRangeVisitorBlock); 3934aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3935aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis# endif 3936aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis#endif 3937aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 3938bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 3939bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The client's data object that is associated with a CXFile. 3940bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 3941dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef void *CXIdxClientFile; 3942bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis 3943bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 3944bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The client's data object that is associated with a unique entity in 3945bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * the current translation unit that gets indexed. For example: 3946bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 3947bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \code 3948bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * @class Foo; 3949bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * @interface Foo 3950bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * @end 3951bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \endcode 3952bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 3953bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * In the example above there is only one entity introduced, the class 'Foo'. 3954bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 3955dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef void *CXIdxClientEntity; 3956bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis 3957bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 3958bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The client's data object that is associated with a semantic container 3959bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * of entities. 3960bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 3961bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \code 3962bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * // #1 \see startedTranslationUnit 3963bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 3964bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * void func() { } // #2 \see startedStatementBody 3965bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 3966bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * @interface Foo // #3 \see startedObjCContainer 3967bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * -(void)meth; 3968bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * @end 3969bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 3970bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * @implementation Foo // #4 \see startedObjCContainer 3971bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * -(void)meth {} // #5 \see startedStatementBody 3972bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * @end 3973bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 3974bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * class C { // #6 \see startedTagTypeDefinition 3975bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * void meth(); 3976bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * }; 3977bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * void C::meth() {} // #7 \see startedStatementBody 3978bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \endcode 3979bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 3980bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * In the example above the markings are wherever there is a callback that 3981bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * initiates a container context. The CXIdxContainer that the client returns 3982bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * for the callbacks will be passed along the indexed entities in the 3983bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * container. Note that C++ out-of-line member functions (#7) are considered 3984bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * as part of the C++ class container, not of the translation unit. 3985bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 3986dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef void *CXIdxClientContainer; 3987bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis 3988bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 3989bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The client's data object that is associated with a macro definition 3990bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * in the current translation unit that gets indexed. 3991bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 3992dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef void *CXIdxClientMacro; 3993bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis 3994bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 3995bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The client's data object that is associated with an AST file (PCH 3996bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * or module). 3997bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 3998dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef void *CXIdxClientASTFile; 39994e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4000bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4001dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis * \brief Source location passed to index callbacks. 4002bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40034e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40044e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void *ptr_data[2]; 40054e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned int_data; 40064e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxLoc; 40074e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4008bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4009bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see ppIncludedFile callback. 4010bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40114e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4012bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4013bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Location of '#' in the #include/#import directive. 4014bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40154e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc hashLoc; 4016bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4017bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Filename as written in the #include/#import directive. 4018bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40194e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *filename; 4020bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4021bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The actual file that the #include/#import directive resolved to. 4022bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4023dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXFile file; 40244e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isImport; 40254e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isAngled; 40264e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxIncludedFileInfo; 40274e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4028bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4029bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see importedASTFile callback. 4030bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40314e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40324e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXFile file; 4033bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4034bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Location where the file is imported. It is useful mostly for 4035bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * modules. 4036bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40374e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 4038bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4039bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Non-zero if the AST file is a module otherwise it's a PCH. 4040bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40414e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isModule; 40424e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxImportedASTFileInfo; 40434e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 40444e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4045bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4046bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Location of the macro definition. 4047bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40484e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 40494e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *name; 40504e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxMacroInfo; 40514e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4052bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4053bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see ppMacroDefined callback. 4054bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40554e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40564e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxMacroInfo *macroInfo; 40574e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc defBegin; 4058bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4059bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Length of macro definition in characters. 4060bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40614e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned defLength; 40624e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxMacroDefinedInfo; 40634e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4064bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4065bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see ppMacroUndefined callback. 4066bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40674e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40684e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 40694e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *name; 4070dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientMacro macro; 40714e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxMacroUndefinedInfo; 40724e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4073bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4074bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see ppMacroExpanded callback. 4075bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40764e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40774e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 40784e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *name; 4079dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientMacro macro; 40804e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxMacroExpandedInfo; 40814e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4082bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4083bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see importedMacro callback. 4084bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 40854e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 40864e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxMacroInfo *macroInfo; 4087dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientASTFile ASTFile; 40884e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxImportedMacroInfo; 40894e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4090dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef enum { 4091dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Unexposed = 0, 4092dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Typedef = 1, 4093dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Function = 2, 4094dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Variable = 3, 4095dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Field = 4, 4096dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_EnumConstant = 5, 40974e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4098dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_ObjCClass = 6, 4099dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_ObjCProtocol = 7, 4100dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_ObjCCategory = 8, 41014e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4102dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_ObjCMethod = 9, 4103dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_ObjCProperty = 10, 4104dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_ObjCIvar = 11, 41054e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4106dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Enum = 12, 4107dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Struct = 13, 4108dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Union = 14, 4109dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_CXXClass = 15 41104e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4111dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxEntityKind; 41124e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41134e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4114dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntityKind kind; 4115dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis const char *name; 4116dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis const char *USR; 4117dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientEntity clientEntity; 4118dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxEntityInfo; 41194e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4120bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4121dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis * \brief Data for \see importedEntity callback. 4122bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 41234e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4124dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntityInfo *entityInfo; 4125dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXCursor cursor; 4126dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxLoc loc; 4127dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientASTFile ASTFile; 4128dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxImportedEntityInfo; 41294e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41304e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4131dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntityInfo *entity; 4132dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXCursor cursor; 4133dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxLoc loc; 4134dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis int isObjCImpl; 4135dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxContainerInfo; 41364e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41374e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4138dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntityInfo *entityInfo; 4139dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXCursor cursor; 4140dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxLoc loc; 4141dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientContainer container; 4142dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis int isRedeclaration; 41434e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isDefinition; 4144dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxDeclInfo; 41454e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41464e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4147dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxDeclInfo *declInfo; 4148dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis int isAnonymous; 4149dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxTagDeclInfo; 41504e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4151dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef enum { 4152dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxObjCContainer_ForwardRef = 0, 4153dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxObjCContainer_Interface = 1, 4154dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxObjCContainer_Implementation = 2 4155dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxObjCContainerKind; 41564e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41574e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4158dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxDeclInfo *declInfo; 4159dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxObjCContainerKind kind; 4160dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxObjCContainerDeclInfo; 41614e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 41624e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4163dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxObjCContainerDeclInfo *containerInfo; 4164dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntityInfo *objcClass; 4165dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxObjCCategoryDeclInfo; 41664e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4167bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4168bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see defineObjCClass callback. 4169bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 41704e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4171dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntityInfo *objcClass; 41724e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 41734e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCBaseClassInfo; 41744e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4175bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4176bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see defineObjCClass callback. 4177bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 41784e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4179dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntityInfo *protocol; 41804e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 41814e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCProtocolRefInfo; 41824e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4183bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4184bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see defineObjCClass callback. 4185bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 41864e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 41874e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXCursor cursor; 4188dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntityInfo *objcClass; 4189dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientContainer container; 41904e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxObjCBaseClassInfo *baseInfo; 41914e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxObjCProtocolRefInfo **protocols; 41924e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned numProtocols; 41934e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCClassDefineInfo; 41944e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4195bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4196bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see endedContainer callback. 4197bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 41984e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4199dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientContainer container; 42004e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc endLoc; 42014e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxEndContainerInfo; 42024e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4203bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4204bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see indexEntityReference callback. 4205bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4206aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidistypedef enum { 4207bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4208bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The entity is referenced directly in user's code. 4209bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4210aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis CXIdxEntityRef_Direct = 1, 4211bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4212bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief A reference of an ObjC method via the dot syntax. 4213bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4214aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis CXIdxEntityRef_ImplicitProperty = 2 4215aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis} CXIdxEntityRefKind; 4216aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis 4217bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4218bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Data for \see indexEntityReference callback. 4219bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 42204e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4221bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4222bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Reference cursor. 4223bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 42244e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXCursor cursor; 42254e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 4226bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4227bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The entity that gets referenced. 4228bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4229dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntityInfo *referencedEntity; 4230bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4231bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Immediate "parent" of the reference. For example: 4232bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4233bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \code 4234bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * Foo *var; 4235bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \endcode 4236bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4237bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * The parent of reference of type 'Foo' is the variable 'var'. 4238bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * parentEntity will be null for references inside statement bodies. 4239bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4240dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntityInfo *parentEntity; 4241bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4242bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Container context of the reference. 4243bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4244dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientContainer container; 4245aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis CXIdxEntityRefKind kind; 42464e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxEntityRefInfo; 42474e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 42484e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4249bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4250bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called when a diagnostic is emitted. 4251bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 42524e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*diagnostic)(CXClientData client_data, 42534e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXDiagnostic, void *reserved); 42544e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4255dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientFile (*enteredMainFile)(CXClientData client_data, 4256dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXFile mainFile, void *reserved); 4257dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis 4258bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4259bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called when a file gets #included/#imported. 4260bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4261dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientFile (*ppIncludedFile)(CXClientData client_data, 4262dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxIncludedFileInfo *); 42634e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4264bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4265bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called when a macro gets #defined. 4266bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4267dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientMacro (*ppMacroDefined)(CXClientData client_data, 42684e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxMacroDefinedInfo *); 42694e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4270bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4271bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called when a macro gets undefined. 4272bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 42734e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*ppMacroUndefined)(CXClientData client_data, 42744e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxMacroUndefinedInfo *); 42754e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4276bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4277bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called when a macro gets expanded. 4278bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 42794e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*ppMacroExpanded)(CXClientData client_data, 42804e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxMacroExpandedInfo *); 42814e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4282bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4283bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called when a AST file (PCH or module) gets imported. 4284bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4285bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * AST files will not get indexed (there will not be callbacks to index all 4286bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * the entities in an AST file). The recommended action is that, if the AST 4287bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * file is not already indexed, to block further indexing and initiate a new 4288bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * indexing job specific to the AST file, so that references of entities of 4289bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * the AST file can be later associated with CXIdxEntities returned by 4290bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \see importedEntity callbacks. 4291bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4292dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientASTFile (*importedASTFile)(CXClientData client_data, 42934e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxImportedASTFileInfo *); 42944e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4295bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4296bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called when an entity gets imported from an AST file. This generally 4297bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * happens when an entity from a PCH/module is referenced for the first time. 4298bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4299dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientEntity (*importedEntity)(CXClientData client_data, 4300dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxImportedEntityInfo *); 43014e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4302bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4303bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called when a macro gets imported from an AST file. This generally 4304bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * happens when a macro from a PCH/module is referenced for the first time. 4305bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4306dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientMacro (*importedMacro)(CXClientData client_data, 4307dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxImportedMacroInfo *); 43084e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4309bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4310bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called at the beginning of indexing a translation unit. 4311bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4312dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data, 43134e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void *reserved); 43144e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4315dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientEntity (*indexDeclaration)(CXClientData client_data, 4316dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxDeclInfo *); 43174e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4318bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4319dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis * \brief Called to initiate a container context. 4320bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4321dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientContainer (*startedContainer)(CXClientData client_data, 4322dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxContainerInfo *); 43234e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4324bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4325bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called to define an ObjC class via its @interface. 4326bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 43274e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*defineObjCClass)(CXClientData client_data, 43284e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxObjCClassDefineInfo *); 43294e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4330bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4331bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called when a container context is ended. 4332bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 43334e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*endedContainer)(CXClientData client_data, 43344e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEndContainerInfo *); 43354e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4336bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4337bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called to index a reference of an entity. 4338bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 43394e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*indexEntityReference)(CXClientData client_data, 43404e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxEntityRefInfo *); 43414e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 43424e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} IndexerCallbacks; 43434e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4344dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidisint clang_index_isEntityTagKind(CXIdxEntityKind); 4345dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios KyrtzidisCXIdxTagDeclInfo *clang_index_getTagDeclInfo(CXIdxDeclInfo *); 4346dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis 4347dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidisint clang_index_isEntityObjCContainerKind(CXIdxEntityKind); 4348dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios KyrtzidisCXIdxObjCContainerDeclInfo * 4349dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidisclang_index_getObjCContainerDeclInfo(CXIdxDeclInfo *); 4350dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis 4351dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidisint clang_index_isEntityObjCCategoryKind(CXIdxEntityKind); 4352dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios KyrtzidisCXIdxObjCCategoryDeclInfo *clang_index_getObjCCategoryDeclInfo(CXIdxDeclInfo *); 4353dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis 4354bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4355bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Index the given source file and the translation unit corresponding 4356bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * to that file via callbacks implemented through \see IndexerCallbacks. 4357bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4358bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \param client_data pointer data supplied by the client, which will 4359bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * be passed to the invoked callbacks. 4360bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4361bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \param index_callbacks Pointer to indexing callbacks that the client 4362bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * implements. 4363bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4364bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \param index_callbacks_size Size of \see IndexerCallbacks structure that gets 4365bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * passed in index_callbacks. 4366bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4367bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \param index_options Options affecting indexing; reserved. 4368bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4369bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \param out_TU [out] pointer to store a CXTranslationUnit that can be reused 4370bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * after indexing is finished. Set to NULL if you do not require it. 4371bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4372bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \returns If there is a failure from which the compiler cannot recover returns 4373bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * non-zero, otherwise returns 0. 4374bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4375bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * The rest of the parameters are the same as \see clang_parseTranslationUnit. 4376bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 43774e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCINDEX_LINKAGE int clang_indexTranslationUnit(CXIndex CIdx, 43784e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXClientData client_data, 43794e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis IndexerCallbacks *index_callbacks, 43804e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned index_callbacks_size, 43814e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned index_options, 43824e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *source_filename, 43834e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char * const *command_line_args, 43844e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int num_command_line_args, 43854e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis struct CXUnsavedFile *unsaved_files, 43864e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned num_unsaved_files, 43874e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXTranslationUnit *out_TU, 43884e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned TU_options); 43894e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4390bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4391bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Retrieve the CXIdxFile, file, line, column, and offset represented by 4392bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * the given CXIdxLoc. 4393bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 4394bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * If the location refers into a macro expansion, retrieves the 4395bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * location of the macro expansion and if it refers into a macro argument 4396bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * retrieves the location of the argument. 4397bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 43984e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc, 4399dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientFile *indexFile, 44004e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXFile *file, 44014e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned *line, 44024e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned *column, 44034e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned *offset); 44044e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4405bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4406bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Retrieve the CXSourceLocation represented by the given CXIdxLoc. 4407bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 44084e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCINDEX_LINKAGE 44094e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc); 44104e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4411aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis/** 4412aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * @} 4413aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis */ 4414aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4415c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 4416c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 4417c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 44181efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 4419d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifdef __cplusplus 4420d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek} 4421d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 4422d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 4423d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 4424