Index.h revision f303d4cb10648ac9c2080ae7c9dd507ba615e3a7
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 23db2a685287e57d9dfec09c867152c465af6fc6b0Arnaud A. de Grandmaison#include "clang-c/Platform.h" 24db2a685287e57d9dfec09c867152c465af6fc6b0Arnaud A. de Grandmaison#include "clang-c/CXString.h" 25db2a685287e57d9dfec09c867152c465af6fc6b0Arnaud A. de Grandmaison 26d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifdef __cplusplus 27d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenekextern "C" { 28d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 29d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 3087fb9404cd962b78c98947d75d68be1691c4e737Douglas Gregor/** \defgroup CINDEX libclang: C Interface to Clang 3120d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * 321efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The C Interface to Clang provides a relatively small API that exposes 33f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * facilities for parsing source code into an abstract syntax tree (AST), 34f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * loading already-parsed ASTs, traversing the AST, associating 35f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * physical source locations with elements within the AST, and other 36f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * facilities that support Clang-based development tools. 37f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 381efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * This C interface to Clang will never provide all of the information 39f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * representation stored in Clang's C++ AST, nor should it: the intent is to 40f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * maintain an API that is relatively stable from one release to the next, 41f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * providing only the basic functionality needed to support development tools. 421efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 431efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * To avoid namespace pollution, data types are prefixed with "CX" and 44f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * functions are prefixed with "clang_". 4520d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * 4620d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * @{ 4720d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor */ 481efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 497f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 507f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief An "index" that consists of a set of translation units that would 517f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * typically be linked together into an executable or library. 527f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 537f17376e0931a337d544b75d9030bc92763be287Douglas Gregortypedef void *CXIndex; 54600866cc7d6d9ec2e27d4b6d6ec461f6463b5ab6Steve Naroff 557f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 567f17376e0931a337d544b75d9030bc92763be287Douglas Gregor * \brief A single translation unit, which resides in an index. 577f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 580a90d32523bfe5fa63e11b648686c9699f786d15Ted Kremenektypedef struct CXTranslationUnitImpl *CXTranslationUnit; 59600866cc7d6d9ec2e27d4b6d6ec461f6463b5ab6Steve Naroff 607f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 61c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Opaque pointer representing client data that will be passed through 62c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to various callbacks and visitors. 637f17376e0931a337d544b75d9030bc92763be287Douglas Gregor */ 64c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregortypedef void *CXClientData; 651efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 66735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor/** 67735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * \brief Provides the contents of a file that has not yet been saved to disk. 68735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * 69735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * Each CXUnsavedFile instance provides the name of a file on the 70735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * system along with the current contents of that file that have not 71735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * yet been saved to disk. 72735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 73735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregorstruct CXUnsavedFile { 741efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 751efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief The file whose contents have not yet been saved. 76735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * 77735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor * This file must already exist in the file system. 78735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 79735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor const char *Filename; 80735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor 811efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 82c8dfe5ece04e683106eb96c58a2999f70b53ac21Douglas Gregor * \brief A buffer containing the unsaved contents of this file. 83735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 84735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor const char *Contents; 85735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor 86735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor /** 87c8dfe5ece04e683106eb96c58a2999f70b53ac21Douglas Gregor * \brief The length of the unsaved contents of this buffer. 88735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor */ 89735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor unsigned long Length; 90735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor}; 91735df88a38e80c1ca70daa889aa516b8b9f54b50Douglas Gregor 92076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne/** 93076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief Describes the availability of a particular entity, which indicates 94076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * whether the use of this entity will result in a warning or error due to 95076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * it being deprecated or unavailable. 96076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 9758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorenum CXAvailabilityKind { 98076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne /** 99076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief The entity is available. 100076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 10158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailability_Available, 102076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne /** 103076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief The entity is available, but has been deprecated (and its use is 104076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * not recommended). 105076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 10658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailability_Deprecated, 107076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne /** 108076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne * \brief The entity is not available; any use of it will be an error. 109076c22a99ed82e11b59e8fbf57d8467ceb3fec77Peter Collingbourne */ 110d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen CXAvailability_NotAvailable, 111d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen /** 112d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen * \brief The entity is available, but not accessible; any use of it will be 113d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen * an error. 114d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen */ 115d12059673dcef32bc2b6bae5321654d33863afe6Erik Verbruggen CXAvailability_NotAccessible 11658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor}; 117cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor 118cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor/** 119cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \brief Describes a version number of the form major.minor.subminor. 120cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor */ 121cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregortypedef struct CXVersion { 122cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor /** 123cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \brief The major version number, e.g., the '10' in '10.7.3'. A negative 124cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * value indicates that there is no version number at all. 125cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor */ 126cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor int Major; 127cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor /** 128cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \brief The minor version number, e.g., the '7' in '10.7.3'. This value 129cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * will be negative if no minor version number was provided, e.g., for 130cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * version '10'. 131cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor */ 132cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor int Minor; 133cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor /** 134cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \brief The subminor version number, e.g., the '3' in '10.7.3'. This value 135cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * will be negative if no minor or subminor version number was provided, 136cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * e.g., in version '10' or '10.7'. 137cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor */ 138cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor int Subminor; 139cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor} CXVersion; 14058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 1417f17376e0931a337d544b75d9030bc92763be287Douglas Gregor/** 1427eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Provides a shared context for creating translation units. 1437eee0184570366285589d788bcd7f5dda8345915James Dennett * 1447eee0184570366285589d788bcd7f5dda8345915James Dennett * It provides two options: 145e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * 146e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local" 147e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * declarations (when loading any new translation units). A "local" declaration 1481efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * is one that belongs in the translation unit itself and not in a precompiled 149e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * header that was used by the translation unit. If zero, all declarations 150e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * will be enumerated. 151e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff * 152b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * Here is an example: 153b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 1547eee0184570366285589d788bcd7f5dda8345915James Dennett * \code 1550a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * // excludeDeclsFromPCH = 1, displayDiagnostics=1 1560a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * Idx = clang_createIndex(1, 1); 157b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 158b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // IndexTest.pch was produced with the following command: 159b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch" 160b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * TU = clang_createTranslationUnit(Idx, "IndexTest.pch"); 161b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 162b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // This will load all the symbols from 'IndexTest.pch' 1631efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * clang_visitChildren(clang_getTranslationUnitCursor(TU), 164002a528ab0189fc60cfbf9328962c96ccbe567eeDouglas Gregor * TranslationUnitVisitor, 0); 165b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * clang_disposeTranslationUnit(TU); 166b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 167b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // This will load all the symbols from 'IndexTest.c', excluding symbols 168b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * // from 'IndexTest.pch'. 169fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" }; 170fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args, 171fd9f23464bfd35314c87c4df410f3937d59eb96dDaniel Dunbar * 0, 0); 172b2cd48756119f4d8d2a865b4b3e0e8efd02e26a0Douglas Gregor * clang_visitChildren(clang_getTranslationUnitCursor(TU), 173b2cd48756119f4d8d2a865b4b3e0e8efd02e26a0Douglas Gregor * TranslationUnitVisitor, 0); 174b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * clang_disposeTranslationUnit(TU); 1757eee0184570366285589d788bcd7f5dda8345915James Dennett * \endcode 176b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * 177b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * This process of creating the 'pch', loading it separately, and using it (via 178b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks 179b4ece6377d95e35a8df01cd010d910c34d690f67Steve Naroff * (which gives the indexer the same performance benefit as the compiler). 180e56b4baeba5097852e04bc41ca2e0396cf729955Steve Naroff */ 1810a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH, 1820a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor int displayDiagnostics); 183896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 1840087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor/** 1850087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * \brief Destroy the given index. 1860087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * 1870087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * The index must not be destroyed until all of the translation units created 1880087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor * within that index have been destroyed. 1890087e1a12b67b6bb032a72ea485a863daeccf55bDouglas Gregor */ 1908506dde586459887b7e14e23a30af8ac5be5adb6Daniel DunbarCINDEX_LINKAGE void clang_disposeIndex(CXIndex index); 1911efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 192fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidistypedef enum { 193fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis /** 194fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * \brief Used to indicate that no special CXIndex options are needed. 195fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis */ 196fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis CXGlobalOpt_None = 0x0, 197fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis 198fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis /** 199fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * \brief Used to indicate that threads that libclang creates for indexing 200fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * purposes should use background priority. 2017eee0184570366285589d788bcd7f5dda8345915James Dennett * 2027eee0184570366285589d788bcd7f5dda8345915James Dennett * Affects #clang_indexSourceFile, #clang_indexTranslationUnit, 2037eee0184570366285589d788bcd7f5dda8345915James Dennett * #clang_parseTranslationUnit, #clang_saveTranslationUnit. 204fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis */ 205fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis CXGlobalOpt_ThreadBackgroundPriorityForIndexing = 0x1, 206fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis 207fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis /** 208fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * \brief Used to indicate that threads that libclang creates for editing 209fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * purposes should use background priority. 2107eee0184570366285589d788bcd7f5dda8345915James Dennett * 2117eee0184570366285589d788bcd7f5dda8345915James Dennett * Affects #clang_reparseTranslationUnit, #clang_codeCompleteAt, 2127eee0184570366285589d788bcd7f5dda8345915James Dennett * #clang_annotateTokens 213fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis */ 214fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis CXGlobalOpt_ThreadBackgroundPriorityForEditing = 0x2, 215fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis 216fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis /** 217fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * \brief Used to indicate that all threads that libclang creates should use 218fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * background priority. 219fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis */ 220fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis CXGlobalOpt_ThreadBackgroundPriorityForAll = 221fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis CXGlobalOpt_ThreadBackgroundPriorityForIndexing | 222fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis CXGlobalOpt_ThreadBackgroundPriorityForEditing 223fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis 224fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis} CXGlobalOptFlags; 225fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis 226fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis/** 2277eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Sets general options associated with a CXIndex. 228fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * 229fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * For example: 230fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * \code 231fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * CXIndex idx = ...; 232fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * clang_CXIndex_setGlobalOptions(idx, 233fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * clang_CXIndex_getGlobalOptions(idx) | 234fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * CXGlobalOpt_ThreadBackgroundPriorityForIndexing); 235fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * \endcode 236fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * 237fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * \param options A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags. 238fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis */ 239fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios KyrtzidisCINDEX_LINKAGE void clang_CXIndex_setGlobalOptions(CXIndex, unsigned options); 240fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis 241fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis/** 242fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * \brief Gets the general options associated with a CXIndex. 243fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * 244fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * \returns A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags that 245fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis * are associated with the given CXIndex object. 246fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis */ 247fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios KyrtzidisCINDEX_LINKAGE unsigned clang_CXIndex_getGlobalOptions(CXIndex); 248fdc1795acc9d5d73a767cc7d43ad1546e93adbbaArgyrios Kyrtzidis 2491efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 250c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_FILES File manipulation routines 251f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 252f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @{ 253f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 2541efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 255f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 256f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief A particular source file that is part of a translation unit. 257f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 258f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregortypedef void *CXFile; 2591efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 260f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor 261f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 262f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief Retrieve the complete file and path name of the given file. 26388145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff */ 26474844072411bae91d5dbb89955d200cbe1e0a1c8Ted KremenekCINDEX_LINKAGE CXString clang_getFileName(CXFile SFile); 2651efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 266f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 267f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \brief Retrieve the last modification time of the given file. 268f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 26908b0e8daeb683686b876d72674962ad96df21d45Douglas GregorCINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile); 27088145034694ed5267fa6fa5febc54fadc02bd479Steve Naroff 2713c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor/** 272dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor * \brief Determine whether the given header is guarded against 273dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor * multiple inclusions, either with the conventional 2747eee0184570366285589d788bcd7f5dda8345915James Dennett * \#ifndef/\#define/\#endif macro guards or with \#pragma once. 275dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor */ 276dd3e5549e3c11e217078938aacf72f042eea5343Douglas GregorCINDEX_LINKAGE unsigned 277dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregorclang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file); 278dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor 279dd3e5549e3c11e217078938aacf72f042eea5343Douglas Gregor/** 280b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a file handle within the given translation unit. 281b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 282b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \param tu the translation unit 2831efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 284b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \param file_name the name of the file. 285b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 286b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns the file handle for the named file in the translation unit \p tu, 287b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * or a NULL file handle if the file was not a part of this translation unit. 288b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 2891efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu, 290b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor const char *file_name); 2911efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 292b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 293f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @} 294f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 295f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor 296f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 297f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * \defgroup CINDEX_LOCATIONS Physical source locations 298f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 299f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * Clang represents physical source locations in its abstract syntax tree in 300f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * great detail, with file, line, and column information for the majority of 301f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * the tokens parsed in the source code. These data types and functions are 302f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * used to represent source location information, either for a particular 303f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * point in the program or for a range of points in the program, and extract 304f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * specific location information from those data types. 305f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * 306f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @{ 307f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 3081efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 309f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 3101db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * \brief Identifies a specific source location within a translation 3111db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * unit. 3121db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 31320174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * Use clang_getExpansionLocation() or clang_getSpellingLocation() 314a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * to map a source location to a particular file, line, and column. 3153c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor */ 3163c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregortypedef struct { 3175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor void *ptr_data[2]; 3181db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned int_data; 3193c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor} CXSourceLocation; 320fe6fd3d41a7f48317d6856c9327b6cead32c3498Ted Kremenek 3213c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor/** 322d52864bd33c66aacc84133460d8c9c0dfcdd5c18Daniel Dunbar * \brief Identifies a half-open character range in the source code. 3233c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor * 3241db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the 3251db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * starting and end locations from a source range, respectively. 3263c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor */ 3273c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregortypedef struct { 3285352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor void *ptr_data[2]; 3291db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned begin_int_data; 3301db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned end_int_data; 3313c7313d96cd4a18cd8c1fcd3ddd8128c2fcbe58fDouglas Gregor} CXSourceRange; 332fe6fd3d41a7f48317d6856c9327b6cead32c3498Ted Kremenek 3331db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor/** 334b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a NULL (invalid) source location. 335b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 336b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getNullLocation(); 3371efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 338b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 3397eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Determine whether two source locations, which must refer into 3401efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * the same translation unit, refer to exactly the same point in the source 341b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * code. 342b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 343b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns non-zero if the source locations refer to the same location, zero 344b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * if they refer to different locations. 345b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 346b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1, 347b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXSourceLocation loc2); 3481efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 349b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 3501efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieves the source location associated with a given file/line/column 3511efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * in a particular translation unit. 352b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 353b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu, 354b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXFile file, 355b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor unsigned line, 356b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor unsigned column); 35783889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall/** 35883889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall * \brief Retrieves the source location associated with a given character offset 35983889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall * in a particular translation unit. 36083889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall */ 36183889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid ChisnallCINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu, 36283889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall CXFile file, 36383889a7f1f338e343ef72aeeef9c27f7b62c0f0fDavid Chisnall unsigned offset); 3641efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 365b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 3665352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve a NULL (invalid) source range. 3675352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 3685352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXSourceRange clang_getNullRange(); 369896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3705352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 371b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Retrieve a source range given the beginning and ending source 372b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * locations. 373b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor */ 374b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin, 375b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor CXSourceLocation end); 3761efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 377b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor/** 378ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor * \brief Determine whether two ranges are equivalent. 379ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor * 380ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor * \returns non-zero if the ranges are the same, zero if they differ. 381ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor */ 382ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas GregorCINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1, 383ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor CXSourceRange range2); 384ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor 385ab4e83b904d81d8ab1f8c594655822a023cad87dDouglas Gregor/** 386de5db649fd5f9aedde200f443ad73d62517b1c88Argyrios Kyrtzidis * \brief Returns non-zero if \arg range is null. 387de5db649fd5f9aedde200f443ad73d62517b1c88Argyrios Kyrtzidis */ 388733dbc805facad7cebec5420f6c47c83848cee5fErik VerbruggenCINDEX_LINKAGE int clang_Range_isNull(CXSourceRange range); 389de5db649fd5f9aedde200f443ad73d62517b1c88Argyrios Kyrtzidis 390de5db649fd5f9aedde200f443ad73d62517b1c88Argyrios Kyrtzidis/** 39146766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * \brief Retrieve the file, line, column, and offset represented by 39246766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * the given source location. 3931db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 39420174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * If the location refers into a macro expansion, retrieves the 39520174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * location of the macro expansion. 396a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 3971efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param location the location within a source file that will be decomposed 3981efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * into its parts. 3991db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 4001efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param file [out] if non-NULL, will be set to the file to which the given 4011db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * source location points. 4021db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 4031efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param line [out] if non-NULL, will be set to the line to which the given 4041db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * source location points. 4051db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor * 4061efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \param column [out] if non-NULL, will be set to the column to which the given 4071efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source location points. 40846766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * 40946766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * \param offset [out] if non-NULL, will be set to the offset into the 41046766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor * buffer to which the given source location points. 4111db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 41220174221af145554b76a0b0f5e4eb3ac70d05945Chandler CarruthCINDEX_LINKAGE void clang_getExpansionLocation(CXSourceLocation location, 41320174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth CXFile *file, 41420174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth unsigned *line, 41520174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth unsigned *column, 41620174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth unsigned *offset); 41720174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth 41820174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth/** 419e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \brief Retrieve the file, line, column, and offset represented by 420e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * the given source location, as specified in a # line directive. 421e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 422e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * Example: given the following source code in a file somefile.c 423e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 4247eee0184570366285589d788bcd7f5dda8345915James Dennett * \code 425e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * #123 "dummy.c" 1 426e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 427e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * static int func(void) 428e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * { 429e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * return 0; 430e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * } 4317eee0184570366285589d788bcd7f5dda8345915James Dennett * \endcode 432e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 433e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * the location information returned by this function would be 434e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 435e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * File: dummy.c Line: 124 Column: 12 436e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 437e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * whereas clang_getExpansionLocation would have returned 438e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 439e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * File: somefile.c Line: 3 Column: 12 440e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 441e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \param location the location within a source file that will be decomposed 442e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * into its parts. 443e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 444e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \param filename [out] if non-NULL, will be set to the filename of the 445e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * source location. Note that filenames returned will be for "virtual" files, 446e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * which don't necessarily exist on the machine running clang - e.g. when 447e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * parsing preprocessed output obtained from a different environment. If 448e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * a non-NULL value is passed in, remember to dispose of the returned value 449e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * using \c clang_disposeString() once you've finished with it. For an invalid 450e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * source location, an empty string is returned. 451e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 452e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \param line [out] if non-NULL, will be set to the line number of the 453e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * source location. For an invalid source location, zero is returned. 454e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * 455e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * \param column [out] if non-NULL, will be set to the column number of the 456e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis * source location. For an invalid source location, zero is returned. 457e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis */ 458e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios KyrtzidisCINDEX_LINKAGE void clang_getPresumedLocation(CXSourceLocation location, 459e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis CXString *filename, 460e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis unsigned *line, 461e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis unsigned *column); 462e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis 463e6be34d8f77312edf9ed38034e52cb4d22c8e1c1Argyrios Kyrtzidis/** 46420174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * \brief Legacy API to retrieve the file, line, column, and offset represented 46520174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * by the given source location. 46620174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * 46720174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * This interface has been replaced by the newer interface 4687eee0184570366285589d788bcd7f5dda8345915James Dennett * #clang_getExpansionLocation(). See that interface's documentation for 46920174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth * details. 47020174221af145554b76a0b0f5e4eb3ac70d05945Chandler Carruth */ 4711db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location, 4721db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor CXFile *file, 4731db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor unsigned *line, 47446766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor unsigned *column, 47546766dc31c09d89024de5aba9e22112a56eadbdfDouglas Gregor unsigned *offset); 476e69517ce61638f12c9abe4605753a45275ac4e37Douglas Gregor 477e69517ce61638f12c9abe4605753a45275ac4e37Douglas Gregor/** 478a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \brief Retrieve the file, line, column, and offset represented by 479a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * the given source location. 480a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 481a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * If the location refers into a macro instantiation, return where the 482a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * location was originally spelled in the source file. 483a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 484a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param location the location within a source file that will be decomposed 485a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * into its parts. 486a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 487a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param file [out] if non-NULL, will be set to the file to which the given 488a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 489a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 490a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param line [out] if non-NULL, will be set to the line to which the given 491a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 492a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 493a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param column [out] if non-NULL, will be set to the column to which the given 494a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * source location points. 495a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * 496a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * \param offset [out] if non-NULL, will be set to the offset into the 497a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor * buffer to which the given source location points. 498a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor */ 499a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas GregorCINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location, 500a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor CXFile *file, 501a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *line, 502a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *column, 503a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor unsigned *offset); 504a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor 505a9b06d4c246d6c301e3dd1844f5dba669ed9c631Douglas Gregor/** 5061efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve a source location representing the first character within a 5071efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source range. 5081db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 5091db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range); 5101db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor 5111db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor/** 5121efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve a source location representing the last character within a 5131efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * source range. 5141db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor */ 5151db19dea8d221f27be46332d668d1e2decb7f1abDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range); 5161db19dea8d221f27be46332d668d1e2decb7f1abDouglas Gregor 517f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor/** 518f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor * @} 519f55254472e496340cbb4f0a24cff398e441475b5Douglas Gregor */ 520c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 521c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 5225352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \defgroup CINDEX_DIAG Diagnostic reporting 5235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 5245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @{ 5255352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5265352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5285352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Describes the severity of a particular diagnostic. 5295352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5305352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorenum CXDiagnosticSeverity { 5315352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 532896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief A diagnostic that has been suppressed, e.g., by a command-line 5335352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * option. 5345352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5355352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Ignored = 0, 536896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 5375352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 5385352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic is a note that should be attached to the 5395352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * previous (non-note) diagnostic. 5405352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5415352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Note = 1, 5425352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5435352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 5445352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates suspicious code that may not be 5455352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * wrong. 5465352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5475352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Warning = 2, 5485352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5495352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 5505352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates that the code is ill-formed. 5515352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5525352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Error = 3, 5535352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5545352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor /** 5555352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief This diagnostic indicates that the code is ill-formed such 5565352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * that future parser recovery is unlikely to produce useful 5575352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * results. 5585352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5595352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXDiagnostic_Fatal = 4 5605352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor}; 5615352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5625352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 5635352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief A single diagnostic, containing the diagnostic's severity, 5645352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * location, text, source ranges, and fix-it hints. 5655352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 5665352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregortypedef void *CXDiagnostic; 5675352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 5685352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 569153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief A group of CXDiagnostics. 570153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 571153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenektypedef void *CXDiagnosticSet; 572153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 573153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 574153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Determine the number of diagnostics in a CXDiagnosticSet. 575153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 576153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags); 577153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 578153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 579153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet. 580153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * 5817eee0184570366285589d788bcd7f5dda8345915James Dennett * \param Diags the CXDiagnosticSet to query. 582153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \param Index the zero-based diagnostic number to retrieve. 583153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * 584153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \returns the requested diagnostic. This diagnostic must be freed 585153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * via a call to \c clang_disposeDiagnostic(). 586153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 587153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags, 588153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek unsigned Index); 589153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 590153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 591153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 592153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Describes the kind of error that occurred (if any) in a call to 593153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \c clang_loadDiagnostics. 594153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 595153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenekenum CXLoadDiag_Error { 596153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek /** 597153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Indicates that no error occurred. 598153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 599153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXLoadDiag_None = 0, 600153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 601153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek /** 602153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Indicates that an unknown error occurred while attempting to 603153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * deserialize diagnostics. 604153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 605153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXLoadDiag_Unknown = 1, 606153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 607153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek /** 608153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Indicates that the file containing the serialized diagnostics 609153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * could not be opened. 610153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 611153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXLoadDiag_CannotLoad = 2, 612153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 613153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek /** 614153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Indicates that the serialized diagnostics file is invalid or 6157eee0184570366285589d788bcd7f5dda8345915James Dennett * corrupt. 616153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 617153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXLoadDiag_InvalidFile = 3 618153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek}; 619153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 620153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 621153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode 6227eee0184570366285589d788bcd7f5dda8345915James Dennett * file. 623153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * 6247eee0184570366285589d788bcd7f5dda8345915James Dennett * \param file The name of the file to deserialize. 6257eee0184570366285589d788bcd7f5dda8345915James Dennett * \param error A pointer to a enum value recording if there was a problem 626153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * deserializing the diagnostics. 6277eee0184570366285589d788bcd7f5dda8345915James Dennett * \param errorString A pointer to a CXString for recording the error string 628153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * if the file was not successfully loaded. 629153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * 630153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise. These 6317eee0184570366285589d788bcd7f5dda8345915James Dennett * diagnostics should be released using clang_disposeDiagnosticSet(). 632153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 633153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file, 634153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek enum CXLoadDiag_Error *error, 635153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek CXString *errorString); 636153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 637153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 638153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek * \brief Release a CXDiagnosticSet and all of its contained diagnostics. 639153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 640153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags); 641153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 642153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 6437eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Retrieve the child diagnostics of a CXDiagnostic. 6447eee0184570366285589d788bcd7f5dda8345915James Dennett * 6457eee0184570366285589d788bcd7f5dda8345915James Dennett * This CXDiagnosticSet does not need to be released by 6467eee0184570366285589d788bcd7f5dda8345915James Dennett * clang_diposeDiagnosticSet. 647153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek */ 648153221717e39ce41323d5bc6b8b8bf130923c1bdTed KremenekCINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D); 649153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek 650153221717e39ce41323d5bc6b8b8bf130923c1bdTed Kremenek/** 651a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced for the given 652a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * translation unit. 653a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 654a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit); 655a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 656a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 657a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given translation unit. 6585352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 659a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Unit the translation unit to query. 660a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 6615352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 662a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 663a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 6645352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 665a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit, 666a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 667a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 668a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 6690373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek * \brief Retrieve the complete set of diagnostics associated with a 6700373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek * translation unit. 6710373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek * 6720373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek * \param Unit the translation unit to query. 6730373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek */ 6740373fcc3e5b205cc26656c70d7dff737b0e08345Ted KremenekCINDEX_LINKAGE CXDiagnosticSet 6750373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek clang_getDiagnosticSetFromTU(CXTranslationUnit Unit); 6760373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek 6770373fcc3e5b205cc26656c70d7dff737b0e08345Ted Kremenek/** 678a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Destroy a diagnostic. 679a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 680a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic); 6815352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 6825352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 6830a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Options to control the display of diagnostics. 6840a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6850a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * The values in this enum are meant to be combined to customize the 6860a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * behavior of \c clang_displayDiagnostic(). 6870a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 6880a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregorenum CXDiagnosticDisplayOptions { 6890a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 6900a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Display the source-location information where the 6910a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic was located. 6920a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6930a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * When set, diagnostics will be prefixed by the file, line, and 6940a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * (optionally) column to which the diagnostic refers. For example, 6950a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 6960a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \code 6970a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * test.c:28: warning: extra tokens at end of #endif directive 6980a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \endcode 6990a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 7000a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-source-location. 7010a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 7020a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplaySourceLocation = 0x01, 7030a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 7040a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 7050a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 7060a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include the column number. 7070a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 7080a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * This option corresponds to the clang flag \c -fshow-column. 7090a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 7100a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor CXDiagnostic_DisplayColumn = 0x02, 7110a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 7120a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor /** 7130a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief If displaying the source-location information of the 7140a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * diagnostic, also include information about source ranges in a 7150a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * machine-parsable format. 7160a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 717896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * This option corresponds to the clang flag 7180a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \c -fdiagnostics-print-source-range-info. 7190a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 720aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplaySourceRanges = 0x04, 721aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 722aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 723aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the option name associated with this diagnostic, if any. 724aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 725aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The option name displayed (e.g., -Wconversion) will be placed in brackets 726aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * after the diagnostic text. This option corresponds to the clang flag 727aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-option. 728aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 729aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayOption = 0x08, 730aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 731aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 732aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the category number associated with this diagnostic, if any. 733aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 734aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The category number is displayed within brackets after the diagnostic text. 735aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * This option corresponds to the clang flag 736aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-category=id. 737aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 738aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayCategoryId = 0x10, 739aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 740aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor /** 741aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Display the category name associated with this diagnostic, if any. 742aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 743aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * The category name is displayed within brackets after the diagnostic text. 744aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * This option corresponds to the clang flag 745aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c -fdiagnostics-show-category=name. 746aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 747aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXDiagnostic_DisplayCategoryName = 0x20 7480a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor}; 7490a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 7500a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 751274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \brief Format the given diagnostic in a manner that is suitable for display. 7520a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 753274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * This routine will format the given diagnostic to a string, rendering 754896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the diagnostic according to the various options given. The 755896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \c clang_defaultDiagnosticDisplayOptions() function returns the set of 7560a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * options that most closely mimics the behavior of the clang compiler. 7570a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 7580a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \param Diagnostic The diagnostic to print. 7590a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 760896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Options A set of options that control the diagnostic display, 7610a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * created by combining \c CXDiagnosticDisplayOptions values. 762274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * 763274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor * \returns A new string containing for formatted diagnostic. 7640a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 765274f1906f12ebf8fcc179701deeda6d3271120c1Douglas GregorCINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic, 766274f1906f12ebf8fcc179701deeda6d3271120c1Douglas Gregor unsigned Options); 7670a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 7680a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 7690a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \brief Retrieve the set of display options most similar to the 7700a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * default behavior of the clang compiler. 7710a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * 7720a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * \returns A set of display options suitable for use with \c 7730a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor * clang_displayDiagnostic(). 7740a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor */ 7750a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void); 7760a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 7770a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor/** 7785352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the severity of the given diagnostic. 7795352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 780896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE enum CXDiagnosticSeverity 7815352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getDiagnosticSeverity(CXDiagnostic); 7825352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 7835352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7845352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the source location of the given diagnostic. 7855352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 7865352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * This location is where Clang would print the caret ('^') when 7875352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * displaying the diagnostic on the command line. 7885352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 7895352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic); 7905352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 7915352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 7925352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Retrieve the text of the given diagnostic. 7935352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 7945352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic); 795a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor 796a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor/** 797aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the name of the command-line option that enabled this 798aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostic. 799aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 800aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Diag The diagnostic to be queried. 801aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 802aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Disable If non-NULL, will be set to the option that disables this 803aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostic (if any). 804aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 805aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns A string that contains the command-line option used to enable this 806aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * warning, such as "-Wconversion" or "-pedantic". 807aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 808aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag, 809aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor CXString *Disable); 810aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 811aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 812aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \brief Retrieve the category number for this diagnostic. 813aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 814aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * Diagnostics can be categorized into groups along with other, related 815aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * diagnostics (e.g., diagnostics under the same warning flag). This routine 816aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * retrieves the category number for the given diagnostic. 817aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 818aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns The number of the category that contains this diagnostic, or zero 819aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * if this diagnostic is uncategorized. 820aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 821aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic); 822aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 823aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 82478d5d3bb9386a5aa31d19445eb8f81bf2652acb4Ted Kremenek * \brief Retrieve the name of a particular diagnostic category. This 82578d5d3bb9386a5aa31d19445eb8f81bf2652acb4Ted Kremenek * is now deprecated. Use clang_getDiagnosticCategoryText() 82678d5d3bb9386a5aa31d19445eb8f81bf2652acb4Ted Kremenek * instead. 827aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 828aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \param Category A diagnostic category number, as returned by 829aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \c clang_getDiagnosticCategory(). 830aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * 831aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor * \returns The name of the given diagnostic category. 832aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor */ 83378d5d3bb9386a5aa31d19445eb8f81bf2652acb4Ted KremenekCINDEX_DEPRECATED CINDEX_LINKAGE 83478d5d3bb9386a5aa31d19445eb8f81bf2652acb4Ted KremenekCXString clang_getDiagnosticCategoryName(unsigned Category); 83578d5d3bb9386a5aa31d19445eb8f81bf2652acb4Ted Kremenek 83678d5d3bb9386a5aa31d19445eb8f81bf2652acb4Ted Kremenek/** 83778d5d3bb9386a5aa31d19445eb8f81bf2652acb4Ted Kremenek * \brief Retrieve the diagnostic category text for a given diagnostic. 83878d5d3bb9386a5aa31d19445eb8f81bf2652acb4Ted Kremenek * 83978d5d3bb9386a5aa31d19445eb8f81bf2652acb4Ted Kremenek * \returns The text of the given diagnostic category. 84078d5d3bb9386a5aa31d19445eb8f81bf2652acb4Ted Kremenek */ 84178d5d3bb9386a5aa31d19445eb8f81bf2652acb4Ted KremenekCINDEX_LINKAGE CXString clang_getDiagnosticCategoryText(CXDiagnostic); 842aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor 843aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor/** 844a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Determine the number of source ranges associated with the given 845a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * diagnostic. 846a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor */ 847a3890baf1256ff26081306c7fef70202f8223f41Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic); 848896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 8495352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 850a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \brief Retrieve a source range associated with the diagnostic. 8515352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 852a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * A diagnostic's source ranges highlight important elements in the source 8535352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * code. On the command line, Clang displays source ranges by 854896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * underlining them with '~' characters. 8555352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 856a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \param Diagnostic the diagnostic whose range is being extracted. 8575352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 858896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \param Range the zero-based index specifying which range to 8595352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 860a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor * \returns the requested source range. 8615352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 862896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic, 863a3890baf1256ff26081306c7fef70202f8223f41Douglas Gregor unsigned Range); 8645352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 8655352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 8665352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Determine the number of fix-it hints associated with the 8675352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * given diagnostic. 8685352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 8695352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic); 8705352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 8715352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 872473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \brief Retrieve the replacement information for a given fix-it. 8735352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 874473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * Fix-its are described in terms of a source range whose contents 875473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * should be replaced by a string. This approach generalizes over 876473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * three kinds of operations: removal of source code (the range covers 877473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * the code to be removed and the replacement string is empty), 878473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replacement of source code (the range covers the code to be 879473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced and the replacement string provides the new code), and 880473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion (both the start and end of the range point at the 881473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insertion location, and the replacement string provides the text to 882473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * insert). 8835352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 884473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param Diagnostic The diagnostic whose fix-its are being queried. 8855352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 886473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param FixIt The zero-based index of the fix-it. 8875352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 888473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \param ReplacementRange The source range whose contents will be 889473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced with the returned replacement string. Note that source 890473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * ranges are half-open ranges [a, b), so the source code should be 891473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * replaced from a and up to (but not including) b. 8925352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 893473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * \returns A string containing text that should be replace the source 894473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor * code indicated by the \c ReplacementRange. 8955352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 896896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic, 897473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor unsigned FixIt, 898473d7019bb54f8a2f0140dca9e9644a935cc6b20Douglas Gregor CXSourceRange *ReplacementRange); 8995352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 9005352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 9015352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 9025352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 9035352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 9045352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 9055352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation 9065352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 9075352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * The routines in this group provide the ability to create and destroy 9085352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * translation units from files, either by parsing the contents of the files or 9095352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * by reading in a serialized representation of a translation unit. 9105352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 9115352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @{ 9125352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 913896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 9145352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 9155352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Get the original translation unit source file name. 9165352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 9175352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXString 9185352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregorclang_getTranslationUnitSpelling(CXTranslationUnit CTUnit); 9195352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 9205352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 9215352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Return the CXTranslationUnit for a given source file and the provided 9225352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * command line arguments one would pass to the compiler. 9235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 9245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: The 'source_filename' argument is optional. If the caller provides a 9255352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * NULL pointer, the name of the source file is expected to reside in the 9265352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * specified command line arguments. 9275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 9285352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * Note: When encountered in 'clang_command_line_args', the following options 9295352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * are ignored: 9305352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 9315352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-c' 9325352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-emit-ast' 9335352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * '-fsyntax-only' 9347eee0184570366285589d788bcd7f5dda8345915James Dennett * '-o \<output file>' (both '-o' and '\<output file>' are ignored) 9355352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 9361ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param CIdx The index object with which the translation unit will be 9371ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * associated. 9385352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 9397eee0184570366285589d788bcd7f5dda8345915James Dennett * \param source_filename The name of the source file to load, or NULL if the 9401ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * source file is included in \p clang_command_line_args. 9411ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * 9421ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param num_clang_command_line_args The number of command-line arguments in 9431ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \p clang_command_line_args. 9441ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * 9451ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * \param clang_command_line_args The command-line arguments that would be 9461ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * passed to the \c clang executable if it were being invoked out-of-process. 9471ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * These command-line options will be parsed and will affect how the translation 9481ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * unit is parsed. Note that the following options are ignored: '-c', 9497eee0184570366285589d788bcd7f5dda8345915James Dennett * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'. 9505352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 9515352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 9525352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * unsaved_files. 9535352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * 9545352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 9555352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * but may be required for code completion, including the contents of 956c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * those files. The contents and name of these files (as specified by 957c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * CXUnsavedFile) are copied when necessary, so the client only needs to 958c6f530defd937faa1c00998e60deea6368526961Ted Kremenek * guarantee their validity until the call to this function returns. 9595352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 9605352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile( 9615352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor CXIndex CIdx, 9625352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor const char *source_filename, 9635352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor int num_clang_command_line_args, 9642ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *clang_command_line_args, 9655352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor unsigned num_unsaved_files, 966a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor struct CXUnsavedFile *unsaved_files); 967896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 9685352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 9695352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Create a translation unit from an AST file (-emit-ast). 9705352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 971896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(CXIndex, 972a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const char *ast_filename); 9735352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor 97444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor/** 97544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Flags that control the creation of translation units. 97644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 97744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * The enumerators in this enumeration type are meant to be bitwise 97844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * ORed together to specify which options should be used when 97944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * constructing the translation unit. 98044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 9815a43021ac491bf091494167127772a20d9a9bb48Douglas Gregorenum CXTranslationUnit_Flags { 9825a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 9835a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that no special translation-unit options are 9845a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * needed. 9855a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 9865a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor CXTranslationUnit_None = 0x0, 9875a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 9885a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor /** 9895a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Used to indicate that the parser should construct a "detailed" 9905a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * preprocessing record, including all macro definitions and instantiations. 9915a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 9925a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * Constructing a detailed preprocessing record requires more memory 9935a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * and time to parse, since the information contained in the record 9945a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is usually not retained. However, it can be useful for 9955a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * applications that require more detailed information about the 9965a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * behavior of the preprocessor. 9975a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 99844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor CXTranslationUnit_DetailedPreprocessingRecord = 0x01, 99944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 100044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 1001b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Used to indicate that the translation unit is incomplete. 100244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 1003b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * When a translation unit is considered "incomplete", semantic 1004b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * analysis that is typically performed at the end of the 1005b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * translation unit will be suppressed. For example, this suppresses 1006b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * the completion of tentative declarations in C and of 1007b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * instantiation of implicitly-instantiation function templates in 1008b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * C++. This option is typically used when parsing a header with the 1009b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * intent of producing a precompiled header. 101044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 1011b1c031be513705d924038f497279b9b599868ba1Douglas Gregor CXTranslationUnit_Incomplete = 0x02, 101244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 101344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor /** 101444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * \brief Used to indicate that the translation unit should be built with an 101544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header for the preamble. 101644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * 101744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * An implicit precompiled header is used as an optimization when a 101844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * particular translation unit is likely to be reparsed many times 101944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * when the sources aren't changing that often. In this case, an 102044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * implicit precompiled header will be built containing all of the 102144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * initial includes at the top of the main file (what we refer to as 102244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * the "preamble" of the file). In subsequent parses, if the 102344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * preamble or the files in it have not changed, \c 102444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * clang_reparseTranslationUnit() will re-use the implicit 102544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor * precompiled header to improve parsing performance. 102644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor */ 1027e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXTranslationUnit_PrecompiledPreamble = 0x04, 1028e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 1029e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 1030e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that the translation unit should cache some 1031e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion results with each reparse of the source file. 1032e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1033e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * Caching of code-completion results is a performance optimization that 1034e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * introduces some overhead to reparsing but improves the performance of 1035e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * code-completion operations. 1036e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 103799ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CacheCompletionResults = 0x08, 103899ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 1039b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * \brief DEPRECATED: Enable precompiled preambles in C++. 104099ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 104199ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 1042b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * we are testing C++ precompiled preamble support. It is deprecated. 104399ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 104499ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor CXTranslationUnit_CXXPrecompiledPreamble = 0x10, 104599ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor 104699ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor /** 1047b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * \brief DEPRECATED: Enabled chained precompiled preambles in C++. 104899ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * 104999ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor * Note: this is a *temporary* option that is available only while 1050b5af843a20e237ad1a13ad66a867e200695b8c8eDouglas Gregor * we are testing C++ precompiled preamble support. It is deprecated. 105199ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor */ 10526a91d385618ea4d28236c496f540a26877c95525Erik Verbruggen CXTranslationUnit_CXXChainedPCH = 0x20, 10536a91d385618ea4d28236c496f540a26877c95525Erik Verbruggen 10546a91d385618ea4d28236c496f540a26877c95525Erik Verbruggen /** 10556a91d385618ea4d28236c496f540a26877c95525Erik Verbruggen * \brief Used to indicate that function/method bodies should be skipped while 10566a91d385618ea4d28236c496f540a26877c95525Erik Verbruggen * parsing. 10576a91d385618ea4d28236c496f540a26877c95525Erik Verbruggen * 10586a91d385618ea4d28236c496f540a26877c95525Erik Verbruggen * This option can be used to search for declarations/definitions while 10596a91d385618ea4d28236c496f540a26877c95525Erik Verbruggen * ignoring the usages. 10606a91d385618ea4d28236c496f540a26877c95525Erik Verbruggen */ 1061d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko CXTranslationUnit_SkipFunctionBodies = 0x40, 1062d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko 1063d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko /** 1064d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko * \brief Used to indicate that brief documentation comments should be 1065d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko * included into the set of code completions returned from this translation 1066d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko * unit. 1067d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko */ 1068d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko CXTranslationUnit_IncludeBriefCommentsInCodeCompletion = 0x80 10695a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor}; 10705a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 10715a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor/** 1072b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * \brief Returns the set of flags that is suitable for parsing a translation 1073b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * unit that is being edited. 1074b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * 1075b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * The set of flags returned provide options for \c clang_parseTranslationUnit() 1076b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * to indicate that the translation unit is likely to be reparsed many times, 1077b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly 1078b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag 1079b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set contains an unspecified set of optimizations (e.g., the precompiled 1080b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * preamble) geared toward improving the performance of these routines. The 1081b1c031be513705d924038f497279b9b599868ba1Douglas Gregor * set of optimizations enabled may change from one version to the next. 1082b1c031be513705d924038f497279b9b599868ba1Douglas Gregor */ 1083e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void); 1084b1c031be513705d924038f497279b9b599868ba1Douglas Gregor 1085b1c031be513705d924038f497279b9b599868ba1Douglas Gregor/** 10865a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \brief Parse the given source file and the translation unit corresponding 10875a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * to that file. 10885a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10895a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * This routine is the main entry point for the Clang C API, providing the 10905a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * ability to parse a source file into a translation unit that can then be 10915a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * queried by other functions in the API. This routine accepts a set of 10925a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * command-line arguments so that the compilation can be configured in the same 10935a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * way that the compiler is configured on the command line. 10945a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10955a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param CIdx The index object with which the translation unit will be 10965a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * associated. 10975a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 10985a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param source_filename The name of the source file to load, or NULL if the 10991ddb02cabd4374bcbe9afdff5123be0be8e32d12Ted Kremenek * source file is included in \p command_line_args. 11005a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 11015a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param command_line_args The command-line arguments that would be 11025a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * passed to the \c clang executable if it were being invoked out-of-process. 11035a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * These command-line options will be parsed and will affect how the translation 11045a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unit is parsed. Note that the following options are ignored: '-c', 11057eee0184570366285589d788bcd7f5dda8345915James Dennett * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'. 11065a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 11075a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_command_line_args The number of command-line arguments in 11085a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \p command_line_args. 11095a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 11105a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param unsaved_files the files that have not yet been saved to disk 11111abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing, including the contents of 11125a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * those files. The contents and name of these files (as specified by 11135a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 11145a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * guarantee their validity until the call to this function returns. 11155a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 11165a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param num_unsaved_files the number of unsaved file entries in \p 11175a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * unsaved_files. 11185a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 11195a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \param options A bitmask of options that affects how the translation unit 11205a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * is managed but not its compilation. This should be a bitwise OR of the 11215a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * CXTranslationUnit_XXX flags. 11225a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * 11235a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * \returns A new translation unit describing the parsed code and containing 11245a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * any diagnostics produced by the compiler. If there is a failure from which 11255a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor * the compiler cannot recover, returns NULL. 11265a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor */ 11275a43021ac491bf091494167127772a20d9a9bb48Douglas GregorCINDEX_LINKAGE CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx, 11285a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor const char *source_filename, 11292ef6944d529c94824f5bf96f65665f5bee30f5a2Douglas Gregor const char * const *command_line_args, 11305a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor int num_command_line_args, 11315a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor struct CXUnsavedFile *unsaved_files, 11325a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned num_unsaved_files, 11335a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor unsigned options); 11345a43021ac491bf091494167127772a20d9a9bb48Douglas Gregor 11355352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 11361999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Flags that control how translation units are saved. 11371999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 11381999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 11391999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * ORed together to specify which options should be used when 11401999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * saving the translation unit. 11411999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 11421999844e7a18786e61e619e1dc6c789827541863Douglas Gregorenum CXSaveTranslationUnit_Flags { 11431999844e7a18786e61e619e1dc6c789827541863Douglas Gregor /** 11441999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Used to indicate that no special saving options are needed. 11451999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 11461999844e7a18786e61e619e1dc6c789827541863Douglas Gregor CXSaveTranslationUnit_None = 0x0 11471999844e7a18786e61e619e1dc6c789827541863Douglas Gregor}; 11481999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 11491999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 11501999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \brief Returns the set of flags that is suitable for saving a translation 11511999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * unit. 11521999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 11531999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * The set of flags returned provide options for 11541999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \c clang_saveTranslationUnit() by default. The returned flag 11551999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * set contains an unspecified set of options that save translation units with 11561999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * the most commonly-requested data. 11571999844e7a18786e61e619e1dc6c789827541863Douglas Gregor */ 11581999844e7a18786e61e619e1dc6c789827541863Douglas GregorCINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU); 11591999844e7a18786e61e619e1dc6c789827541863Douglas Gregor 11601999844e7a18786e61e619e1dc6c789827541863Douglas Gregor/** 116139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Describes the kind of error that occurred (if any) in a call to 116239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \c clang_saveTranslationUnit(). 116339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 116439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregorenum CXSaveError { 116539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 116639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that no error occurred while saving a translation unit. 116739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 116839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_None = 0, 116939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 117039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 117139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that an unknown error occurred while attempting to save 117239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * the file. 117339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * 117439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * This error typically indicates that file I/O failed when attempting to 117539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * write the file. 117639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 117739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_Unknown = 1, 117839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 117939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 118039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that errors during translation prevented this attempt 118139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * to save the translation unit. 118239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * 118339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * Errors that prevent the translation unit from being saved can be 118439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic(). 118539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 118639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_TranslationErrors = 2, 118739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 118839c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /** 118939c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \brief Indicates that the translation unit to be saved was somehow 119039c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * invalid (e.g., NULL). 119139c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor */ 119239c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor CXSaveError_InvalidTU = 3 119339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor}; 119439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor 119539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor/** 11967ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \brief Saves a translation unit into a serialized representation of 11977ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * that translation unit on disk. 11987ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 11997ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * Any translation unit that was parsed without error can be saved 12007ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * into a file. The translation unit can then be deserialized into a 12017ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * new \c CXTranslationUnit with \c clang_createTranslationUnit() or, 12027ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * if it is an incomplete translation unit that corresponds to a 12037ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * header, used as a precompiled header when parsing other translation 12047ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * units. 12057ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 12067ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param TU The translation unit to save. 12071999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 12087ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * \param FileName The file to which the translation unit will be saved. 12097ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor * 12101999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * \param options A bitmask of options that affects how the translation unit 12111999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * is saved. This should be a bitwise OR of the 12121999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * CXSaveTranslationUnit_XXX flags. 12131999844e7a18786e61e619e1dc6c789827541863Douglas Gregor * 121439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * \returns A value that will match one of the enumerators of the CXSaveError 121539c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * enumeration. Zero (CXSaveError_None) indicates that the translation unit was 121639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor * saved successfully, while a non-zero value indicates that a problem occurred. 12177ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor */ 12187ae2faafd30524ef5f863bb3b8701977888839bbDouglas GregorCINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU, 12191999844e7a18786e61e619e1dc6c789827541863Douglas Gregor const char *FileName, 12201999844e7a18786e61e619e1dc6c789827541863Douglas Gregor unsigned options); 12217ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 12227ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor/** 12235352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * \brief Destroy the specified CXTranslationUnit object. 12245352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 12255352ac06d8f6194825bb2a99ffa009b61bafb503Douglas GregorCINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit); 1226896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 12275352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 1228e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Flags that control the reparsing of translation units. 1229e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1230e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The enumerators in this enumeration type are meant to be bitwise 1231e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * ORed together to specify which options should be used when 1232e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * reparsing the translation unit. 1233e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1234e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregorenum CXReparse_Flags { 1235e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor /** 1236e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Used to indicate that no special reparsing options are needed. 1237e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1238e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor CXReparse_None = 0x0 1239e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor}; 1240e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 1241e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 1242e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \brief Returns the set of flags that is suitable for reparsing a translation 1243e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * unit. 1244e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1245e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The set of flags returned provide options for 1246e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \c clang_reparseTranslationUnit() by default. The returned flag 1247e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * set contains an unspecified set of optimizations geared toward common uses 1248e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * of reparsing. The set of optimizations enabled may change from one version 1249e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * to the next. 1250e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor */ 1251e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas GregorCINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU); 1252e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor 1253e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor/** 1254abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \brief Reparse the source files that produced this translation unit. 1255abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1256abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * This routine can be used to re-parse the source files that originally 1257abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * created the given translation unit, for example because those source files 1258abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * have changed (either on disk or as passed via \p unsaved_files). The 1259abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * source code will be reparsed with the same command-line options as it 1260abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * was originally parsed. 1261abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1262abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * Reparsing a translation unit invalidates all cursors and source locations 1263abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * that refer into that translation unit. This makes reparsing a translation 1264abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit semantically equivalent to destroying the translation unit and then 1265abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * creating a new translation unit with the same command-line arguments. 1266abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * However, it may be more efficient to reparse a translation 1267abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unit using this routine. 1268abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1269abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param TU The translation unit whose contents will be re-parsed. The 1270abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * translation unit must originally have been built with 1271abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_createTranslationUnitFromSourceFile(). 1272abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1273abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 1274abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * unsaved_files. 1275abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1276abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \param unsaved_files The files that have not yet been saved to disk 1277abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * but may be required for parsing, including the contents of 1278abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * those files. The contents and name of these files (as specified by 1279abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * CXUnsavedFile) are copied when necessary, so the client only needs to 1280abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * guarantee their validity until the call to this function returns. 1281abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * 1282e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * \param options A bitset of options composed of the flags in CXReparse_Flags. 1283e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * The function \c clang_defaultReparseOptions() produces a default set of 1284e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * options recommended for most uses, based on the translation unit. 1285e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor * 1286abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \returns 0 if the sources could be reparsed. A non-zero value will be 1287abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * returned if reparsing was impossible, such that the translation unit is 1288abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * invalid. In such cases, the only valid call for \p TU is 1289abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor * \c clang_disposeTranslationUnit(TU). 1290abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor */ 1291abc563f554951259bbe0315055cad92ee14d87e4Douglas GregorCINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU, 1292abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned num_unsaved_files, 1293e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor struct CXUnsavedFile *unsaved_files, 1294e1e13bf568a7e37c95eda6fcfa626659a06e67b1Douglas Gregor unsigned options); 129559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 129659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 129759fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Categorizes how memory is being used by a translation unit. 129859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1299f787002478f09af1741fb0f82a562002e6799c49Ted Kremenekenum CXTUResourceUsageKind { 1300f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_AST = 1, 1301f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_Identifiers = 2, 1302f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_Selectors = 3, 1303f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_GlobalCompletionResults = 4, 1304457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek CXTUResourceUsage_SourceManagerContentCache = 5, 1305ba29bd25515fbd99e98ba0fedb9d93617b27609eTed Kremenek CXTUResourceUsage_AST_SideTables = 6, 1306f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7, 1307e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_SourceManager_Membuffer_MMap = 8, 1308e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9, 1309e9b5f3d4acfc2ad6e8b65a4072464e997dea9ed3Ted Kremenek CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10, 13105e1db6a434d0e3fe0fbde0bca2ec44552818fb22Ted Kremenek CXTUResourceUsage_Preprocessor = 11, 13115e1db6a434d0e3fe0fbde0bca2ec44552818fb22Ted Kremenek CXTUResourceUsage_PreprocessingRecord = 12, 1312ca7dc2b755eb81ac95121ce1a1f1aa44a4a0fe12Ted Kremenek CXTUResourceUsage_SourceManager_DataStructures = 13, 1313d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Preprocessor_HeaderSearch = 14, 1314f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST, 1315f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_MEMORY_IN_BYTES_END = 1316d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Preprocessor_HeaderSearch, 1317f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek 1318f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsage_First = CXTUResourceUsage_AST, 1319d1194fbbf65374bfa3578eb40a547e4f97b497d1Ted Kremenek CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch 132059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek}; 132159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 132259fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 132359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Returns the human-readable null-terminated C string that represents 1324f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek * the name of the memory category. This string should never be freed. 132559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 132659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted KremenekCINDEX_LINKAGE 1327f787002478f09af1741fb0f82a562002e6799c49Ted Kremenekconst char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind); 132859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1329f787002478f09af1741fb0f82a562002e6799c49Ted Kremenektypedef struct CXTUResourceUsageEntry { 133059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief The memory usage category. */ 1331f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek enum CXTUResourceUsageKind kind; 1332f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek /* \brief Amount of resources used. 1333f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek The units will depend on the resource kind. */ 133459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek unsigned long amount; 1335f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek} CXTUResourceUsageEntry; 133659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 133759fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 133859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief The memory usage of a CXTranslationUnit, broken into categories. 133959fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1340f787002478f09af1741fb0f82a562002e6799c49Ted Kremenektypedef struct CXTUResourceUsage { 134159fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief Private data member, used for queries. */ 134259fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek void *data; 134359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 134459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief The number of entries in the 'entries' array. */ 134559fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek unsigned numEntries; 134659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 134759fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek /* \brief An array of key-value pairs, representing the breakdown of memory 134859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek usage. */ 1349f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek CXTUResourceUsageEntry *entries; 135059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1351f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek} CXTUResourceUsage; 135259fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 135359fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek/** 135459fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek * \brief Return the memory usage of a translation unit. This object 1355f787002478f09af1741fb0f82a562002e6799c49Ted Kremenek * should be released with clang_disposeCXTUResourceUsage(). 135659fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek */ 1357f787002478f09af1741fb0f82a562002e6799c49Ted KremenekCINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU); 135859fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1359f787002478f09af1741fb0f82a562002e6799c49Ted KremenekCINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage); 136059fc1e55da9c856d1703d3d3ac14a36320d26b30Ted Kremenek 1361abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor/** 13625352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor * @} 13635352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor */ 1364896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 13655352ac06d8f6194825bb2a99ffa009b61bafb503Douglas Gregor/** 1366c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes the kind of entity that a cursor refers to. 1367c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1368c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXCursorKind { 1369c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Declarations */ 13701efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1371c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A declaration whose specific kind is not exposed via this 13721efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 1373c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1374c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed declarations have the same operations as any other kind 1375c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of declaration; one can extract their location information, 1376c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, find their definitions, etc. However, the specific kind 1377c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of the declaration is not reported. 1378c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1379c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedDecl = 1, 1380c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ struct. */ 13811efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_StructDecl = 2, 1382c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C or C++ union. */ 1383c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnionDecl = 3, 1384c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A C++ class. */ 1385c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ClassDecl = 4, 1386c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumeration. */ 1387c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumDecl = 5, 13881efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 1389c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A field (in C) or non-static data member (in C++) in a 1390c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * struct, union, or C++ class. 1391c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1392c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FieldDecl = 6, 1393c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An enumerator constant. */ 1394c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_EnumConstantDecl = 7, 1395c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function. */ 1396c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FunctionDecl = 8, 1397c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A variable. */ 1398c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_VarDecl = 9, 1399c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A function or method parameter. */ 1400c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ParmDecl = 10, 140117d26a6c1f2cb921d0000c337b4967699dc928fdJames Dennett /** \brief An Objective-C \@interface. */ 1402c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInterfaceDecl = 11, 140317d26a6c1f2cb921d0000c337b4967699dc928fdJames Dennett /** \brief An Objective-C \@interface for a category. */ 1404c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryDecl = 12, 140517d26a6c1f2cb921d0000c337b4967699dc928fdJames Dennett /** \brief An Objective-C \@protocol declaration. */ 1406c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolDecl = 13, 140717d26a6c1f2cb921d0000c337b4967699dc928fdJames Dennett /** \brief An Objective-C \@property declaration. */ 1408c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCPropertyDecl = 14, 1409c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance variable. */ 1410c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCIvarDecl = 15, 1411c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C instance method. */ 1412c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCInstanceMethodDecl = 16, 1413c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An Objective-C class method. */ 1414c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassMethodDecl = 17, 141517d26a6c1f2cb921d0000c337b4967699dc928fdJames Dennett /** \brief An Objective-C \@implementation. */ 1416c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCImplementationDecl = 18, 141717d26a6c1f2cb921d0000c337b4967699dc928fdJames Dennett /** \brief An Objective-C \@implementation for a category. */ 1418c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCCategoryImplDecl = 19, 1419c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief A typedef */ 1420c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypedefDecl = 20, 14218bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek /** \brief A C++ class method. */ 14228bd5a69999cfd06b6b5a58fdd04e4f802b2df5a4Ted Kremenek CXCursor_CXXMethod = 21, 14238f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek /** \brief A C++ namespace. */ 14248f06e0e9fec3ca501e5fb129f413adbfc88e82f8Ted Kremenek CXCursor_Namespace = 22, 1425a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek /** \brief A linkage specification, e.g. 'extern "C"'. */ 1426a0536d8dd900bb48ea886bd68d777b03b061c068Ted Kremenek CXCursor_LinkageSpec = 23, 142701829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ constructor. */ 142801829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Constructor = 24, 142901829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ destructor. */ 143001829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_Destructor = 25, 143101829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor /** \brief A C++ conversion function. */ 143201829d3afafdfd355cbe93537bc408aeeed964c6Douglas Gregor CXCursor_ConversionFunction = 26, 1433fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template type parameter. */ 1434fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTypeParameter = 27, 1435fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ non-type template parameter. */ 1436fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_NonTypeTemplateParameter = 28, 1437fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ template template parameter. */ 1438fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_TemplateTemplateParameter = 29, 1439fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor /** \brief A C++ function template. */ 1440fe72e9ceeae6cc8669cd8bb722425300190638eaDouglas Gregor CXCursor_FunctionTemplate = 30, 144139d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor /** \brief A C++ class template. */ 144239d6f07b056c31e1e6b5946165ed4b23e7887f22Douglas Gregor CXCursor_ClassTemplate = 31, 144374dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor /** \brief A C++ class template partial specialization. */ 144474dbe640021d96a8dbb85c592471c04449ade81cDouglas Gregor CXCursor_ClassTemplatePartialSpecialization = 32, 14456931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** \brief A C++ namespace alias declaration. */ 14466931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceAlias = 33, 14470a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor /** \brief A C++ using directive. */ 14480a35bceb7768fc0be62cb644a4e31d8bfd9fb44aDouglas Gregor CXCursor_UsingDirective = 34, 1449162e1c1b487352434552147967c3dd296ebee2f7Richard Smith /** \brief A C++ using declaration. */ 14507e24256c95afb64b4d5abf201a0f9f0527cb4cf3Douglas Gregor CXCursor_UsingDeclaration = 35, 1451162e1c1b487352434552147967c3dd296ebee2f7Richard Smith /** \brief A C++ alias declaration */ 1452162e1c1b487352434552147967c3dd296ebee2f7Richard Smith CXCursor_TypeAliasDecl = 36, 14537eee0184570366285589d788bcd7f5dda8345915James Dennett /** \brief An Objective-C \@synthesize definition. */ 1454352697a87bca664356f21a838b162084013625eaDouglas Gregor CXCursor_ObjCSynthesizeDecl = 37, 14557eee0184570366285589d788bcd7f5dda8345915James Dennett /** \brief An Objective-C \@dynamic definition. */ 1456352697a87bca664356f21a838b162084013625eaDouglas Gregor CXCursor_ObjCDynamicDecl = 38, 14572dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis /** \brief An access specifier. */ 14582dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis CXCursor_CXXAccessSpecifier = 39, 145942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 146050aa6acd0b8d40c8956372a69e0a73f0802a5494Ted Kremenek CXCursor_FirstDecl = CXCursor_UnexposedDecl, 14612dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis CXCursor_LastDecl = CXCursor_CXXAccessSpecifier, 14621efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1463c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* References */ 1464c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstRef = 40, /* Decl references */ 14651efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor_ObjCSuperClassRef = 40, 1466c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCProtocolRef = 41, 1467c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCClassRef = 42, 1468c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1469c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A reference to a type declaration. 1470c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1471c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A type reference occurs anywhere where a type is named but not 1472c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * declared. For example, given: 1473c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1474c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \code 1475c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * typedef unsigned size_type; 1476c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * size_type size; 1477c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \endcode 1478c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1479c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The typedef is a declaration of size_type (CXCursor_TypedefDecl), 1480c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * while the type of the variable "size" is referenced. The cursor 1481c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * referenced by the type of size is the typedef for size_type. 1482c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1483c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_TypeRef = 43, 14843064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CXCursor_CXXBaseSpecifier = 44, 14850b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor /** 1486a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * \brief A reference to a class template, function template, template 1487a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor * template parameter, or class template partial specialization. 14880b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor */ 14890b36e614aa19df72885d5e0de996f7fbb9874ec3Douglas Gregor CXCursor_TemplateRef = 45, 14906931900f43cea558c6974075256c07728dbfecc6Douglas Gregor /** 14916931900f43cea558c6974075256c07728dbfecc6Douglas Gregor * \brief A reference to a namespace or namespace alias. 14926931900f43cea558c6974075256c07728dbfecc6Douglas Gregor */ 14936931900f43cea558c6974075256c07728dbfecc6Douglas Gregor CXCursor_NamespaceRef = 46, 1494a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor /** 149536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a member of a struct, union, or class that occurs in 149636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * some non-expression context, e.g., a designated initializer. 1497a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor */ 1498a67e03fdf1ae8a1f92463a307d0b6281f1161f40Douglas Gregor CXCursor_MemberRef = 47, 149936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** 150036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \brief A reference to a labeled statement. 150136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 150236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the jump to "start_over" in the 150336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto statement in the following example: 150436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 150536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 150636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 150736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 150836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 150936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * goto start_over; 151036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 151136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 151236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * A label reference cursor refers to a label statement. 151336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 151436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelRef = 48, 151536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 15161f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor /** 15171f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief A reference to a set of overloaded functions or function templates 15181f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * that has not yet been resolved to a specific function or function template. 15191f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 15201f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * An overloaded declaration reference cursor occurs in C++ templates where 15211f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * a dependent name refers to a function. For example: 15221f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 15231f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \code 15241f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> void swap(T&, T&); 15251f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 15261f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct X { ... }; 15271f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(X&, X&); 15281f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 15291f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * template<typename T> 15301f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void reverse(T* first, T* last) { 15311f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * while (first < last - 1) { 15321f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * swap(*first, *--last); 15331f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * ++first; 15341f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 15351f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * } 15361f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 15371f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * struct Y { }; 15381f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * void swap(Y&, Y&); 15391f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \endcode 15401f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 15411f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * Here, the identifier "swap" is associated with an overloaded declaration 15421f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * reference. In the template definition, "swap" refers to either of the two 15431f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * "swap" functions declared above, so both results will be available. At 15441f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * instantiation time, "swap" may also refer to other functions found via 15451f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * argument-dependent lookup (e.g., the "swap" function at the end of the 15461f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * example). 15471f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 15481f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * The functions \c clang_getNumOverloadedDecls() and 15491f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c clang_getOverloadedDecl() can be used to retrieve the definitions 15501f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * referenced by this cursor. 15511f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 15521f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor CXCursor_OverloadedDeclRef = 49, 15531f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 1554011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor /** 1555011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * \brief A reference to a variable that occurs in some non-expression 1556011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * context, e.g., a C++ lambda capture list. 1557011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor */ 1558011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor CXCursor_VariableRef = 50, 1559011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor 1560011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor CXCursor_LastRef = CXCursor_VariableRef, 15611efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1562c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Error conditions */ 1563c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstInvalid = 70, 1564c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_InvalidFile = 70, 1565c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NoDeclFound = 71, 1566c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_NotImplemented = 72, 1567ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_InvalidCode = 73, 1568ebfa339321f8a4df9d5011e591a615d5765107d5Ted Kremenek CXCursor_LastInvalid = CXCursor_InvalidCode, 15691efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1570c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Expressions */ 1571c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstExpr = 100, 15721efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1573c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1574c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression whose specific kind is not exposed via this 15751efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * interface. 1576c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1577c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed expressions have the same operations as any other kind 1578c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * of expression; one can extract their location information, 1579c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * spelling, children, etc. However, the specific kind of the 1580c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * expression is not reported. 1581c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1582c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedExpr = 100, 15831efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1584c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1585c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to some value declaration, such 1586c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * as a function, varible, or enumerator. 1587c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1588c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_DeclRefExpr = 101, 15891efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1590c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1591c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief An expression that refers to a member of a struct, union, 1592c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * class, Objective-C class, etc. 1593c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1594c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_MemberRefExpr = 102, 15951efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1596c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that calls a function. */ 1597c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_CallExpr = 103, 15981efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1599c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** \brief An expression that sends a message to an Objective-C 1600c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor object or class. */ 1601c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_ObjCMessageExpr = 104, 16021ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 16031ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek /** \brief An expression that represents a block literal. */ 16041ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek CXCursor_BlockExpr = 105, 16051ee6cad59f017601ea54fbb4f62a6e8d69897e3eTed Kremenek 160642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An integer literal. 160742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 160842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_IntegerLiteral = 106, 160942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 161042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A floating point number literal. 161142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 161242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_FloatingLiteral = 107, 161342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 161442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An imaginary number literal. 161542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 161642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ImaginaryLiteral = 108, 161742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 161842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A string literal. 161942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 162042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_StringLiteral = 109, 162142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 162242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A character literal. 162342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 162442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CharacterLiteral = 110, 162542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 162642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A parenthesized expression, e.g. "(1)". 162742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 162842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This AST node is only formed if full location information is requested. 162942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 163042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ParenExpr = 111, 163142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 163242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief This represents the unary-expression's (except sizeof and 163342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * alignof). 163442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 163542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_UnaryOperator = 112, 163642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 163742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C99 6.5.2.1] Array Subscripting. 163842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 163942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ArraySubscriptExpr = 113, 164042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 164142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A builtin binary operation expression such as "x + y" or 164242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * "x <= y". 164342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 164442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_BinaryOperator = 114, 164542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 164642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Compound assignment such as "+=". 164742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 164842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CompoundAssignOperator = 115, 164942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 165042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief The ?: ternary operator. 165142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 165242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ConditionalOperator = 116, 165342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 165442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++ 165542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * (C++ [expr.cast]), which uses the syntax (Type)expr. 165642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 165742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * For example: (int)f. 165842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 165942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CStyleCastExpr = 117, 166042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 166142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C99 6.5.2.5] 166242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 166342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CompoundLiteralExpr = 118, 166442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 166542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Describes an C or C++ initializer list. 166642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 166742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_InitListExpr = 119, 166842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 166942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief The GNU address of label extension, representing &&label. 167042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 167142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_AddrLabelExpr = 120, 167242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 167342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief This is the GNU Statement Expression extension: ({int X=4; X;}) 167442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 167542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_StmtExpr = 121, 167642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 1677ffbe9b9c64ab2e94b9d48ec56e511f75826fc80aBenjamin Kramer /** \brief Represents a C11 generic selection. 167842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 167942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_GenericSelectionExpr = 122, 168042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 168142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Implements the GNU __null extension, which is a name for a null 168242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * pointer constant that has integral type (e.g., int or long) and is the same 168342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * size and alignment as a pointer. 168442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 168542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * The __null extension is typically only used by system headers, which define 168642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * NULL as __null in C++ rather than using 0 (which is an integer that may not 168742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * match the size of a pointer). 168842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 168942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_GNUNullExpr = 123, 169042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 169142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s static_cast<> expression. 169242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 169342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXStaticCastExpr = 124, 169442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 169542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s dynamic_cast<> expression. 169642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 169742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXDynamicCastExpr = 125, 169842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 169942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s reinterpret_cast<> expression. 170042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 170142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXReinterpretCastExpr = 126, 170242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 170342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s const_cast<> expression. 170442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 170542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXConstCastExpr = 127, 170642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 170742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents an explicit C++ type conversion that uses "functional" 170842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * notion (C++ [expr.type.conv]). 170942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 171042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * Example: 171142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 171242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * x = int(0.5); 171342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 171442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 171542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXFunctionalCastExpr = 128, 171642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 171742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A C++ typeid expression (C++ [expr.typeid]). 171842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 171942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXTypeidExpr = 129, 172042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 172142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C++ 2.13.5] C++ Boolean Literal. 172242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 172342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXBoolLiteralExpr = 130, 172442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 172542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C++0x 2.14.7] C++ Pointer Literal. 172642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 172742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXNullPtrLiteralExpr = 131, 172842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 172942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents the "this" expression in C++ 173042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 173142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXThisExpr = 132, 173242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 173342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief [C++ 15] C++ Throw Expression. 173442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 173542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This handles 'throw' and 'throw' assignment-expression. When 173642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * assignment-expression isn't present, Op will be null. 173742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 173842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXThrowExpr = 133, 173942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 174042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A new expression for memory allocation and constructor calls, e.g: 174142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * "new CXXNewExpr(foo)". 174242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 174342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXNewExpr = 134, 174442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 174542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A delete expression for memory deallocation and destructor calls, 174642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * e.g. "delete[] pArray". 174742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 174842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXDeleteExpr = 135, 174942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 175042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A unary expression. 175142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 175242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_UnaryExpr = 136, 175342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 17549793e8f72a2d1f420bbbd97d41f7aaf727c26ca6Douglas Gregor /** \brief An Objective-C string literal i.e. @"foo". 175542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 175642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCStringLiteral = 137, 175742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 17587eee0184570366285589d788bcd7f5dda8345915James Dennett /** \brief An Objective-C \@encode expression. 175942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 176042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCEncodeExpr = 138, 176142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 17627eee0184570366285589d788bcd7f5dda8345915James Dennett /** \brief An Objective-C \@selector expression. 176342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 176442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCSelectorExpr = 139, 176542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 176617d26a6c1f2cb921d0000c337b4967699dc928fdJames Dennett /** \brief An Objective-C \@protocol expression. 176742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 176842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCProtocolExpr = 140, 176942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 177042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An Objective-C "bridged" cast expression, which casts between 177142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * Objective-C pointers and C pointers, transferring ownership in the process. 177242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 177342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 177442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * NSString *str = (__bridge_transfer NSString *)CFCreateString(); 177542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 177642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 177742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCBridgedCastExpr = 141, 177842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 177942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents a C++0x pack expansion that produces a sequence of 178042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * expressions. 178142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 178242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * A pack expansion expression contains a pattern (which itself is an 178342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * expression) followed by an ellipsis. For example: 178442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 178542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 178642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * template<typename F, typename ...Types> 178742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * void forward(F f, Types &&...args) { 178842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * f(static_cast<Types&&>(args)...); 178942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * } 179042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 179142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 179242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_PackExpansionExpr = 142, 179342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 179442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Represents an expression that computes the length of a parameter 179542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * pack. 179642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 179742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \code 179842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * template<typename ...Types> 179942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * struct count { 180042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * static const unsigned value = sizeof...(Types); 180142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * }; 180242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * \endcode 180342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 180442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SizeOfPackExpr = 143, 180542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 1806011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor /* \brief Represents a C++ lambda expression that produces a local function 1807011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * object. 1808011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * 1809011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * \code 1810011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * void abssort(float *x, unsigned N) { 1811011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * std::sort(x, x + N, 1812011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * [](float a, float b) { 1813011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * return std::abs(a) < std::abs(b); 1814011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * }); 1815011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * } 1816011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor * \endcode 1817011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor */ 1818011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor CXCursor_LambdaExpr = 144, 1819011d8b93b7cfa8492b8a9c909a850d6577e08dcaDouglas Gregor 1820b3f7542a950ac0d585a7783e825cfe670e05c553Ted Kremenek /** \brief Objective-c Boolean Literal. 1821b3f7542a950ac0d585a7783e825cfe670e05c553Ted Kremenek */ 1822b3f7542a950ac0d585a7783e825cfe670e05c553Ted Kremenek CXCursor_ObjCBoolLiteralExpr = 145, 1823b3f7542a950ac0d585a7783e825cfe670e05c553Ted Kremenek 1824b3f7542a950ac0d585a7783e825cfe670e05c553Ted Kremenek CXCursor_LastExpr = CXCursor_ObjCBoolLiteralExpr, 18251efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1826c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /* Statements */ 1827c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_FirstStmt = 200, 1828c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1829c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A statement whose specific kind is not exposed via this 1830c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * interface. 1831c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1832c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Unexposed statements have the same operations as any other kind of 1833c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * statement; one can extract their location information, spelling, 1834c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * children, etc. However, the specific kind of the statement is not 1835c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reported. 1836c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1837c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursor_UnexposedStmt = 200, 183836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor 183936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor /** \brief A labelled statement in a function. 184036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 184136897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * This cursor kind is used to describe the "start_over:" label statement in 184236897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * the following example: 184336897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 184436897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \code 184536897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * start_over: 184636897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * ++counter; 184736897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * \endcode 184836897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor * 184936897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor */ 185036897b05ca2886e287f01802614bc10cbadcec22Douglas Gregor CXCursor_LabelStmt = 201, 185142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 185242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A group of statements like { stmt stmt }. 185342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 185442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This cursor kind is used to describe compound statements, e.g. function 185542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * bodies. 185642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 185742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CompoundStmt = 202, 185842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 185942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A case statment. 186042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 186142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CaseStmt = 203, 186242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 186342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A default statement. 186442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 186542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_DefaultStmt = 204, 186642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 186742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An if statement 186842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 186942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_IfStmt = 205, 187042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 187142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A switch statement. 187242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 187342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SwitchStmt = 206, 187442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 187542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A while statement. 187642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 187742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_WhileStmt = 207, 187842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 187942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A do statement. 188042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 188142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_DoStmt = 208, 188242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 188342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A for statement. 188442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 188542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ForStmt = 209, 188642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 188742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A goto statement. 188842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 188942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_GotoStmt = 210, 189042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 189142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief An indirect goto statement. 189242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 189342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_IndirectGotoStmt = 211, 189442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 189542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A continue statement. 189642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 189742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ContinueStmt = 212, 189842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 189942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A break statement. 190042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 190142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_BreakStmt = 213, 190242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 190342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A return statement. 190442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 190542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ReturnStmt = 214, 190642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 190742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief A GNU inline assembly statement extension. 190842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 190942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_AsmStmt = 215, 191042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 19117eee0184570366285589d788bcd7f5dda8345915James Dennett /** \brief Objective-C's overall \@try-\@catch-\@finally statement. 191242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 191342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtTryStmt = 216, 191442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 19157eee0184570366285589d788bcd7f5dda8345915James Dennett /** \brief Objective-C's \@catch statement. 191642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 191742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtCatchStmt = 217, 191842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 19197eee0184570366285589d788bcd7f5dda8345915James Dennett /** \brief Objective-C's \@finally statement. 192042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 192142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtFinallyStmt = 218, 192242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 19237eee0184570366285589d788bcd7f5dda8345915James Dennett /** \brief Objective-C's \@throw statement. 192442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 192542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtThrowStmt = 219, 192642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 19277eee0184570366285589d788bcd7f5dda8345915James Dennett /** \brief Objective-C's \@synchronized statement. 192842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 192942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAtSynchronizedStmt = 220, 193042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 193142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's autorelease pool statement. 193242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 193342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCAutoreleasePoolStmt = 221, 193442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 193542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Objective-C's collection statement. 193642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 193742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_ObjCForCollectionStmt = 222, 193842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 193942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s catch statement. 194042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 194142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXCatchStmt = 223, 194242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 194342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s try statement. 194442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 194542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXTryStmt = 224, 194642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 194742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief C++'s for (* : *) statement. 194842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 194942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_CXXForRangeStmt = 225, 195042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 195142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Windows Structured Exception Handling's try statement. 195242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 195342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SEHTryStmt = 226, 195442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 195542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Windows Structured Exception Handling's except statement. 195642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 195742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SEHExceptStmt = 227, 195842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 195942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Windows Structured Exception Handling's finally statement. 196042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 196142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_SEHFinallyStmt = 228, 196242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 19638cd64b4c5553fa6284d248336cb7c82dc960a394Chad Rosier /** \brief A MS inline assembly statement extension. 19648cd64b4c5553fa6284d248336cb7c82dc960a394Chad Rosier */ 19658cd64b4c5553fa6284d248336cb7c82dc960a394Chad Rosier CXCursor_MSAsmStmt = 229, 19668cd64b4c5553fa6284d248336cb7c82dc960a394Chad Rosier 196742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief The null satement ";": C99 6.8.3p3. 196842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * 196942b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * This cursor kind is used to describe the null statement. 197042b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 197142b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_NullStmt = 230, 197242b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 197342b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor /** \brief Adaptor class for mixing declarations with statements and 197442b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor * expressions. 197542b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor */ 197642b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_DeclStmt = 231, 197742b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor 197842b2984771a7fd1b17c78bbb2c59fed3db2f1960Douglas Gregor CXCursor_LastStmt = CXCursor_DeclStmt, 19791efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 1980c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 1981c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Cursor that represents the translation unit itself. 1982c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 1983c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor exists primarily to act as the root 1984c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor for traversing the contents of a translation unit. 1985c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 1986e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_TranslationUnit = 300, 1987e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1988e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /* Attributes */ 1989e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_FirstAttr = 400, 1990e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek /** 1991e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * \brief An attribute whose specific kind is not exposed via this 1992e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek * interface. 1993e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek */ 1994e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_UnexposedAttr = 400, 1995e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek 1996e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBActionAttr = 401, 1997e77f443dbca8cdc23e5aa94a2653367e4a7cbe47Ted Kremenek CXCursor_IBOutletAttr = 402, 1998857e918a8a40deb128840308a318bf623d68295fTed Kremenek CXCursor_IBOutletCollectionAttr = 403, 19996639e9255489ad8e10278d5658fdd4b3c0e1e4cdArgyrios Kyrtzidis CXCursor_CXXFinalAttr = 404, 20006639e9255489ad8e10278d5658fdd4b3c0e1e4cdArgyrios Kyrtzidis CXCursor_CXXOverrideAttr = 405, 20015f1c822def3efffe1d8f7299fbbbc3b1cdd4833dErik Verbruggen CXCursor_AnnotateAttr = 406, 200284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCursor_AsmLabelAttr = 407, 200384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCursor_LastAttr = CXCursor_AsmLabelAttr, 20049f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 20059f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor /* Preprocessing */ 20069f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_PreprocessingDirective = 500, 2007572feb2a190b5e8b04fb06c4ac50ee0f61e93ff0Douglas Gregor CXCursor_MacroDefinition = 501, 20089b2a0ac970a077bdc0bf08c6c682f80ad733c892Chandler Carruth CXCursor_MacroExpansion = 502, 20099b2a0ac970a077bdc0bf08c6c682f80ad733c892Chandler Carruth CXCursor_MacroInstantiation = CXCursor_MacroExpansion, 2010ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_InclusionDirective = 503, 20119f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective, 2012ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor CXCursor_LastPreprocessing = CXCursor_InclusionDirective 2013c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 2014c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2015c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2016c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief A cursor representing some element in the abstract syntax tree for 2017c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a translation unit. 2018c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 20191efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor abstraction unifies the different kinds of entities in a 2020c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * program--declaration, statements, expressions, references to declarations, 2021c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * etc.--under a single "cursor" abstraction with a common set of operations. 2022c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Common operation for a cursor include: getting the physical location in 2023c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * a source file where the cursor points, getting the name associated with a 2024c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor, and retrieving cursors for any child nodes of a particular cursor. 2025c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2026c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors can be produced in two specific ways. 2027c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_getTranslationUnitCursor() produces a cursor for a translation unit, 2028c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * from which one can use clang_visitChildren() to explore the rest of the 2029c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * translation unit. clang_getCursor() maps from a physical source location 2030c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to the entity that resides at that location, allowing one to map from the 2031c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * source code into the AST. 2032c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2033c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregortypedef struct { 2034c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor enum CXCursorKind kind; 2035aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis int xdata; 2036c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor void *data[3]; 20371efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar} CXCursor; 2038c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2039c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2040ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief A comment AST node. 2041ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 2042ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenkotypedef struct { 2043ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko const void *Data; 2044ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko} CXComment; 2045ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 2046ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 2047c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations 2048c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2049c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2050c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 20511efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2052c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2053c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the NULL cursor, which represents no entity. 2054c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2055c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getNullCursor(void); 20561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2057c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2058c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the cursor that represents the given translation unit. 2059c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2060c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The translation unit cursor can be used to start traversing the 2061c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * various declarations within the given translation unit. 2062c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2063c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit); 2064c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2065c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2066c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether two cursors are equivalent. 2067c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2068c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor); 20691efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2070c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2071b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis * \brief Returns non-zero if \arg cursor is null. 2072b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis */ 20735b419362c29b7aa09d9a75a14fe1b11985625bf0Benjamin KramerCINDEX_LINKAGE int clang_Cursor_isNull(CXCursor); 2074b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis 2075b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis/** 20769ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor * \brief Compute a hash value for the given cursor. 20779ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor */ 20789ce5584553054d0cb934940586aca0186e87fa57Douglas GregorCINDEX_LINKAGE unsigned clang_hashCursor(CXCursor); 20799ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor 20809ce5584553054d0cb934940586aca0186e87fa57Douglas Gregor/** 2081c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve the kind of the given cursor. 2082c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2083c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor); 2084c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2085c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2086c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a declaration. 2087c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2088c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind); 2089c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2090c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2091c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a simple 2092c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * reference. 2093c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2094c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Note that other kinds of cursors (such as expressions) can also refer to 2095c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * other cursors. Use clang_getCursorReferenced() to determine whether a 2096c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * particular cursor refers to another entity. 2097c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2098c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind); 2099c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2100c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2101c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents an expression. 2102c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2103c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind); 2104c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2105c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2106c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Determine whether the given cursor kind represents a statement. 2107c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2108c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind); 2109c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2110c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 21118be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor * \brief Determine whether the given cursor kind represents an attribute. 21128be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor */ 21138be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas GregorCINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind); 21148be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor 21158be80e1e6effd5a333bc70e7f030dc9397d0554eDouglas Gregor/** 21161efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents an invalid 2117c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor. 21181efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar */ 2119c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind); 2120c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2121c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 21221efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Determine whether the given cursor kind represents a translation 21231efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unit. 2124c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2125c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind); 21261efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2127ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek/*** 21289f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * \brief Determine whether the given cursor represents a preprocessing 21299f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor * element, such as a preprocessor directive or macro instantiation. 21309f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor */ 21319f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas GregorCINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind); 21329f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor 21339f1e3ff3b3095967e2b92b57a53524e2d6bb141cDouglas Gregor/*** 2134ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * \brief Determine whether the given cursor represents a currently 2135ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt). 2136ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek */ 2137ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted KremenekCINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind); 2138ad6eff611a4391f89fd6c458db16993f76e7f5d0Ted Kremenek 2139c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 214016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief Describe the linkage of the entity referred to by a cursor. 214116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 214216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenekenum CXLinkageKind { 214316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This value indicates that no linkage information is available 214416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * for a provided CXCursor. */ 214516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Invalid, 214616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** 214716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * \brief This is the linkage for variables, parameters, and so on that 214816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * have automatic storage. This covers normal (non-extern) local variables. 214916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 215016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_NoLinkage, 215116b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for static variables and static functions. */ 215216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_Internal, 215316b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with external linkage that live 215416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek * in C++ anonymous namespaces.*/ 215516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_UniqueExternal, 215616b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek /** \brief This is the linkage for entities with true, external linkage. */ 215716b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek CXLinkage_External 215816b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek}; 215916b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 216016b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 216145e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the linkage of the entity referred to by a given cursor. 216216b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek */ 216316b4259aecaa22b642d35d36fd89965ed700c1e0Ted KremenekCINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor); 216416b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek 216516b4259aecaa22b642d35d36fd89965ed700c1e0Ted Kremenek/** 2166cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \brief Determine the availability of the entity that this cursor refers to, 2167cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * taking the current target platform into account. 216858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 216958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param cursor The cursor to query. 217058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 217158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the cursor. 217258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 217358ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 217458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCursorAvailability(CXCursor cursor); 217558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 217658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 2177cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * Describes the availability of a given entity on a particular platform, e.g., 2178cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * a particular class might only be available on Mac OS 10.7 or newer. 2179cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor */ 2180cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregortypedef struct CXPlatformAvailability { 2181cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor /** 2182cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \brief A string that describes the platform for which this structure 2183cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * provides availability information. 2184cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * 2185cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * Possible values are "ios" or "macosx". 2186cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor */ 2187cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor CXString Platform; 2188cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor /** 2189cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \brief The version number in which this entity was introduced. 2190cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor */ 2191cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor CXVersion Introduced; 2192cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor /** 2193cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \brief The version number in which this entity was deprecated (but is 2194cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * still available). 2195cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor */ 2196cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor CXVersion Deprecated; 2197cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor /** 2198cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \brief The version number in which this entity was obsoleted, and therefore 2199cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * is no longer available. 2200cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor */ 2201cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor CXVersion Obsoleted; 2202cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor /** 2203cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \brief Whether the entity is unconditionally unavailable on this platform. 2204cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor */ 2205cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor int Unavailable; 2206cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor /** 2207cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \brief An optional message to provide to a user of this API, e.g., to 2208cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * suggest replacement APIs. 2209cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor */ 2210cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor CXString Message; 2211cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor} CXPlatformAvailability; 2212cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor 2213cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor/** 2214cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \brief Determine the availability of the entity that this cursor refers to 2215cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * on any platforms for which availability information is known. 2216cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * 2217cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \param cursor The cursor to query. 2218cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * 2219cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \param always_deprecated If non-NULL, will be set to indicate whether the 2220cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * entity is deprecated on all platforms. 2221cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * 2222cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \param deprecated_message If non-NULL, will be set to the message text 2223cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * provided along with the unconditional deprecation of this entity. The client 2224cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * is responsible for deallocating this string. 2225cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * 22267eee0184570366285589d788bcd7f5dda8345915James Dennett * \param always_unavailable If non-NULL, will be set to indicate whether the 2227cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * entity is unavailable on all platforms. 2228cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * 2229cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \param unavailable_message If non-NULL, will be set to the message text 2230cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * provided along with the unconditional unavailability of this entity. The 2231cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * client is responsible for deallocating this string. 2232cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * 2233cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \param availability If non-NULL, an array of CXPlatformAvailability instances 2234cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * that will be populated with platform availability information, up to either 2235cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * the number of platforms for which availability information is available (as 2236cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * returned by this function) or \c availability_size, whichever is smaller. 2237cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * 2238cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \param availability_size The number of elements available in the 2239cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \c availability array. 2240cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * 2241cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \returns The number of platforms (N) for which availability information is 2242cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * available (which is unrelated to \c availability_size). 2243cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * 2244cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * Note that the client is responsible for calling 2245cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \c clang_disposeCXPlatformAvailability to free each of the 2246cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * platform-availability structures returned. There are 2247cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \c min(N, availability_size) such structures. 2248cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor */ 2249cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas GregorCINDEX_LINKAGE int 2250cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregorclang_getCursorPlatformAvailability(CXCursor cursor, 2251cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor int *always_deprecated, 2252cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor CXString *deprecated_message, 2253cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor int *always_unavailable, 2254cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor CXString *unavailable_message, 2255cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor CXPlatformAvailability *availability, 2256cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor int availability_size); 2257cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor 2258cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor/** 2259cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor * \brief Free the memory associated with a \c CXPlatformAvailability structure. 2260cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor */ 2261cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas GregorCINDEX_LINKAGE void 2262cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregorclang_disposeCXPlatformAvailability(CXPlatformAvailability *availability); 2263cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor 2264cc889664dec7776ebb598e4584e7df5ba2f59ab4Douglas Gregor/** 226545e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Describe the "language" of the entity referred to by a cursor. 226645e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 226745e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind { 22686cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_Invalid = 0, 226945e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_C, 227045e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek CXLanguage_ObjC, 22716cd1e7cb04d1da66e8b5675062152ff60bbc354fTed Kremenek CXLanguage_CPlusPlus 227245e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek}; 227345e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 227445e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 227545e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek * \brief Determine the "language" of the entity referred to by a given cursor. 227645e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek */ 227745e1dae500bba7a9ef5b8206263a5609c07c6f03Ted KremenekCINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor); 227845e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek 2279b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis/** 2280b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis * \brief Returns the translation unit that a cursor originated from. 2281b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis */ 2282b0d6eaa6b646c18c49923aefc76973801f561701Argyrios KyrtzidisCINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor); 2283b0d6eaa6b646c18c49923aefc76973801f561701Argyrios Kyrtzidis 2284eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2285eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2286eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief A fast container representing a set of CXCursors. 2287eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 2288eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenektypedef struct CXCursorSetImpl *CXCursorSet; 2289eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2290eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2291eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Creates an empty CXCursorSet. 2292eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 2293eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(); 2294eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2295eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2296eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Disposes a CXCursorSet and releases its associated memory. 2297eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek */ 2298eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset); 2299eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2300eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2301eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Queries a CXCursorSet to see if it contains a specific CXCursor. 2302eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * 2303eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \returns non-zero if the set contains the specified cursor. 2304eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek*/ 2305eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset, 2306eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek CXCursor cursor); 2307eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 2308eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek/** 2309eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \brief Inserts a CXCursor into a CXCursorSet. 2310eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * 2311eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek * \returns zero if the CXCursor was already in the set, and non-zero otherwise. 2312eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek*/ 2313eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted KremenekCINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset, 2314eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek CXCursor cursor); 2315eca099bdb0178d408d4f717c2e9627e0d0e673c6Ted Kremenek 23162be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 23172be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the semantic parent of the given cursor. 23182be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 23192be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The semantic parent of a cursor is the cursor that semantically contains 23202be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the given \p cursor. For many declarations, the lexical and semantic parents 23212be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the lexical parent is returned by 23222be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorLexicalParent()). They diverge when declarations or 23232be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 23242be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 23252be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 23262be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 23272be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 23282be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 23292be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 23302be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 23312be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 23322be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 23332be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 23342be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 23352be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 23362be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 23372be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 23382be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 23392be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 23402be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 23412be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 23422be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 23432be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 23442be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 23452be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 23463910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * 23473910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * For global declarations, the semantic parent is the translation unit. 23482be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 23492be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor); 23502be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor 23512be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor/** 23522be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \brief Determine the lexical parent of the given cursor. 23532be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 23542be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * The lexical parent of a cursor is the cursor in which the given \p cursor 23552be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * was actually written. For many declarations, the lexical and semantic parents 23562be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * are equivalent (the semantic parent is returned by 23572be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \c clang_getCursorSemanticParent()). They diverge when declarations or 23582be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * definitions are provided out-of-line. For example: 23592be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 23602be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \code 23612be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * class C { 23622be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void f(); 23632be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * }; 23642be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 23652be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * void C::f() { } 23662be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * \endcode 23672be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 23682be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the out-of-line definition of \c C::f, the semantic parent is the 23692be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the class \c C, of which this function is a member. The lexical parent is 23702be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * the place where the declaration actually occurs in the source code; in this 23712be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * case, the definition occurs in the translation unit. In general, the 23722be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * lexical parent for a given entity can change without affecting the semantics 23732be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of the program, and the lexical parent of different declarations of the 23742be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * same entity may be different. Changing the semantic parent of a declaration, 23752be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * on the other hand, can have a major impact on semantics, and redeclarations 23762be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * of a particular entity should all have the same semantic context. 23772be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * 23782be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * In the example above, both declarations of \c C::f have \c C as their 23792be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * semantic context, while the lexical context of the first \c C::f is \c C 23802be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor * and the lexical context of the second \c C::f is the translation unit. 23813910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * 23823910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * For declarations written in the global scope, the lexical parent is 23833910cfd17fcd99ac80158e625fc63e4784d26435Douglas Gregor * the translation unit. 23842be5bc9ad3981347a000742f81b91ab3080f1214Douglas Gregor */ 23852be5bc9ad3981347a000742f81b91ab3080f1214Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor); 23869f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 23879f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 23889f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Determine the set of methods that are overridden by the given 23899f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. 23909f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 23919f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In both Objective-C and C++, a method (aka virtual member function, 23929f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * in C++) can override a virtual method in a base class. For 23939f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * Objective-C, a method is said to override any method in the class's 2394044e645605c6d75223e33d23e3c5701cb389969fArgyrios Kyrtzidis * base class, its protocols, or its categories' protocols, that has the same 2395044e645605c6d75223e33d23e3c5701cb389969fArgyrios Kyrtzidis * selector and is of the same kind (class or instance). 2396044e645605c6d75223e33d23e3c5701cb389969fArgyrios Kyrtzidis * If no such method exists, the search continues to the class's superclass, 2397044e645605c6d75223e33d23e3c5701cb389969fArgyrios Kyrtzidis * its protocols, and its categories, and so on. A method from an Objective-C 2398044e645605c6d75223e33d23e3c5701cb389969fArgyrios Kyrtzidis * implementation is considered to override the same methods as its 2399044e645605c6d75223e33d23e3c5701cb389969fArgyrios Kyrtzidis * corresponding method in the interface. 24009f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 24019f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * For C++, a virtual member function overrides any virtual member 24029f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * function with the same signature that occurs in its base 24039f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * classes. With multiple inheritance, a virtual member function can 24049f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * override several virtual member functions coming from different 24059f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * base classes. 24069f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 24079f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * In all cases, this function determines the immediate overridden 24089f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method, rather than all of the overridden methods. For example, if 24099f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * a method is originally declared in a class A, then overridden in B 24109f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * (which in inherits from A) and also in C (which inherited from B), 24119f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * then the only overridden method returned from this function when 24129f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoked on C's method will be B's method. The client may then 24139f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * invoke this function again, given the previously-found overridden 24149f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods, to map out the complete method-override set. 24159f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 24169f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param cursor A cursor representing an Objective-C or C++ 24179f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method. This routine will compute the set of methods that this 24189f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * method overrides. 24199f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 24209f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param overridden A pointer whose pointee will be replaced with a 24219f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * pointer to an array of cursors, representing the set of overridden 24229f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * methods. If there are no overridden methods, the pointee will be 24239f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * set to NULL. The pointee must be freed via a call to 24249f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \c clang_disposeOverriddenCursors(). 24259f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * 24269f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \param num_overridden A pointer to the number of overridden 24279f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * functions, will be set to the number of overridden functions in the 24289f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * array pointed to by \p overridden. 24299f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 24309f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor, 24319f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor CXCursor **overridden, 24329f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor unsigned *num_overridden); 24339f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 24349f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor/** 24359f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * \brief Free the set of overridden cursors returned by \c 24369f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor * clang_getOverriddenCursors(). 24379f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor */ 24389f59234a91d057cee7c5e3cee91da8696858c692Douglas GregorCINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden); 24399f59234a91d057cee7c5e3cee91da8696858c692Douglas Gregor 244045e1dae500bba7a9ef5b8206263a5609c07c6f03Ted Kremenek/** 2441ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * \brief Retrieve the file that is included by the given inclusion directive 2442ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor * cursor. 2443ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor */ 2444ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas GregorCINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor); 2445ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor 2446ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor/** 2447c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2448c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 24491efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2450c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2451c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code 2452c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2453c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Cursors represent a location within the Abstract Syntax Tree (AST). These 2454c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines help map between cursors and the physical locations where the 2455c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * described entities occur in the source code. The mapping is provided in 2456c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * both directions, so one can map from source code to the AST and back. 2457c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2458c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 245950398199fb10e196a8d92fbf7a062dbe42ed88fdSteve Naroff */ 24601efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 24616a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff/** 2462b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \brief Map a source location to the cursor that describes the entity at that 2463b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * location in the source code. 2464b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 2465b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() maps an arbitrary source location within a translation 2466b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * unit down to the most specific cursor that describes the entity at that 24671efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * location. For example, given an expression \c x + y, invoking 2468b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * clang_getCursor() with a source location pointing to "x" will return the 24691efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * cursor for "x"; similarly for "y". If the cursor points anywhere between 2470b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor() 2471b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * will return a cursor referring to the "+" expression. 2472b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * 2473b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * \returns a cursor representing the entity at the given source location, or 2474b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas Gregor * a NULL cursor if no such entity can be found. 24756a6de8b4fc944ca1bfa4e47c516d049a0d627b0eSteve Naroff */ 2476b979034b100be14de2223f2b8f6cc7a3275cbe4fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation); 24771efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 247898258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor/** 247998258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * \brief Retrieve the physical location of the source constructor referenced 248098258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * by the given cursor. 248198258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * 248298258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * The location of a declaration is typically the location of the name of that 24831efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * declaration, where the name of that declaration would occur if it is 24841efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * unnamed, or some keyword that introduces that particular declaration. 24851efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The location of a reference is where that reference occurs within the 248698258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor * source code. 248798258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas Gregor */ 248898258afae66bab39b0c57a3efb6b20d4fbb5746cDouglas GregorCINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor); 2489c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2490b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor/** 2491b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Retrieve the physical extent of the source construct referenced by 2492a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the given cursor. 2493a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * 2494a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * The extent of a cursor starts with the file/line/column pointing at the 2495a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * first character within the source construct that the cursor refers to and 24961efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * ends with the last character withinin that source construct. For a 2497a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * declaration, the extent covers the declaration itself. For a reference, 2498a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * the extent covers the location of the reference (e.g., where the referenced 2499a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor * entity was actually used). 2500a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas Gregor */ 2501a7bde20f8c6334ccc3a7ef4dd77243d0921a8497Douglas GregorCINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor); 2502c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor 2503c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2504c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2505c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 250695f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 2507c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 25088e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \defgroup CINDEX_TYPES Type information for CXCursors 25098e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 25108e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @{ 25118e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 25128e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 25138e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 25148e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Describes the kind of type 25158e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 25168e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenekenum CXTypeKind { 25178e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 25188e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Reprents an invalid type (e.g., where no type is available). 25198e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 25208e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Invalid = 0, 25218e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 25228e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /** 25238e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief A type whose specific kind is not exposed via this 25248e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * interface. 25258e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 25268e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Unexposed = 1, 25278e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 25288e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek /* Builtin types */ 25298e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Void = 2, 25308e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Bool = 3, 25318e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_U = 4, 25328e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UChar = 5, 25338e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char16 = 6, 25348e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char32 = 7, 25358e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UShort = 8, 25368e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt = 9, 25378e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULong = 10, 25388e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ULongLong = 11, 25398e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_UInt128 = 12, 25408e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Char_S = 13, 25418e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_SChar = 14, 25428e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_WChar = 15, 25438e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Short = 16, 25448e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int = 17, 25458e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Long = 18, 25468e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongLong = 19, 25478e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Int128 = 20, 25488e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Float = 21, 25498e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Double = 22, 25508e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LongDouble = 23, 25518e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_NullPtr = 24, 25528e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Overload = 25, 25538e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Dependent = 26, 25548e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCId = 27, 25558e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCClass = 28, 25568e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCSel = 29, 25578e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_FirstBuiltin = CXType_Void, 25588e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LastBuiltin = CXType_ObjCSel, 25598e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 25608e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Complex = 100, 25618e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Pointer = 101, 25628e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_BlockPointer = 102, 25638e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_LValueReference = 103, 25648e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_RValueReference = 104, 25658e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Record = 105, 25668e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Enum = 106, 25678e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_Typedef = 107, 25688e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek CXType_ObjCInterface = 108, 256904c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_ObjCObjectPointer = 109, 257004c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek CXType_FunctionNoProto = 110, 25715f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis CXType_FunctionProto = 111, 257284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXType_ConstantArray = 112, 257384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXType_Vector = 113 25748e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek}; 25758e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 25768e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 257784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Describes the calling convention of a function type 257884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 257984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidisenum CXCallingConv { 258084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_Default = 0, 258184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_C = 1, 258284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_X86StdCall = 2, 258384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_X86FastCall = 3, 258484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_X86ThisCall = 4, 258584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_X86Pascal = 5, 258684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_AAPCS = 6, 258784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_AAPCS_VFP = 7, 258884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 258984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_Invalid = 100, 259084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis CXCallingConv_Unexposed = 200 259184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis}; 259284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 259384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 259484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 25958e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief The type of an element in the abstract syntax tree. 25968e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 25978e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 25988e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenektypedef struct { 25998e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek enum CXTypeKind kind; 26008e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek void *data[2]; 26018e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek} CXType; 26028e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 26038e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 26048e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the type of a CXCursor (if any). 26058e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 26068e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCursorType(CXCursor C); 26078e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 26088e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 260984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the underlying type of a typedef declaration. 261084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 261184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If the cursor does not reference a typedef declaration, an invalid type is 261284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * returned. 261384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 261484b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE CXType clang_getTypedefDeclUnderlyingType(CXCursor C); 261584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 261684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 261784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the integer type of an enum declaration. 261884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 261984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If the cursor does not reference an enum declaration, an invalid type is 262084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * returned. 262184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 262284b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE CXType clang_getEnumDeclIntegerType(CXCursor C); 262384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 262484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 262584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the integer value of an enum constant declaration as a signed 262684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * long long. 262784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 262884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned. 262984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * Since this is also potentially a valid constant value, the kind of the cursor 263084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * must be verified before calling this function. 263184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 263284b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE long long clang_getEnumConstantDeclValue(CXCursor C); 263384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 263484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 263584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the integer value of an enum constant declaration as an unsigned 263684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * long long. 263784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 263884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned. 263984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * Since this is also potentially a valid constant value, the kind of the cursor 264084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * must be verified before calling this function. 264184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 264284b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE unsigned long long clang_getEnumConstantDeclUnsignedValue(CXCursor C); 264384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 264484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 2645d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis * \brief Retrieve the number of non-variadic arguments associated with a given 2646d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis * cursor. 2647d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis * 2648d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis * If a cursor that is not a function or method is passed in, -1 is returned. 2649d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis */ 2650d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios KyrtzidisCINDEX_LINKAGE int clang_Cursor_getNumArguments(CXCursor C); 2651d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis 2652d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis/** 2653d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis * \brief Retrieve the argument cursor of a function or method. 2654d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis * 2655d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis * If a cursor that is not a function or method is passed in or the index 2656d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis * exceeds the number of arguments, an invalid cursor is returned. 2657d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis */ 2658d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios KyrtzidisCINDEX_LINKAGE CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i); 2659d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis 2660d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis/** 26617eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Determine whether two CXTypes represent the same type. 26628e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 26637eee0184570366285589d788bcd7f5dda8345915James Dennett * \returns non-zero if the CXTypes represent the same type and 26647eee0184570366285589d788bcd7f5dda8345915James Dennett * zero otherwise. 26658e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 26668e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B); 26678e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 26688e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 26698e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the canonical type for a CXType. 26708e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * 26718e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * Clang's type system explicitly models typedefs and all the ways 26728e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * a specific type can be represented. The canonical type is the underlying 26738e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * type with all the "sugar" removed. For example, if 'T' is a typedef 26748e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * for 'int', the canonical type for 'T' would be 'int'. 26758e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 26768e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getCanonicalType(CXType T); 26778e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 26788e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 26797eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Determine whether a CXType has the "const" qualifier set, 26807eee0184570366285589d788bcd7f5dda8345915James Dennett * without looking through typedefs that may have added "const" at a 26817eee0184570366285589d788bcd7f5dda8345915James Dennett * different level. 2682e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 2683e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T); 2684e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 2685e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 26867eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Determine whether a CXType has the "volatile" qualifier set, 26877eee0184570366285589d788bcd7f5dda8345915James Dennett * without looking through typedefs that may have added "volatile" at 26887eee0184570366285589d788bcd7f5dda8345915James Dennett * a different level. 2689e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 2690e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T); 2691e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 2692e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 26937eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Determine whether a CXType has the "restrict" qualifier set, 26947eee0184570366285589d788bcd7f5dda8345915James Dennett * without looking through typedefs that may have added "restrict" at a 26957eee0184570366285589d788bcd7f5dda8345915James Dennett * different level. 2696e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor */ 2697e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas GregorCINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T); 2698e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor 2699e72fb6f40231a1e8372c7576b69f06f0a1eb28a7Douglas Gregor/** 27008e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief For pointer types, returns the type of the pointee. 27018e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 27028e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXType clang_getPointeeType(CXType T); 27038e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 27048e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 27058e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Return the cursor for the declaration of the given type. 27068e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 27078e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T); 27088e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 27095389f48b24937ad7b4093307128b3cbf25235654David Chisnall/** 27105389f48b24937ad7b4093307128b3cbf25235654David Chisnall * Returns the Objective-C type encoding for the specified declaration. 27115389f48b24937ad7b4093307128b3cbf25235654David Chisnall */ 27125389f48b24937ad7b4093307128b3cbf25235654David ChisnallCINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C); 27138e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 27148e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 27158e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * \brief Retrieve the spelling of a given CXTypeKind. 27168e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 27178e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted KremenekCINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K); 27188e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 27198e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 272084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the calling convention associated with a function type. 272184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 272284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If a non-function type is passed in, CXCallingConv_Invalid is returned. 272384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 272484b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE enum CXCallingConv clang_getFunctionTypeCallingConv(CXType T); 272584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 272684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 27279a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek * \brief Retrieve the result type associated with a function type. 272884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 272984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If a non-function type is passed in, an invalid type is returned. 273004c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek */ 273104c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted KremenekCINDEX_LINKAGE CXType clang_getResultType(CXType T); 273204c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek 273304c3cf35a80c09ab78e519f2e71ecccd5c5d8da0Ted Kremenek/** 27347eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Retrieve the number of non-variadic arguments associated with a 27357eee0184570366285589d788bcd7f5dda8345915James Dennett * function type. 273684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 2737d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios Kyrtzidis * If a non-function type is passed in, -1 is returned. 273884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 2739d98ef9ae48ab4090d4d5d703ce65cfac62807fdaArgyrios KyrtzidisCINDEX_LINKAGE int clang_getNumArgTypes(CXType T); 274084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 274184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 274284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the type of an argument of a function type. 274384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 27447eee0184570366285589d788bcd7f5dda8345915James Dennett * If a non-function type is passed in or the function does not have enough 27457eee0184570366285589d788bcd7f5dda8345915James Dennett * parameters, an invalid type is returned. 274684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 274784b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE CXType clang_getArgType(CXType T, unsigned i); 274884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 274984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 275084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise. 275184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 275284b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE unsigned clang_isFunctionTypeVariadic(CXType T); 275384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 275484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 275584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Retrieve the result type associated with a given cursor. 275684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 275784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * This only returns a valid type if the cursor refers to a function or method. 27589a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek */ 27599a140845438c2fc31e7d48a6dedbc695f4c83c68Ted KremenekCINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C); 27609a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek 27619a140845438c2fc31e7d48a6dedbc695f4c83c68Ted Kremenek/** 27623ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * \brief Return 1 if the CXType is a POD (plain old data) type, and 0 27633ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek * otherwise. 27643ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek */ 27653ce9e7d270e7df86c09c8126b4412d55be7c123bTed KremenekCINDEX_LINKAGE unsigned clang_isPODType(CXType T); 27663ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek 27673ce9e7d270e7df86c09c8126b4412d55be7c123bTed Kremenek/** 276884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Return the element type of an array, complex, or vector type. 276984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 277084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If a type is passed in that is not an array, complex, or vector type, 277184b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * an invalid type is returned. 277284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 277384b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE CXType clang_getElementType(CXType T); 277484b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 277584b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 277684b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * \brief Return the number of elements of an array or vector type. 277784b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * 277884b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * If a type is passed in that is not an array or vector type, 277984b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis * -1 is returned. 278084b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis */ 278184b796492de8a708150dd3f86ae191041d42eef9Argyrios KyrtzidisCINDEX_LINKAGE long long clang_getNumElements(CXType T); 278284b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis 278384b796492de8a708150dd3f86ae191041d42eef9Argyrios Kyrtzidis/** 27845f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * \brief Return the element type of an array type. 27855f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * 27865f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * If a non-array type is passed in, an invalid type is returned. 27875f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis */ 27885f0bfc522266f3319c4a6262b016a552de058c7fArgyrios KyrtzidisCINDEX_LINKAGE CXType clang_getArrayElementType(CXType T); 27895f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis 27905f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis/** 2791bed28ac1d1463adca3ecf24fca5c30646fa9dbb2Sylvestre Ledru * \brief Return the array size of a constant array. 27925f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * 27935f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis * If a non-array type is passed in, -1 is returned. 27945f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis */ 27955f0bfc522266f3319c4a6262b016a552de058c7fArgyrios KyrtzidisCINDEX_LINKAGE long long clang_getArraySize(CXType T); 27965f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis 27975f0bfc522266f3319c4a6262b016a552de058c7fArgyrios Kyrtzidis/** 27983064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns 1 if the base class specified by the cursor with kind 27993064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * CX_CXXBaseSpecifier is virtual. 28003064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 28013064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor); 28023064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 28033064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 28043064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Represents the C++ access control level to a base class for a 28053064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * cursor with kind CX_CXXBaseSpecifier. 28063064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 28073064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenekenum CX_CXXAccessSpecifier { 28083064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXInvalidAccessSpecifier, 28093064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPublic, 28103064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXProtected, 28113064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek CX_CXXPrivate 28123064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek}; 28133064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 28143064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 28153064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek * \brief Returns the access control level for the C++ base specifier 28162dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis * represented by a cursor with kind CXCursor_CXXBaseSpecifier or 28172dfdb948bef51a601e763191e4becfe59880d382Argyrios Kyrtzidis * CXCursor_AccessSpecifier. 28183064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek */ 28193064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed KremenekCINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor); 28203064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek 28213064ef9e604d19a0cfd0d8e3ed3055bfd83f88fdTed Kremenek/** 28221f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Determine the number of overloaded declarations referenced by a 28231f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c CXCursor_OverloadedDeclRef cursor. 28241f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 28251f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 28261f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 28271f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns The number of overloaded declarations referenced by \c cursor. If it 28281f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0. 28291f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 28301f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor); 28311f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 28321f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 28331f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \brief Retrieve a cursor for one of the overloaded declarations referenced 28341f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * by a \c CXCursor_OverloadedDeclRef cursor. 28351f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 28361f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param cursor The cursor whose overloaded declarations are being queried. 28371f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 28381f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \param index The zero-based index into the set of overloaded declarations in 28391f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * the cursor. 28401f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * 28411f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \returns A cursor representing the declaration referenced by the given 28421f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * \c cursor at the specified \c index. If the cursor does not have an 28431f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * associated set of overloaded declarations, or if the index is out of bounds, 28441f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor * returns \c clang_getNullCursor(); 28451f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor */ 28461f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas GregorCINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor, 28471f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor unsigned index); 28481f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor 28491f60d9ea523fc321d811fe880ba9a1ec74fa8f9bDouglas Gregor/** 28508e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek * @} 28518e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek */ 285295f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 285395f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 2854ad72f4dad4cf0fd2b71eb8f4704d2fe7ac58fb44Ted Kremenek * \defgroup CINDEX_ATTRIBUTES Information for attributes 285595f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 285695f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @{ 285795f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 285895f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 285995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 286095f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 286195f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * \brief For cursors representing an iboutletcollection attribute, 286295f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * this function returns the collection element type. 286395f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * 286495f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 286595f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted KremenekCINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor); 286695f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek 286795f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek/** 286895f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek * @} 286995f33555a6d51b6537a9ed3968c3d1c2e4991b51Ted Kremenek */ 28708e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek 28718e0ac174c8c8c980927b3e1447f16f62fbe2a2e4Ted Kremenek/** 2872c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors 2873c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2874c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines provide the ability to traverse the abstract syntax tree 2875c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * using cursors. 2876c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2877c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2878c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 28791efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2880c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2881c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Describes how the traversal of the children of a particular 2882c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * cursor should proceed after visiting a particular child cursor. 2883c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2884c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A value of this enumeration type should be returned by each 2885c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXCursorVisitor to indicate how clang_visitChildren() proceed. 2886c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2887c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregorenum CXChildVisitResult { 2888c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 28891efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Terminates the cursor traversal. 2890c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2891c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Break, 28921efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 2893c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Continues the cursor traversal with the next sibling of 2894c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the cursor just visited, without visiting its children. 2895c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2896c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Continue, 2897c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor /** 2898c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Recursively traverse the children of this cursor, using 2899c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the same visitor and client data. 2900c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2901c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXChildVisit_Recurse 2902c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor}; 2903c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2904c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2905c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visitor invoked for each cursor found by a traversal. 2906c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2907c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This visitor function will be invoked for each cursor found by 2908c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). Its first argument is the cursor being 2909c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited, its second argument is the parent visitor for that cursor, 2910c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and its third argument is the client data provided to 2911c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * clang_visitCursorChildren(). 2912c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2913c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * The visitor should return one of the \c CXChildVisitResult values 2914c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * to direct clang_visitCursorChildren(). 2915c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 29161efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbartypedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor, 29171efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar CXCursor parent, 2918c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 2919c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2920c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2921c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Visit the children of a particular cursor. 2922c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2923c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * This function visits all the direct children of the given cursor, 2924c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * invoking the given \p visitor function with the cursors of each 2925c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * visited child. The traversal may be recursive, if the visitor returns 2926c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if 2927c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * the visitor returns \c CXChildVisit_Break. 2928c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2929c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param parent the cursor whose child may be visited. All kinds of 2930a57259e9d7b30bcce93f0a62eee0488738026172Daniel Dunbar * cursors can be visited, including invalid cursors (which, by 2931c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * definition, have no children). 2932c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2933c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param visitor the visitor function that will be invoked for each 2934c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * child of \p parent. 2935c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2936c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \param client_data pointer data supplied by the client, which will 2937c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be passed to the visitor each time it is invoked. 2938c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2939c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \returns a non-zero value if the traversal was terminated 2940c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * prematurely by the visitor returning \c CXChildVisit_Break. 2941c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 29421efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent, 2943c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXCursorVisitor visitor, 2944c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor CXClientData client_data); 29453387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#ifdef __has_feature 29463387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# if __has_feature(blocks) 29473387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 29483387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * \brief Visitor invoked for each cursor found by a traversal. 29493387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 29503387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * This visitor block will be invoked for each cursor found by 29513387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * clang_visitChildrenWithBlock(). Its first argument is the cursor being 29523387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * visited, its second argument is the parent visitor for that cursor. 29533387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * 29543387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * The visitor should return one of the \c CXChildVisitResult values 29553387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * to direct clang_visitChildrenWithBlock(). 29563387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 29573387c65a094a02b2a94c05111d035a97d3d5c794David Chisnalltypedef enum CXChildVisitResult 29583387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent); 29593387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall 29603387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall/** 29613387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * Visits the children of a cursor using the specified block. Behaves 29623387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall * identically to clang_visitChildren() in all other respects. 29633387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall */ 29643387c65a094a02b2a94c05111d035a97d3d5c794David Chisnallunsigned clang_visitChildrenWithBlock(CXCursor parent, 29653387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall CXCursorVisitorBlock block); 29663387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall# endif 29673387c65a094a02b2a94c05111d035a97d3d5c794David Chisnall#endif 29681efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2969c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2970c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 2971c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 29721efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2973c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2974c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST 2975c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 29761efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * These routines provide the ability to determine references within and 2977c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * across translation units, by providing the names of the entities referenced 2978c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by cursors, follow reference cursors to the declarations they reference, 2979c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * and associate declarations with their definitions. 2980c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2981c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 2982c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 29831efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 2984c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2985c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced 2986c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * by the given cursor. 2987c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 2988c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * A Unified Symbol Resolution (USR) is a string that identifies a particular 2989c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * entity (function, class, variable, etc.) within a program. USRs can be 2990c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * compared across translation units to determine, e.g., when references in 2991c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * one translation refer to an entity defined in another translation unit. 2992c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 2993c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor); 2994c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 2995c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 2996896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C class. 2997896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 2998896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name); 2999896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3000896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 3001896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C category. 3002896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 3003896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 300466ccaec73706f3623d2e7d191fe2c944feedcc2bTed Kremenek clang_constructUSR_ObjCCategory(const char *class_name, 3005896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek const char *category_name); 3006896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3007896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 3008896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C protocol. 3009896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 3010896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString 3011896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek clang_constructUSR_ObjCProtocol(const char *protocol_name); 3012896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3013896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3014896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 3015896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C instance variable and 3016896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 3017896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 3018896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name, 3019896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 3020896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3021896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 3022896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C method and 3023896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * the USR for its containing class. 3024896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 3025896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name, 3026896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek unsigned isInstanceMethod, 3027896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 3028896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3029896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 3030896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Construct a USR for a specified Objective-C property and the USR 3031896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * for its containing class. 3032896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek */ 3033896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property, 3034896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek CXString classUSR); 3035896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3036896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek/** 3037c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \brief Retrieve a name for the entity referenced by this cursor. 3038c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 3039c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas GregorCINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor); 3040c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor 3041358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor/** 3042ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis * \brief Retrieve a range for a piece that forms the cursors spelling name. 3043ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis * Most of the times there is only one range for the complete spelling but for 3044ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis * objc methods and objc message expressions, there are multiple pieces for each 3045ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis * selector identifier. 3046ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis * 3047ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis * \param pieceIndex the index of the spelling name piece. If this is greater 3048ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis * than the actual number of pieces, it will return a NULL (invalid) range. 3049ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis * 3050ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis * \param options Reserved. 3051ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis */ 3052ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios KyrtzidisCINDEX_LINKAGE CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor, 3053ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis unsigned pieceIndex, 3054ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis unsigned options); 3055ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis 3056ba1da14e79c1ecd49306e5175b69baa1e7ed4293Argyrios Kyrtzidis/** 3057358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * \brief Retrieve the display name for the entity referenced by this cursor. 3058358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * 3059358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * The display name contains extra information that helps identify the cursor, 3060358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * such as the parameters of a function or template or the arguments of a 3061358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor * class template specialization. 3062358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor */ 3063358559d8d7b458c5f64941842383a16e61f0828dDouglas GregorCINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor); 3064358559d8d7b458c5f64941842383a16e61f0828dDouglas Gregor 3065c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor/** \brief For a cursor that is a reference, retrieve a cursor representing the 3066c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * entity that it references. 3067c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * 3068c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Reference cursors refer to other entities in the AST. For example, an 3069c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * Objective-C superclass reference cursor refers to an Objective-C class. 30701efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * This function produces the cursor for the Objective-C class from the 3071c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * cursor for the superclass reference. If the input cursor is a declaration or 3072c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor * definition, it returns that declaration or definition unchanged. 30731efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Otherwise, returns the NULL cursor. 3074c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas Gregor */ 3075c5d1e9375d71e66d22456e7cc52cc7c0a5c65c3fDouglas GregorCINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor); 3076b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 30771efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 3078b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief For a cursor that is either a reference to or a declaration 3079b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * of some entity, retrieve a cursor that describes the definition of 3080b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that entity. 3081b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 3082b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * Some entities can be declared multiple times within a translation 3083b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * unit, but only one of those declarations can also be a 3084b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * definition. For example, given: 3085b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 3086b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \code 3087b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 3088b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int g(int x, int y) { return f(x, y); } 3089b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int a, int b) { return a + b; } 3090b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * int f(int, int); 3091b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \endcode 3092b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 3093b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * there are three declarations of the function "f", but only the 3094b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * second one is a definition. The clang_getCursorDefinition() 3095b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * function will take any cursor pointing to a declaration of "f" 3096b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * (the first or fourth lines of the example) or a cursor referenced 3097b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * that uses "f" (the call to "f' inside "g") and will return a 3098b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration cursor pointing to the definition (the second "f" 3099b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * declaration). 3100b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * 3101b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * If given a cursor for which there is no corresponding definition, 3102b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * e.g., because there is no definition of that entity within this 3103b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * translation unit, returns a NULL cursor. 3104b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 3105b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor); 3106b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 31071efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar/** 3108b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * \brief Determine whether the declaration pointed to by this cursor 3109b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor * is also a definition of that entity. 3110b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor */ 3111b699866820102a69d83d6ac6941985c5ef4e8c40Douglas GregorCINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor); 3112b699866820102a69d83d6ac6941985c5ef4e8c40Douglas Gregor 3113c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 31141a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \brief Retrieve the canonical cursor corresponding to the given cursor. 31151a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 31161a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * In the C family of languages, many kinds of entities can be declared several 31171a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * times within a single translation unit. For example, a structure type can 31181a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * be forward-declared (possibly multiple times) and later defined: 31191a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 31201a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \code 31211a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X; 31221a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X; 31231a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * struct X { 31241a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * int member; 31251a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * }; 31261a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \endcode 31271a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 31281a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * The declarations and the definition of \c X are represented by three 31291a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * different cursors, all of which are declarations of the same underlying 31301a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * entity. One of these cursor is considered the "canonical" cursor, which 31311a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * is effectively the representative for the underlying entity. One can 31321a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * determine if two cursors are declarations of the same underlying entity by 31331a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * comparing their canonical cursors. 31341a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * 31351a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor * \returns The canonical cursor for the entity referred to by the given cursor. 31361a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor */ 31371a9d0503b67a499797141af0fd6d315d5045f0eaDouglas GregorCINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor); 31381a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor 313934ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7bArgyrios Kyrtzidis 314034ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7bArgyrios Kyrtzidis/** 314134ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7bArgyrios Kyrtzidis * \brief If the cursor points to a selector identifier in a objc method or 314234ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7bArgyrios Kyrtzidis * message expression, this returns the selector index. 314334ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7bArgyrios Kyrtzidis * 31447eee0184570366285589d788bcd7f5dda8345915James Dennett * After getting a cursor with #clang_getCursor, this can be called to 314534ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7bArgyrios Kyrtzidis * determine if the location points to a selector identifier. 314634ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7bArgyrios Kyrtzidis * 314734ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7bArgyrios Kyrtzidis * \returns The selector index if the cursor is an objc method or message 314834ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7bArgyrios Kyrtzidis * expression and the cursor is pointing to a selector identifier, or -1 314934ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7bArgyrios Kyrtzidis * otherwise. 315034ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7bArgyrios Kyrtzidis */ 315134ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7bArgyrios KyrtzidisCINDEX_LINKAGE int clang_Cursor_getObjCSelectorIndex(CXCursor); 315234ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7bArgyrios Kyrtzidis 31531a9d0503b67a499797141af0fd6d315d5045f0eaDouglas Gregor/** 3154f39a7aea7dd0bf0716a066e2db2f97ea8730e4faArgyrios Kyrtzidis * \brief Given a cursor pointing to a C++ method call or an ObjC message, 3155f39a7aea7dd0bf0716a066e2db2f97ea8730e4faArgyrios Kyrtzidis * returns non-zero if the method/message is "dynamic", meaning: 3156f39a7aea7dd0bf0716a066e2db2f97ea8730e4faArgyrios Kyrtzidis * 3157f39a7aea7dd0bf0716a066e2db2f97ea8730e4faArgyrios Kyrtzidis * For a C++ method: the call is virtual. 3158f39a7aea7dd0bf0716a066e2db2f97ea8730e4faArgyrios Kyrtzidis * For an ObjC message: the receiver is an object instance, not 'super' or a 3159f39a7aea7dd0bf0716a066e2db2f97ea8730e4faArgyrios Kyrtzidis * specific class. 3160f39a7aea7dd0bf0716a066e2db2f97ea8730e4faArgyrios Kyrtzidis * 3161f39a7aea7dd0bf0716a066e2db2f97ea8730e4faArgyrios Kyrtzidis * If the method/message is "static" or the cursor does not point to a 3162f39a7aea7dd0bf0716a066e2db2f97ea8730e4faArgyrios Kyrtzidis * method/message, it will return zero. 3163f39a7aea7dd0bf0716a066e2db2f97ea8730e4faArgyrios Kyrtzidis */ 3164f39a7aea7dd0bf0716a066e2db2f97ea8730e4faArgyrios KyrtzidisCINDEX_LINKAGE int clang_Cursor_isDynamicCall(CXCursor C); 3165f39a7aea7dd0bf0716a066e2db2f97ea8730e4faArgyrios Kyrtzidis 3166f39a7aea7dd0bf0716a066e2db2f97ea8730e4faArgyrios Kyrtzidis/** 3167aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko * \brief Given a cursor that represents a declaration, return the associated 3168aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko * comment's source range. The range may include multiple consecutive comments 3169aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko * with whitespace in between. 3170aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko */ 3171aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri GribenkoCINDEX_LINKAGE CXSourceRange clang_Cursor_getCommentRange(CXCursor C); 3172aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko 3173aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko/** 3174aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko * \brief Given a cursor that represents a declaration, return the associated 3175aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko * comment text, including comment markers. 3176aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko */ 3177aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri GribenkoCINDEX_LINKAGE CXString clang_Cursor_getRawCommentText(CXCursor C); 3178aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko 3179aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko/** 3180ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief Given a cursor that represents a documentable entity (e.g., 3181ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * declaration), return the associated \\brief paragraph; otherwise return the 3182ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * first paragraph. 31832d44d77fed3200e2eff289f55493317e90d3398cDmitri Gribenko */ 31842d44d77fed3200e2eff289f55493317e90d3398cDmitri GribenkoCINDEX_LINKAGE CXString clang_Cursor_getBriefCommentText(CXCursor C); 31852d44d77fed3200e2eff289f55493317e90d3398cDmitri Gribenko 31862d44d77fed3200e2eff289f55493317e90d3398cDmitri Gribenko/** 3187ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief Given a cursor that represents a documentable entity (e.g., 3188ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * declaration), return the associated parsed comment as a 3189ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \c CXComment_FullComment AST node. 3190ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3191ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE CXComment clang_Cursor_getParsedComment(CXCursor C); 3192ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3193ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3194ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * @} 3195ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3196ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3197ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3198ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \defgroup CINDEX_COMMENT Comment AST introspection 3199ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3200ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * The routines in this group provide access to information in the 3201ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * documentation comment ASTs. 3202ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3203ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * @{ 3204ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3205ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3206ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3207ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief Describes the type of the comment AST node (\c CXComment). A comment 3208ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * node can be considered block content (e. g., paragraph), inline content 3209ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * (plain text) or neither (the root AST node). 3210ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3211ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenkoenum CXCommentKind { 3212ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3213ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief Null comment. No AST node is constructed at the requested location 3214ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * because there is no text or a syntax error. 3215ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3216ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko CXComment_Null = 0, 3217ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3218ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3219ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief Plain text. Inline content. 3220ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3221ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko CXComment_Text = 1, 3222ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3223ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3224ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief A command with word-like arguments that is considered inline content. 3225ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3226ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * For example: \\c command. 3227ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3228ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko CXComment_InlineCommand = 2, 3229ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3230ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3231ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief HTML start tag with attributes (name-value pairs). Considered 3232ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * inline content. 3233ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3234ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * For example: 3235ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \verbatim 3236ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * <br> <br /> <a href="http://example.org/"> 3237ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \endverbatim 3238ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3239ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko CXComment_HTMLStartTag = 3, 3240ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3241ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3242ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief HTML end tag. Considered inline content. 3243ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3244ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * For example: 3245ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \verbatim 3246ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * </a> 3247ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \endverbatim 3248ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3249ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko CXComment_HTMLEndTag = 4, 3250ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3251ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3252ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief A paragraph, contains inline comment. The paragraph itself is 3253ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * block content. 3254ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3255ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko CXComment_Paragraph = 5, 3256ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3257ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3258ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief A command that has zero or more word-like arguments (number of 3259ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * word-like arguments depends on command name) and a paragraph as an 3260ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * argument. Block command is block content. 3261ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3262ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * Paragraph argument is also a child of the block command. 3263ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3264ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * For example: \\brief has 0 word-like arguments and a paragraph argument. 3265ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3266ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * AST nodes of special kinds that parser knows about (e. g., \\param 3267ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * command) have their own node kinds. 3268ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3269ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko CXComment_BlockCommand = 6, 3270ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3271ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3272ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief A \\param or \\arg command that describes the function parameter 3273ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * (name, passing direction, description). 3274ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3275ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief For example: \\param [in] ParamName description. 3276ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3277ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko CXComment_ParamCommand = 7, 3278ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3279ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 328096b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \brief A \\tparam command that describes a template parameter (name and 328196b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * description). 328296b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * 328396b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \brief For example: \\tparam T description. 328496b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko */ 328596b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko CXComment_TParamCommand = 8, 328696b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko 328796b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko /** 3288ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief A verbatim block command (e. g., preformatted code). Verbatim 3289ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * block has an opening and a closing command and contains multiple lines of 3290ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * text (\c CXComment_VerbatimBlockLine child nodes). 3291ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3292ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * For example: 3293ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \\verbatim 3294ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * aaa 3295ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \\endverbatim 3296ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 329796b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko CXComment_VerbatimBlockCommand = 9, 3298ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3299ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3300ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief A line of text that is contained within a 3301ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * CXComment_VerbatimBlockCommand node. 3302ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 330396b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko CXComment_VerbatimBlockLine = 10, 3304ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3305ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3306ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief A verbatim line command. Verbatim line has an opening command, 3307ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * a single line of text (up to the newline after the opening command) and 3308ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * has no closing command. 3309ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 331096b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko CXComment_VerbatimLine = 11, 3311ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3312ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3313ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief A full comment attached to a declaration, contains block content. 3314ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 331596b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko CXComment_FullComment = 12 3316ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko}; 3317ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3318ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 33192d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko * \brief The most appropriate rendering mode for an inline command, chosen on 33202d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko * command semantics in Doxygen. 33212d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko */ 33222d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenkoenum CXCommentInlineCommandRenderKind { 33232d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko /** 33242d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko * \brief Command argument should be rendered in a normal font. 33252d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko */ 33262d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko CXCommentInlineCommandRenderKind_Normal, 33272d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko 33282d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko /** 33292d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko * \brief Command argument should be rendered in a bold font. 33302d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko */ 33312d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko CXCommentInlineCommandRenderKind_Bold, 33322d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko 33332d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko /** 33342d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko * \brief Command argument should be rendered in a monospaced font. 33352d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko */ 33362d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko CXCommentInlineCommandRenderKind_Monospaced, 33372d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko 33382d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko /** 33392d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko * \brief Command argument should be rendered emphasized (typically italic 33402d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko * font). 33412d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko */ 33422d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko CXCommentInlineCommandRenderKind_Emphasized 33432d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko}; 33442d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko 33452d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko/** 3346ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief Describes parameter passing direction for \\param or \\arg command. 3347ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3348ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenkoenum CXCommentParamPassDirection { 3349ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3350ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief The parameter is an input parameter. 3351ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3352ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko CXCommentParamPassDirection_In, 3353ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3354ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3355ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief The parameter is an output parameter. 3356ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3357ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko CXCommentParamPassDirection_Out, 3358ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3359ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko /** 3360ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief The parameter is an input and output parameter. 3361ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3362ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko CXCommentParamPassDirection_InOut 3363ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko}; 3364ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3365ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3366ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment AST node of any kind. 3367ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3368ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns the type of the AST node. 3369ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3370ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE enum CXCommentKind clang_Comment_getKind(CXComment Comment); 3371ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3372ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3373ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment AST node of any kind. 3374ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3375ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns number of children of the AST node. 3376ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3377ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE unsigned clang_Comment_getNumChildren(CXComment Comment); 3378ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3379ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3380ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment AST node of any kind. 3381ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3382ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param ArgIdx argument index (zero-based). 3383ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3384ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns the specified child of the AST node. 3385ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3386ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3387ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCXComment clang_Comment_getChild(CXComment Comment, unsigned ChildIdx); 3388ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3389ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3390ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief A \c CXComment_Paragraph node is considered whitespace if it contains 3391ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * only \c CXComment_Text nodes that are empty or whitespace. 3392ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3393ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * Other AST nodes (except \c CXComment_Paragraph and \c CXComment_Text) are 3394ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * never considered whitespace. 3395ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3396ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns non-zero if \c Comment is whitespace. 3397ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3398ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE unsigned clang_Comment_isWhitespace(CXComment Comment); 3399ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3400ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3401ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns non-zero if \c Comment is inline content and has a newline 3402ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * immediately following it in the comment text. Newlines between paragraphs 3403ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * do not count. 3404ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3405ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3406ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenkounsigned clang_InlineContentComment_hasTrailingNewline(CXComment Comment); 3407ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3408ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3409ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_Text AST node. 3410ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3411ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns text contained in the AST node. 3412ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3413ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE CXString clang_TextComment_getText(CXComment Comment); 3414ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3415ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3416ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_InlineCommand AST node. 3417ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3418ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns name of the inline command. 3419ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3420ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3421ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCXString clang_InlineCommandComment_getCommandName(CXComment Comment); 3422ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3423ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3424ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_InlineCommand AST node. 3425ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 34262d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko * \returns the most appropriate rendering mode, chosen on command 34272d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko * semantics in Doxygen. 34282d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko */ 34292d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri GribenkoCINDEX_LINKAGE enum CXCommentInlineCommandRenderKind 34302d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenkoclang_InlineCommandComment_getRenderKind(CXComment Comment); 34312d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko 34322d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko/** 34332d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko * \param Comment a \c CXComment_InlineCommand AST node. 34342d66a5016d4aacce362f89290261c8a1a6eef0d3Dmitri Gribenko * 3435ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns number of command arguments. 3436ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3437ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3438ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenkounsigned clang_InlineCommandComment_getNumArgs(CXComment Comment); 3439ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3440ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3441ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_InlineCommand AST node. 3442ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3443ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param ArgIdx argument index (zero-based). 3444ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3445ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns text of the specified argument. 3446ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3447ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3448ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCXString clang_InlineCommandComment_getArgText(CXComment Comment, 3449ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko unsigned ArgIdx); 3450ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3451ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3452ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_HTMLStartTag or \c CXComment_HTMLEndTag AST 3453ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * node. 3454ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3455ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns HTML tag name. 3456ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3457ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE CXString clang_HTMLTagComment_getTagName(CXComment Comment); 3458ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3459ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3460ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_HTMLStartTag AST node. 3461ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3462ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns non-zero if tag is self-closing (for example, <br />). 3463ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3464ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3465ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenkounsigned clang_HTMLStartTagComment_isSelfClosing(CXComment Comment); 3466ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3467ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3468ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_HTMLStartTag AST node. 3469ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3470ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns number of attributes (name-value pairs) attached to the start tag. 3471ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3472ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE unsigned clang_HTMLStartTag_getNumAttrs(CXComment Comment); 3473ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3474ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3475ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_HTMLStartTag AST node. 3476ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3477ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param AttrIdx attribute index (zero-based). 3478ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3479ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns name of the specified attribute. 3480ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3481ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3482ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCXString clang_HTMLStartTag_getAttrName(CXComment Comment, unsigned AttrIdx); 3483ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3484ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3485ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_HTMLStartTag AST node. 3486ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3487ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param AttrIdx attribute index (zero-based). 3488ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3489ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns value of the specified attribute. 3490ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3491ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3492ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCXString clang_HTMLStartTag_getAttrValue(CXComment Comment, unsigned AttrIdx); 3493ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3494ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3495ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_BlockCommand AST node. 3496ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3497ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns name of the block command. 3498ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3499ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3500ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCXString clang_BlockCommandComment_getCommandName(CXComment Comment); 3501ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3502ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3503ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_BlockCommand AST node. 3504ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3505ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns number of word-like arguments. 3506ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3507ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3508ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenkounsigned clang_BlockCommandComment_getNumArgs(CXComment Comment); 3509ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3510ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3511ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_BlockCommand AST node. 3512ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3513ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param ArgIdx argument index (zero-based). 3514ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3515ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns text of the specified word-like argument. 3516ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3517ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3518ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCXString clang_BlockCommandComment_getArgText(CXComment Comment, 3519ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko unsigned ArgIdx); 3520ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3521ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3522ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_BlockCommand or 3523ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \c CXComment_VerbatimBlockCommand AST node. 3524ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3525ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns paragraph argument of the block command. 3526ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3527ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3528ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCXComment clang_BlockCommandComment_getParagraph(CXComment Comment); 3529ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3530ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3531ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_ParamCommand AST node. 3532ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3533ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns parameter name. 3534ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3535ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3536ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCXString clang_ParamCommandComment_getParamName(CXComment Comment); 3537ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3538ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3539ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_ParamCommand AST node. 3540ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3541ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns non-zero if the parameter that this AST node represents was found 3542ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * in the function prototype and \c clang_ParamCommandComment_getParamIndex 3543ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * function will return a meaningful value. 3544ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3545ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3546ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenkounsigned clang_ParamCommandComment_isParamIndexValid(CXComment Comment); 3547ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3548ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3549ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_ParamCommand AST node. 3550ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3551ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns zero-based parameter index in function prototype. 3552ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3553ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3554ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenkounsigned clang_ParamCommandComment_getParamIndex(CXComment Comment); 3555ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3556ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3557ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_ParamCommand AST node. 3558ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3559ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns non-zero if parameter passing direction was specified explicitly in 3560ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * the comment. 3561ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3562ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3563ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenkounsigned clang_ParamCommandComment_isDirectionExplicit(CXComment Comment); 3564ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3565ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3566ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_ParamCommand AST node. 3567ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3568ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns parameter passing direction. 3569ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3570ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3571ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenkoenum CXCommentParamPassDirection clang_ParamCommandComment_getDirection( 3572ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko CXComment Comment); 3573ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3574ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 357596b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \param Comment a \c CXComment_TParamCommand AST node. 357696b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * 357796b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \returns template parameter name. 357896b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko */ 357996b098674908eaa59a9128f3305cda6fbbdad563Dmitri GribenkoCINDEX_LINKAGE 358096b098674908eaa59a9128f3305cda6fbbdad563Dmitri GribenkoCXString clang_TParamCommandComment_getParamName(CXComment Comment); 358196b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko 358296b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko/** 358396b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \param Comment a \c CXComment_TParamCommand AST node. 358496b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * 358596b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \returns non-zero if the parameter that this AST node represents was found 358696b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * in the template parameter list and 358796b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \c clang_TParamCommandComment_getDepth and 358896b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \c clang_TParamCommandComment_getIndex functions will return a meaningful 358996b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * value. 359096b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko */ 359196b098674908eaa59a9128f3305cda6fbbdad563Dmitri GribenkoCINDEX_LINKAGE 359296b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenkounsigned clang_TParamCommandComment_isParamPositionValid(CXComment Comment); 359396b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko 359496b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko/** 359596b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \param Comment a \c CXComment_TParamCommand AST node. 359696b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * 359796b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \returns zero-based nesting depth of this parameter in the template parameter list. 359896b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * 359996b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * For example, 360096b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \verbatim 360196b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * template<typename C, template<typename T> class TT> 360296b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * void test(TT<int> aaa); 360396b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \endverbatim 360496b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * for C and TT nesting depth is 0, 360596b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * for T nesting depth is 1. 360696b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko */ 360796b098674908eaa59a9128f3305cda6fbbdad563Dmitri GribenkoCINDEX_LINKAGE 360896b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenkounsigned clang_TParamCommandComment_getDepth(CXComment Comment); 360996b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko 361096b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko/** 361196b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \param Comment a \c CXComment_TParamCommand AST node. 361296b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * 361396b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \returns zero-based parameter index in the template parameter list at a 361496b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * given nesting depth. 361596b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * 361696b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * For example, 361796b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \verbatim 361896b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * template<typename C, template<typename T> class TT> 361996b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * void test(TT<int> aaa); 362096b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \endverbatim 362196b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * for C and TT nesting depth is 0, so we can ask for index at depth 0: 362296b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * at depth 0 C's index is 0, TT's index is 1. 362396b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * 362496b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * For T nesting depth is 1, so we can ask for index at depth 0 and 1: 362596b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * at depth 0 T's index is 1 (same as TT's), 362696b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * at depth 1 T's index is 0. 362796b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko */ 362896b098674908eaa59a9128f3305cda6fbbdad563Dmitri GribenkoCINDEX_LINKAGE 362996b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenkounsigned clang_TParamCommandComment_getIndex(CXComment Comment, unsigned Depth); 363096b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko 363196b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko/** 3632ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_VerbatimBlockLine AST node. 3633ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3634ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns text contained in the AST node. 3635ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3636ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE 3637ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCXString clang_VerbatimBlockLineComment_getText(CXComment Comment); 3638ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3639ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3640ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_VerbatimLine AST node. 3641ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3642ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns text contained in the AST node. 3643ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3644ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE CXString clang_VerbatimLineComment_getText(CXComment Comment); 3645ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3646ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3647ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief Convert an HTML tag AST node to string. 3648ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3649ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_HTMLStartTag or \c CXComment_HTMLEndTag AST 3650ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * node. 3651ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3652ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns string containing an HTML tag. 3653ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3654ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE CXString clang_HTMLTagComment_getAsString(CXComment Comment); 3655ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3656ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3657ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \brief Convert a given full parsed comment to an HTML fragment. 3658ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3659ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * Specific details of HTML layout are subject to change. Don't try to parse 3660ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * this HTML back into an AST, use other APIs instead. 3661ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3662ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * Currently the following CSS classes are used: 3663ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \li "para-brief" for \\brief paragraph and equivalent commands; 3664ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \li "para-returns" for \\returns paragraph and equivalent commands; 3665ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \li "word-returns" for the "Returns" word in \\returns paragraph. 3666ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 36673e63d332baf0d3b8a5c0b7c2dac2ae85615b1d47Dmitri Gribenko * Function argument documentation is rendered as a \<dl\> list with arguments 36683e63d332baf0d3b8a5c0b7c2dac2ae85615b1d47Dmitri Gribenko * sorted in function prototype order. CSS classes used: 36693e63d332baf0d3b8a5c0b7c2dac2ae85615b1d47Dmitri Gribenko * \li "param-name-index-NUMBER" for parameter name (\<dt\>); 36703e63d332baf0d3b8a5c0b7c2dac2ae85615b1d47Dmitri Gribenko * \li "param-descr-index-NUMBER" for parameter description (\<dd\>); 36713e63d332baf0d3b8a5c0b7c2dac2ae85615b1d47Dmitri Gribenko * \li "param-name-index-invalid" and "param-descr-index-invalid" are used if 36723e63d332baf0d3b8a5c0b7c2dac2ae85615b1d47Dmitri Gribenko * parameter index is invalid. 3673ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 367496b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * Template parameter documentation is rendered as a \<dl\> list with 367596b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * parameters sorted in template parameter list order. CSS classes used: 367696b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \li "tparam-name-index-NUMBER" for parameter name (\<dt\>); 367796b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \li "tparam-descr-index-NUMBER" for parameter description (\<dd\>); 36786a425525e52aba5a8e14db35d50a712be4e5e2e1Dmitri Gribenko * \li "tparam-name-index-other" and "tparam-descr-index-other" are used for 367996b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * names inside template template parameters; 368096b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * \li "tparam-name-index-invalid" and "tparam-descr-index-invalid" are used if 368196b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * parameter position is invalid. 368296b098674908eaa59a9128f3305cda6fbbdad563Dmitri Gribenko * 3683ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \param Comment a \c CXComment_FullComment AST node. 3684ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * 3685ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko * \returns string containing an HTML fragment. 3686ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko */ 3687ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri GribenkoCINDEX_LINKAGE CXString clang_FullComment_getAsHTML(CXComment Comment); 3688ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko 3689ae99b75fbbac1deaccdcc1b326b8fb6b07a1e72dDmitri Gribenko/** 3690f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko * \brief Convert a given full parsed comment to an XML document. 3691f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko * 3692f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko * A Relax NG schema for the XML can be found in comment-xml-schema.rng file 3693f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko * inside clang source tree. 3694f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko * 3695f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko * \param TU the translation unit \c Comment belongs to. 3696f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko * 3697f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko * \param Comment a \c CXComment_FullComment AST node. 3698f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko * 3699f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko * \returns string containing an XML document. 3700f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko */ 3701f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri GribenkoCINDEX_LINKAGE CXString clang_FullComment_getAsXML(CXTranslationUnit TU, 3702f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko CXComment Comment); 3703f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko 3704f303d4cb10648ac9c2080ae7c9dd507ba615e3a7Dmitri Gribenko/** 3705c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 3706c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 37071efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 3708c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 37099ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * \defgroup CINDEX_CPP C++ AST introspection 37109ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 37119ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * The routines in this group provide access information in the ASTs specific 37129ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * to C++ language features. 37139ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * 37149ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @{ 37159ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 37169ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 37179ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 371849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Determine if a C++ member function or member function template is 371949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared 'static'. 37209ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 37219ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed KremenekCINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C); 37229ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 37239ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 3724211924b563aa31421836cee7655be729ad02733fDouglas Gregor * \brief Determine if a C++ member function or member function template is 3725211924b563aa31421836cee7655be729ad02733fDouglas Gregor * explicitly declared 'virtual' or if it overrides a virtual method from 3726211924b563aa31421836cee7655be729ad02733fDouglas Gregor * one of the base classes. 3727211924b563aa31421836cee7655be729ad02733fDouglas Gregor */ 3728211924b563aa31421836cee7655be729ad02733fDouglas GregorCINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C); 3729211924b563aa31421836cee7655be729ad02733fDouglas Gregor 3730211924b563aa31421836cee7655be729ad02733fDouglas Gregor/** 373149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \brief Given a cursor that represents a template, determine 373249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the cursor kind of the specializations would be generated by instantiating 373349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * the template. 373449f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 373549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * This routine can be used to determine what flavor of function template, 373649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * class template, or class template partial specialization is stored in the 373749f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * cursor. For example, it can describe whether a class template cursor is 373849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declared with "struct", "class" or "union". 373949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 374049f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \param C The cursor to query. This cursor should represent a template 374149f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * declaration. 374249f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * 374349f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \returns The cursor kind of the specializations that would be generated 374449f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * by instantiating the template \p C. If \p C is not a template, returns 374549f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor * \c CXCursor_NoDeclFound. 374649f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor */ 374749f6f5489483beaffc7ce48dfc000af4e65b9216Douglas GregorCINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C); 374849f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor 374949f6f5489483beaffc7ce48dfc000af4e65b9216Douglas Gregor/** 3750e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \brief Given a cursor that may represent a specialization or instantiation 3751e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template, retrieve the cursor that represents the template that it 3752e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializes or from which it was instantiated. 3753e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 3754e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * This routine determines the template involved both for explicit 3755e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specializations of templates and for implicit instantiations of the template, 3756e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * both of which are referred to as "specializations". For a class template 3757e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * specialization (e.g., \c std::vector<bool>), this routine will return 3758e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * either the primary template (\c std::vector) or, if the specialization was 3759e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * instantiated from a class template partial specialization, the class template 3760e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * partial specialization. For a class template partial specialization and a 3761e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * function template specialization (including instantiations), this 3762e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * this routine will return the specialized template. 3763e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 3764e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * For members of a class template (e.g., member functions, member classes, or 3765e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * static data members), returns the specialized or instantiated member. 3766e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * Although not strictly "templates" in the C++ language, members of class 3767e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates have the same notions of specializations and instantiations that 3768e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * templates do, so this routine treats them similarly. 3769e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 3770e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \param C A cursor that may be a specialization of a template or a member 3771e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * of a template. 3772e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * 3773e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * \returns If the given cursor is a specialization or instantiation of a 3774e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * template or a member thereof, the template or member that it specializes or 3775e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor * from which it was instantiated. Otherwise, returns a NULL cursor. 3776e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor */ 3777e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas GregorCINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C); 3778430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 3779430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor/** 3780430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Given a cursor that references something else, return the source range 3781430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * covering that reference. 3782430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 3783430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param C A cursor pointing to a member reference, a declaration reference, or 3784430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * an operator call. 3785430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param NameFlags A bitset with three independent flags: 3786430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and 3787430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantSinglePiece. 3788430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \param PieceIndex For contiguous names or when passing the flag 3789430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * CXNameRange_WantSinglePiece, only one piece with index 0 is 3790430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * available. When the CXNameRange_WantSinglePiece flag is not passed for a 379148d798ce32447607144db70a484cdb99c1180663Benjamin Kramer * non-contiguous names, this index can be used to retrieve the individual 3792430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * pieces of the name. See also CXNameRange_WantSinglePiece. 3793430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 3794430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \returns The piece of the name pointed to by the given cursor. If there is no 3795430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * name, or if the PieceIndex is out-of-range, a null-cursor will be returned. 3796430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 379748a8d14fc6f064a5297024c2b34733a4080b2efeFrancois PichetCINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, 379848a8d14fc6f064a5297024c2b34733a4080b2efeFrancois Pichet unsigned NameFlags, 3799430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor unsigned PieceIndex); 3800430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 3801430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregorenum CXNameRefFlags { 3802430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 3803430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the 3804430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * range. 3805430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 3806430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantQualifier = 0x1, 3807430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 3808430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 38097eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Include the explicit template arguments, e.g. \<int> in x.f<int>, 38107eee0184570366285589d788bcd7f5dda8345915James Dennett * in the range. 3811430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 3812430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantTemplateArgs = 0x2, 3813430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor 3814430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor /** 3815430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \brief If the name is non-contiguous, return the full spanning range. 3816430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * 3817430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * Non-contiguous names occur in Objective-C when a selector with two or more 3818430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * parameters is used, or in C++ when using an operator: 3819430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \code 3820430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * [object doSomething:here withValue:there]; // ObjC 3821430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * return some_vector[1]; // C++ 3822430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor * \endcode 3823430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor */ 3824430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor CXNameRange_WantSinglePiece = 0x4 3825430d7a1a621a126a9ffe442ad8987ba02b46dae9Douglas Gregor}; 3826e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor 3827e0329acf5c9437e2086a2fb2bf7a95ae2ac96505Douglas Gregor/** 38289ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek * @} 38299ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek */ 38309ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek 38319ada39a4ac82ff5f5087b0a7fa9ed0d32be55a3bTed Kremenek/** 38320045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \defgroup CINDEX_LEX Token extraction and manipulation 38330045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 38340045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * The routines in this group provide access to the tokens within a 38350045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * translation unit, along with a semantic mapping of those tokens to 38360045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * their corresponding cursors. 3837fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3838fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @{ 3839fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3840fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 3841fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3842fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a kind of token. 3843fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3844fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef enum CXTokenKind { 3845fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 3846fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A token that contains some kind of punctuation. 3847fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3848fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Punctuation, 3849896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3850fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 38510045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * \brief A language keyword. 3852fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3853fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Keyword, 3854896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3855fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 3856fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief An identifier (that is not a keyword). 3857fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3858fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Identifier, 3859896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3860fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 3861fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A numeric, string, or character literal. 3862fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3863fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Literal, 3864896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3865fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor /** 3866fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief A comment. 3867fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3868fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken_Comment 3869fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXTokenKind; 3870fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 3871fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3872fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Describes a single preprocessing token. 3873fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3874fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregortypedef struct { 3875fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor unsigned int_data[4]; 3876fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor void *ptr_data; 3877fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor} CXToken; 3878fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 3879fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3880fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the kind of the given token. 3881fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3882fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken); 3883896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3884fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3885fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Determine the spelling of the given token. 3886fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3887fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * The spelling of a token is the textual representation of that token, e.g., 3888fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * the text of an identifier or keyword. 3889fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3890fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken); 3891896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3892fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3893fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve the source location of the given token. 3894fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3895896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit, 3896fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken); 3897896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3898fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3899fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Retrieve a source range that covers the given token. 3900fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3901fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken); 3902fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor 3903fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3904fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Tokenize the source code described by the given range into raw 3905fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * lexical tokens. 3906fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3907fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit whose text is being tokenized. 3908fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3909fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Range the source range in which text should be tokenized. All of the 3910fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * tokens produced by tokenization will fall within this source range, 3911fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3912fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens this pointer will be set to point to the array of tokens 3913fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that occur within the given source range. The returned pointer must be 3914fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * freed with clang_disposeTokens() before the translation unit is destroyed. 3915fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3916fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens will be set to the number of tokens in the \c *Tokens 3917fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * array. 3918fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3919fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3920fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range, 3921fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken **Tokens, unsigned *NumTokens); 3922896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3923fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3924fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Annotate the given set of tokens by providing cursors for each token 3925fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * that can be mapped to a specific entity within the abstract syntax tree. 3926fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 39270045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * This token-annotation routine is equivalent to invoking 39280045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() for the source locations of each of the 39290045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * tokens. The cursors provided are filtered, so that only those 39300045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * cursors that have a direct correspondence to the token are 39310045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * accepted. For example, given a function call \c f(x), 39320045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * clang_getCursor() would provide the following cursors: 39330045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 39340045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'. 39350045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'. 39360045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'. 39370045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * 39380045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * Only the first and last of these cursors will occur within the 39390045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * annotate, since the tokens "f" and "x' directly refer to a function 39400045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * and a variable, respectively, but the parentheses are just a small 39410045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * part of the full syntax of the function call expression, which is 39420045e9fe1f7dfc37f1ea7bdb9b70bcdb6700f0c0Douglas Gregor * not provided as an annotation. 3943fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3944fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param TU the translation unit that owns the given tokens. 3945fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3946fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Tokens the set of tokens to annotate. 3947fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3948fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param NumTokens the number of tokens in \p Tokens. 3949fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * 3950fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \param Cursors an array of \p NumTokens cursors, whose contents will be 3951fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * replaced with the cursors corresponding to each token. 3952fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3953fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas GregorCINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU, 3954fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens, 3955fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXCursor *Cursors); 3956896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3957fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3958fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * \brief Free the given set of tokens. 3959fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3960896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU, 3961fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor CXToken *Tokens, unsigned NumTokens); 3962896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3963fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3964fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor * @} 3965fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor */ 3966896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek 3967fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor/** 3968c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_DEBUG Debugging facilities 3969c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3970c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * These routines are used for testing and debugging, only, and should not 3971c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * be relied upon. 3972c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3973c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 3974c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 39751efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 39764ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff/* for debug/testing */ 3977e68fff6fc083c6270d835216a3de0b82c6ef0310Ted KremenekCINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind); 39781efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor, 39791efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar const char **startBuf, 39804ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff const char **endBuf, 39814ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startLine, 39824ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *startColumn, 39834ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endLine, 39844ade6d6eae934f796ca43c81a5aa185e456dde9bSteve Naroff unsigned *endColumn); 39850a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas GregorCINDEX_LINKAGE void clang_enableStackTraces(void); 3986995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel DunbarCINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data, 3987995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar unsigned stack_size); 3988995aaf9c8f0131bef0215a9a0bc794b83a49e0b7Daniel Dunbar 39890c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 3990c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 3991c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 39921efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 3993c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 3994c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * \defgroup CINDEX_CODE_COMPLET Code completion 3995c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 3996c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * Code completion involves taking an (incomplete) source file, along with 3997c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * knowledge of where the user is actively editing that file, and suggesting 3998c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * syntactically- and semantically-valid constructs that the user might want to 3999c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * use at that particular point in the source code. These data structures and 4000c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * routines provide support for code completion. 4001c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * 4002c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @{ 4003c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 40041efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 4005c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 40060c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A semantic string that describes a code-completion result. 40070c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 40080c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A semantic string that describes the formatting of a code-completion 40090c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * result as a single "template" of text that should be inserted into the 40100c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * source buffer when a particular code-completion result is selected. 40110c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * Each semantic string is made up of some number of "chunks", each of which 40120c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * contains some text along with a description of what that text means, e.g., 40130c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the name of the entity being referenced, whether the text chunk is part of 40140c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the template, or whether it is a "placeholder" that the user should replace 40150c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * with actual code,of a specific kind. See \c CXCompletionChunkKind for a 40161efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * description of the different kinds of chunks. 40170c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 40180c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef void *CXCompletionString; 40191efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 40200c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 40210c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A single result of code completion. 40220c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 40230c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregortypedef struct { 40240c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 40251efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief The kind of entity that this completion refers to. 40260c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 40271efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * The cursor kind will be a macro, keyword, or a declaration (one of the 40280c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * *Decl cursor kinds), describing the entity that the completion is 40290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to. 40300c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 40310c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \todo In the future, we would like to provide a full cursor, to allow 40320c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the client to extract additional information from declaration. 40330c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 40340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor enum CXCursorKind CursorKind; 40351efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 40361efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar /** 40370c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief The code-completion string that describes how to insert this 40380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion result into the editing buffer. 40390c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 40400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionString CompletionString; 40410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor} CXCompletionResult; 40420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 40430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 40440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Describes a single piece of text within a code-completion string. 40450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 40461efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * Each "chunk" within a code-completion string (\c CXCompletionString) is 40471efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * either a piece of text with a specific "kind" that describes how that text 40480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * should be interpreted by the client or is another completion string. 40490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 40500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorenum CXCompletionChunkKind { 40510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 40520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A code-completion string that describes "optional" text that 40530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * could be a part of the template (but is not required). 40540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 40550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The Optional chunk is the only kind of chunk that has a code-completion 40561efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * string for its representation, which is accessible via 40570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \c clang_getCompletionChunkCompletionString(). The code-completion string 40580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * describes an additional part of the template that is completely optional. 40590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * For example, optional chunks can be used to describe the placeholders for 40600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * arguments that match up with defaulted function parameters, e.g. given: 40610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 40620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 40630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * void f(int x, float y = 3.14, double z = 2.71828); 40640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 40650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 40660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * The code-completion string for this function would contain: 40670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a TypedText chunk for "f". 40680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a LeftParen chunk for "(". 40690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "int x" 40700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the remaining defaulted arguments, e.g., 40710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 407271570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * - a Placeholder chunk for "float y" 40730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - an Optional chunk containing the last defaulted argument: 40740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Comma chunk for "," 40750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a Placeholder chunk for "double z" 40760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - a RightParen chunk for ")" 40770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 407871570182471d502a97f7f175aa527152544c75f2Daniel Dunbar * There are many ways to handle Optional chunks. Two simple approaches are: 40790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Completely ignore optional chunks, in which case the template for the 40800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would only include the first parameter ("int x"). 40810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * - Fully expand all optional chunks, in which case the template for the 40820c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * function "f" would have all of the parameters. 40830c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 40840c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Optional, 40850c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 40860c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that a user would be expected to type to get this 40871efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * code-completion result. 40880c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 40891efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * There will be exactly one "typed text" chunk in a semantic string, which 40901efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * will typically provide the spelling of a keyword or the name of a 40910c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * declaration that could be used at the current code point. Clients are 40920c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * expected to filter the code-completion results based on the text in this 40930c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * chunk. 40940c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 40950c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_TypedText, 40960c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 40970c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that should be inserted as part of a code-completion result. 40980c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 40990c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "text" chunk represents text that is part of the template to be 41000c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * inserted into user code should this particular code-completion result 41010c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * be selected. 41020c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 41030c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Text, 41040c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 41050c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Placeholder text that should be replaced by the user. 41060c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 41070c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "placeholder" chunk marks a place where the user should insert text 41080c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * into the code-completion template. For example, placeholders might mark 41090c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the function parameters for a function declaration, to indicate that the 41100c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * user should provide arguments for each of those parameters. The actual 41110c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * text in a placeholder is a suggestion for the text to display before 41120c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * the user replaces the placeholder with real code. 41130c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 41140c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Placeholder, 41150c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 41160c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Informative text that should be displayed but never inserted as 41170c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * part of the template. 41181efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * 41190c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * An "informative" chunk contains annotations that can be displayed to 41200c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * help the user decide whether a particular code-completion result is the 41210c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * right option, but which is not part of the actual template to be inserted 41220c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * by code completion. 41230c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 41240c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_Informative, 41250c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 41260c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Text that describes the current parameter when code-completion is 41270c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * referring to function call, message send, or template specialization. 41280c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 41290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * A "current parameter" chunk occurs when code-completion is providing 41300c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * information about a parameter corresponding to the argument at the 41310c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * code-completion point. For example, given a function 41320c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 41330c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \code 41340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * int add(int x, int y); 41350c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \endcode 41360c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 41370c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * and the source code \c add(, where the code-completion point is after the 41380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "(", the code-completion string will contain a "current parameter" chunk 41390c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * for "int x", indicating that the current argument will initialize that 41400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * parameter. After typing further, to \c add(17, (where the code-completion 41411efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * point is after the ","), the code-completion string will contain a 41420c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * "current paremeter" chunk to "int y". 41430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 41440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_CurrentParameter, 41450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 41460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left parenthesis ('('), used to initiate a function call or 41470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the beginning of a function parameter list. 41480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 41490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftParen, 41500c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 41510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right parenthesis (')'), used to finish a function call or 41520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * signal the end of a function parameter list. 41530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 41540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightParen, 41550c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 41560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left bracket ('['). 41570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 41580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBracket, 41590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 41600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right bracket (']'). 41610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 41620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBracket, 41630c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 41640c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left brace ('{'). 41650c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 41660c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftBrace, 41670c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 41680c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right brace ('}'). 41690c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 41700c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightBrace, 41710c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 41720c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A left angle bracket ('<'). 41730c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 41740c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_LeftAngle, 41750c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 41760c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A right angle bracket ('>'). 41770c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 41780c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor CXCompletionChunk_RightAngle, 41790c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor /** 41800c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief A comma separator (','). 41810c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 4182ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor CXCompletionChunk_Comma, 4183ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor /** 41841efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Text that specifies the result type of a given result. 4185ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * 4186ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * This special kind of informative chunk is not meant to be inserted into 41871efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * the text buffer. Rather, it is meant to illustrate the type that an 4188ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor * expression using the given completion string would have. 4189ff5ce6eefc7c253ef6edf4d4bfc996fdd82d09aaDouglas Gregor */ 419001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_ResultType, 419101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 419201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A colon (':'). 419301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 419401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Colon, 419501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 419601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief A semicolon (';'). 419701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 419801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_SemiColon, 419901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 420001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * \brief An '=' sign. 420101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 420201dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_Equal, 420301dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 420401dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Horizontal space (' '). 420501dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 420601dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_HorizontalSpace, 420701dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor /** 420801dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * Vertical space ('\n'), after which it is generally a good idea to 420901dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor * perform indentation. 421001dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor */ 421101dfea02d1da297e8b53db8eea3d3cc652acda8dDouglas Gregor CXCompletionChunk_VerticalSpace 42120c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor}; 42131efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 42140c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 42150c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Determine the kind of a particular chunk within a completion string. 42160c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 42170c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 42180c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 42190c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 42200c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 42210c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the kind of the chunk at the index \c chunk_number. 42220c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 42231efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE enum CXCompletionChunkKind 42240c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkKind(CXCompletionString completion_string, 42250c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 42261efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 42270c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 42281efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the text associated with a particular chunk within a 42290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * completion string. 42300c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 42310c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 42320c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 42330c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 42340c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 42350c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the text associated with the chunk at index \c chunk_number. 42360c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 42372ef6f8f5a35a60870594c5b04e0aa2bf22c6886fTed KremenekCINDEX_LINKAGE CXString 42380c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkText(CXCompletionString completion_string, 42390c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 42400c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 42410c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 42421efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar * \brief Retrieve the completion string associated with a particular chunk 42430c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * within a completion string. 42440c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 42450c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param completion_string the completion string to query. 42460c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 42470c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \param chunk_number the 0-based index of the chunk in the completion string. 42480c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * 42490c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \returns the completion string associated with the chunk at index 42506164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \c chunk_number. 42510c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 42520c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE CXCompletionString 42530c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getCompletionChunkCompletionString(CXCompletionString completion_string, 42540c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor unsigned chunk_number); 42551efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 42560c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 42570c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor * \brief Retrieve the number of chunks in the given code-completion string. 42580c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 42590c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas GregorCINDEX_LINKAGE unsigned 42600c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregorclang_getNumCompletionChunks(CXCompletionString completion_string); 42610c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor 42620c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor/** 426312e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \brief Determine the priority of this code completion. 426412e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 426512e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * The priority of a code completion indicates how likely it is that this 426612e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * particular completion is the completion that the user will select. The 426712e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * priority is selected by various internal heuristics. 426812e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 426912e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \param completion_string The completion string to query. 427012e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * 427112e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * \returns The priority of this completion string. Smaller values indicate 427212e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor * higher-priority (more likely) completions. 427312e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor */ 427412e131385e892e3723483a1081a89bcad29c8a84Douglas GregorCINDEX_LINKAGE unsigned 427512e131385e892e3723483a1081a89bcad29c8a84Douglas Gregorclang_getCompletionPriority(CXCompletionString completion_string); 427612e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor 427712e131385e892e3723483a1081a89bcad29c8a84Douglas Gregor/** 427858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \brief Determine the availability of the entity that this code-completion 427958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * string refers to. 428058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 428158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \param completion_string The completion string to query. 428258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * 428358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor * \returns The availability of the completion string. 428458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor */ 428558ddb60f409125eda5436c4a1f070f7fa4744295Douglas GregorCINDEX_LINKAGE enum CXAvailabilityKind 428658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregorclang_getCompletionAvailability(CXCompletionString completion_string); 428758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 428858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor/** 42896164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \brief Retrieve the number of annotations associated with the given 42906164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * completion string. 42916164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 42926164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \param completion_string the completion string to query. 42936164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 42946164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \returns the number of annotations associated with the given completion 42956164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * string. 42966164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen */ 42976164ea1d75385b6fc3c19e5ab9bb686298436a5aErik VerbruggenCINDEX_LINKAGE unsigned 42986164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggenclang_getCompletionNumAnnotations(CXCompletionString completion_string); 42996164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen 43006164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen/** 43016164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \brief Retrieve the annotation associated with the given completion string. 43026164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 43036164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \param completion_string the completion string to query. 43046164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 43056164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \param annotation_number the 0-based index of the annotation of the 43066164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * completion string. 43076164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * 43086164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \returns annotation string associated with the completion at index 43096164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen * \c annotation_number, or a NULL string if that annotation is not available. 43106164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen */ 43116164ea1d75385b6fc3c19e5ab9bb686298436a5aErik VerbruggenCINDEX_LINKAGE CXString 43126164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggenclang_getCompletionAnnotation(CXCompletionString completion_string, 43136164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen unsigned annotation_number); 43146164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen 43156164ea1d75385b6fc3c19e5ab9bb686298436a5aErik Verbruggen/** 4316ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * \brief Retrieve the parent context of the given completion string. 4317ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * 4318ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * The parent context of a completion string is the semantic parent of 4319ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * the declaration (if any) that the code completion represents. For example, 4320ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * a code completion for an Objective-C method would have the method's class 4321ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * or protocol as its context. 4322ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * 4323ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * \param completion_string The code completion string whose parent is 4324ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * being queried. 4325ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * 4326ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * \param kind If non-NULL, will be set to the kind of the parent context, 4327ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * or CXCursor_NotImplemented if there is no context. 4328ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * 43297eee0184570366285589d788bcd7f5dda8345915James Dennett * \returns The name of the completion parent, e.g., "NSObject" if 4330ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor * the completion string represents a method in the NSObject class. 4331ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor */ 4332ba1030698dbc276db86b11c5329a1edee8a1805eDouglas GregorCINDEX_LINKAGE CXString 4333ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregorclang_getCompletionParent(CXCompletionString completion_string, 4334ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor enum CXCursorKind *kind); 4335d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko 4336d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko/** 4337d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko * \brief Retrieve the brief documentation comment attached to the declaration 4338d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko * that corresponds to the given completion string. 4339d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko */ 4340d99ef536b241071b6f4c01db6525dc03242ac30bDmitri GribenkoCINDEX_LINKAGE CXString 4341d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenkoclang_getCompletionBriefComment(CXCompletionString completion_string); 4342d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko 4343ba1030698dbc276db86b11c5329a1edee8a1805eDouglas Gregor/** 43448fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \brief Retrieve a completion string for an arbitrary declaration or macro 43458fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * definition cursor. 43468fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * 43478fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \param cursor The cursor to query. 43488fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * 43498fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * \returns A non-context-sensitive completion string for declaration and macro 43508fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor * definition cursors, or NULL for other kinds of cursors. 43518fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor */ 43528fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas GregorCINDEX_LINKAGE CXCompletionString 43538fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregorclang_getCursorCompletionString(CXCursor cursor); 43548fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 43558fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor/** 4356ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Contains the results of code-completion. 4357ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * 4358ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * This data structure contains the results of code completion, as 4359e0cc52ef8afc8d1cba9c534191b5f0ddaff1d694Douglas Gregor * produced by \c clang_codeCompleteAt(). Its contents must be freed by 4360ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c clang_disposeCodeCompleteResults. 4361ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 4362ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregortypedef struct { 4363ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 4364ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The code-completion results. 4365ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 4366ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor CXCompletionResult *Results; 4367ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 4368ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor /** 4369ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief The number of code-completion results stored in the 4370ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \c Results array. 4371ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor */ 4372ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor unsigned NumResults; 4373ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor} CXCodeCompleteResults; 4374ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor 4375ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor/** 4376cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Flags that can be passed to \c clang_codeCompleteAt() to 4377cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * modify its behavior. 4378cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 4379cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * The enumerators in this enumeration can be bitwise-OR'd together to 4380cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * provide multiple options to \c clang_codeCompleteAt(). 4381cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 4382cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregorenum CXCodeComplete_Flags { 4383cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 4384cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include macros within the set of code 4385cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completions returned. 4386cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 4387cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor CXCodeComplete_IncludeMacros = 0x01, 4388cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 4389cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /** 4390cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Whether to include code patterns for language constructs 4391cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * within the set of code completions, e.g., for loops. 4392cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 4393d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko CXCodeComplete_IncludeCodePatterns = 0x02, 4394d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko 4395d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko /** 4396d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko * \brief Whether to include brief documentation within the set of code 4397d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko * completions returned. 4398d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko */ 4399d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko CXCodeComplete_IncludeBriefComments = 0x04 4400cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor}; 4401cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 4402cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 44033da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Bits that represent the context under which completion is occurring. 44043da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 44053da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * The enumerators in this enumeration may be bitwise-OR'd together if multiple 44063da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * contexts are occurring simultaneously. 44073da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44083da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregorenum CXCompletionContext { 44093da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44103da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief The context for completions is unexposed, as only Clang results 44113da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included. (This is equivalent to having no context bits set.) 44123da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44133da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Unexposed = 0, 44143da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 44153da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44163da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for any possible type should be included in the results. 44173da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44183da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_AnyType = 1 << 0, 44193da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 44203da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44213da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for any possible value (variables, function calls, etc.) 44223da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included in the results. 44233da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44243da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_AnyValue = 1 << 1, 44253da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44263da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to an Objective-C object should 44273da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * be included in the results. 44283da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44293da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCObjectValue = 1 << 2, 44303da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44313da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to an Objective-C selector 44323da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * should be included in the results. 44333da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44343da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCSelectorValue = 1 << 3, 44353da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44363da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for values that resolve to a C++ class type should be 44373da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * included in the results. 44383da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44393da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_CXXClassTypeValue = 1 << 4, 44403da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 44413da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44423da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for fields of the member being accessed using the dot 44433da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * operator should be included in the results. 44443da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44453da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_DotMemberAccess = 1 << 5, 44463da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44473da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for fields of the member being accessed using the arrow 44483da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * operator should be included in the results. 44493da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44503da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ArrowMemberAccess = 1 << 6, 44513da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44523da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for properties of the Objective-C object being accessed 44533da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * using the dot operator should be included in the results. 44543da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44553da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCPropertyAccess = 1 << 7, 44563da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 44573da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44583da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for enum tags should be included in the results. 44593da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44603da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_EnumTag = 1 << 8, 44613da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44623da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for union tags should be included in the results. 44633da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44643da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_UnionTag = 1 << 9, 44653da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44663da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for struct tags should be included in the results. 44673da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44683da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_StructTag = 1 << 10, 44693da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 44703da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44713da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ class names should be included in the results. 44723da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44733da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ClassTag = 1 << 11, 44743da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44753da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ namespaces and namespace aliases should be 44763da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * included in the results. 44773da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44783da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Namespace = 1 << 12, 44793da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44803da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for C++ nested name specifiers should be included in 44813da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 44823da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44833da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_NestedNameSpecifier = 1 << 13, 44843da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 44853da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44863da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C interfaces (classes) should be included 44873da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * in the results. 44883da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44893da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCInterface = 1 << 14, 44903da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44913da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C protocols should be included in 44923da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 44933da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44943da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCProtocol = 1 << 15, 44953da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 44963da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C categories should be included in 44973da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 44983da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 44993da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCCategory = 1 << 16, 45003da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 45013da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C instance messages should be included 45023da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * in the results. 45033da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 45043da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCInstanceMessage = 1 << 17, 45053da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 45063da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C class messages should be included in 45073da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 45083da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 45093da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCClassMessage = 1 << 18, 45103da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 45113da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for Objective-C selector names should be included in 45123da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 45133da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 45143da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_ObjCSelectorName = 1 << 19, 45153da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 45163da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 45173da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Completions for preprocessor macro names should be included in 45183da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the results. 45193da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 45203da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_MacroName = 1 << 20, 45213da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 45223da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 45233da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Natural language completions should be included in the results. 45243da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 45253da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_NaturalLanguage = 1 << 21, 45263da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 45273da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor /** 45283da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief The current context is unknown, so set all contexts. 45293da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 45303da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCompletionContext_Unknown = ((1 << 22) - 1) 45313da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor}; 45323da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 45333da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor/** 4534cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \brief Returns a default set of code-completion options that can be 4535cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * passed to\c clang_codeCompleteAt(). 4536cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor */ 4537cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas GregorCINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void); 4538cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor 4539cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor/** 45401abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \brief Perform code completion at a given location in a translation unit. 45411abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 45421abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * This function performs code completion at a particular file, line, and 45431abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * column within source code, providing results that suggest potential 45441abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code snippets based on the context of the completion. The basic model 45451abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * for code completion is that Clang will parse a complete source file, 45461abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * performing syntax checking up to the location where code-completion has 45471abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * been requested. At that point, a special code-completion token is passed 45481abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * to the parser, which recognizes this token and determines, based on the 45491abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * current location in the C/Objective-C/C++ grammar and the state of 45501abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * semantic analysis, what completions to provide. These completions are 45511abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * returned via a new \c CXCodeCompleteResults structure. 45521abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 45531abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Code completion itself is meant to be triggered by the client when the 45541abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * user types punctuation characters or whitespace, at which point the 45551abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * code-completion location will coincide with the cursor. For example, if \c p 45561abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is a pointer, code-completion might be triggered after the "-" and then 45571abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * after the ">" in \c p->. When the code-completion location is afer the ">", 45581abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the completion results will provide, e.g., the members of the struct that 45591abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * "p" points to. The client is responsible for placing the cursor at the 45601abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * beginning of the token currently being typed, then filtering the results 45611abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * based on the contents of the token. For example, when code-completing for 45621abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the expression \c p->get, the client should provide the location just after 45631abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the 45641abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client can filter the results based on the current token text ("get"), only 45651abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * showing those results that start with "get". The intent of this interface 45661abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * is to separate the relatively high-latency acquisition of code-completion 45671abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * results from the filtering of results on a per-character basis, which must 45681abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * have a lower latency. 45691abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 45701abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param TU The translation unit in which code-completion should 45711abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * occur. The source files for this translation unit need not be 45721abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completely up-to-date (and the contents of those source files may 45731abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * be overridden via \p unsaved_files). Cursors referring into the 45741abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * translation unit may be invalidated by this invocation. 45751abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 45761abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_filename The name of the source file where code 45771abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion should be performed. This filename may be any file 45781abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * included in the translation unit. 45791abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 45801abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_line The line at which code-completion should occur. 45811abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 45821abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param complete_column The column at which code-completion should occur. 45831abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * Note that the column should point just after the syntactic construct that 45841abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * initiated code completion, and not in the middle of a lexical token. 45851abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 45861abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param unsaved_files the Tiles that have not yet been saved to disk 45871abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * but may be required for parsing or code completion, including the 45881abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * contents of those files. The contents and name of these files (as 45891abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * specified by CXUnsavedFile) are copied when necessary, so the 45901abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * client only needs to guarantee their validity until the call to 45911abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * this function returns. 45921abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 45931abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \param num_unsaved_files The number of unsaved file entries in \p 45941abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * unsaved_files. 45951abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * 4596cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \param options Extra options that control the behavior of code 4597cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * completion, expressed as a bitwise OR of the enumerators of the 4598cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * CXCodeComplete_Flags enumeration. The 4599cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * \c clang_defaultCodeCompleteOptions() function returns a default set 4600cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * of code-completion options. 4601cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor * 46021abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * \returns If successful, a new \c CXCodeCompleteResults structure 46031abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * containing code-completion results, which should eventually be 46041abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * freed with \c clang_disposeCodeCompleteResults(). If code 46051abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor * completion fails, returns NULL. 46061abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor */ 46071abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCINDEX_LINKAGE 46081abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas GregorCXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU, 46091abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor const char *complete_filename, 46101abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_line, 46111abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor unsigned complete_column, 46121abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor struct CXUnsavedFile *unsaved_files, 4613cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned num_unsaved_files, 4614cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor unsigned options); 46151abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 46161abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor/** 46171e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \brief Sort the code-completion results in case-insensitive alphabetical 46181e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * order. 46191e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * 46201e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param Results The set of results to sort. 46211e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor * \param NumResults The number of results in \p Results. 46221e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor */ 46231e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas GregorCINDEX_LINKAGE 46241e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregorvoid clang_sortCodeCompletionResults(CXCompletionResult *Results, 46251e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor unsigned NumResults); 46261e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor 46271e5e6684b0f27701e6f7c65f8c6a32a10cbcc3edDouglas Gregor/** 4628ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregor * \brief Free the given set of code-completion results. 46290c8296dfb495f41d6f0de6fe1d03014ffd063674Douglas Gregor */ 46301efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel DunbarCINDEX_LINKAGE 4631ec6762c709726bf2ee5f76c21df81e71a56e6f81Douglas Gregorvoid clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results); 463258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 463320d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor/** 4634a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Determine the number of diagnostics produced prior to the 4635a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * location where code completion was performed. 4636a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 4637896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 4638a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorunsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results); 4639a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 4640a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 4641a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Retrieve a diagnostic associated with the given code completion. 4642a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 46437eee0184570366285589d788bcd7f5dda8345915James Dennett * \param Results the code completion results to query. 4644a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \param Index the zero-based diagnostic number to retrieve. 4645a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * 4646a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \returns the requested diagnostic. This diagnostic must be freed 4647a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * via a call to \c clang_disposeDiagnostic(). 4648a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 4649896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted KremenekCINDEX_LINKAGE 4650a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas GregorCXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results, 4651a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned Index); 4652a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 4653a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 46543da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \brief Determines what compeltions are appropriate for the context 46553da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * the given code completion. 46563da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 46573da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \param Results the code completion results to query 46583da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * 46593da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * \returns the kinds of completions that are appropriate for use 46603da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor * along with the given code completion results. 46613da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor */ 46623da626b4f38eb0350de960d71271ca77af7a9cc8Douglas GregorCINDEX_LINKAGE 46633da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregorunsigned long long clang_codeCompleteGetContexts( 46643da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor CXCodeCompleteResults *Results); 4665e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor 4666e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor/** 4667e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \brief Returns the cursor kind for the container for the current code 4668e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * completion context. The container is only guaranteed to be set for 4669e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * contexts where a container exists (i.e. member accesses or Objective-C 4670e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * message sends); if there is not a container, this function will return 4671e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * CXCursor_InvalidCode. 4672e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 4673e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param Results the code completion results to query 4674e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 4675e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param IsIncomplete on return, this value will be false if Clang has complete 4676e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * information about the container. If Clang does not have complete 4677e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * information, this value will be true. 4678e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 4679e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \returns the container kind, or CXCursor_InvalidCode if there is not a 4680e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * container 4681e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor */ 4682e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCINDEX_LINKAGE 4683e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregorenum CXCursorKind clang_codeCompleteGetContainerKind( 4684e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor CXCodeCompleteResults *Results, 4685e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor unsigned *IsIncomplete); 4686e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor 4687e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor/** 4688e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \brief Returns the USR for the container for the current code completion 4689e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * context. If there is not a container for the current context, this 4690e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * function will return the empty string. 4691e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 4692e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \param Results the code completion results to query 4693e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * 4694e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor * \returns the USR for the container 4695e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas Gregor */ 4696e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCINDEX_LINKAGE 4697e081a61bb0dc546fd623bf259435d17c9a4ea0d5Douglas GregorCXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results); 46983da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor 46990a47d69af8bda945352997af3da4687a3356096aDouglas Gregor 47000a47d69af8bda945352997af3da4687a3356096aDouglas Gregor/** 47010a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \brief Returns the currently-entered selector for an Objective-C message 47020a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * send, formatted like "initWithFoo:bar:". Only guaranteed to return a 47030a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * non-empty string for CXCompletionContext_ObjCInstanceMessage and 47040a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * CXCompletionContext_ObjCClassMessage. 47050a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * 47060a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \param Results the code completion results to query 47070a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * 47080a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * \returns the selector (or partial selector) that has been entered thus far 47090a47d69af8bda945352997af3da4687a3356096aDouglas Gregor * for an Objective-C message send. 47100a47d69af8bda945352997af3da4687a3356096aDouglas Gregor */ 47110a47d69af8bda945352997af3da4687a3356096aDouglas GregorCINDEX_LINKAGE 47120a47d69af8bda945352997af3da4687a3356096aDouglas GregorCXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results); 47130a47d69af8bda945352997af3da4687a3356096aDouglas Gregor 47143da626b4f38eb0350de960d71271ca77af7a9cc8Douglas Gregor/** 471520d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor * @} 471620d416c36b46dd19ee0b1ea2d0266ae43be86e51Douglas Gregor */ 47171efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 47181efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 471904bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek/** 472004bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * \defgroup CINDEX_MISC Miscellaneous utility functions 472104bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * 472204bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @{ 472304bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 472423e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek 472523e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek/** 472623e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * \brief Return a version string, suitable for showing to a user, but not 472723e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek * intended to be parsed (the format is not guaranteed to be stable). 472823e1ad09bb68f929212e0ff51206258d06e7f6cfTed Kremenek */ 4729a2a9d6e4e5b6001b86b7dfc5db1ea296ce29a3d3Ted KremenekCINDEX_LINKAGE CXString clang_getClangVersion(); 473004bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek 4731d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek 4732d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek/** 4733d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * \brief Enable/disable crash recovery. 4734d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek * 47357eee0184570366285589d788bcd7f5dda8345915James Dennett * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero 47367eee0184570366285589d788bcd7f5dda8345915James Dennett * value enables crash recovery, while 0 disables it. 4737d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek */ 4738d2427ddf00aacdc288c386f3882e0821ca9bd27bTed KremenekCINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled); 4739d2427ddf00aacdc288c386f3882e0821ca9bd27bTed Kremenek 474016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek /** 4741896b70ffc348f6e2c680b5fb5841984d5785b7b5Ted Kremenek * \brief Visitor invoked for each file in a translation unit 474216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * (used with clang_getInclusions()). 474316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * 474416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * This visitor function will be invoked by clang_getInclusions() for each 47457eee0184570366285589d788bcd7f5dda8345915James Dennett * file included (either at the top-level or by \#include directives) within 474616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * a translation unit. The first argument is the file being included, and 474716b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the second and third arguments provide the inclusion stack. The 474816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * array is sorted in order of immediate inclusion. For example, 474916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * the first element refers to the location that included 'included_file'. 475016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 475116b55a71695a33c094383295cc7b7a2080e098daTed Kremenektypedef void (*CXInclusionVisitor)(CXFile included_file, 475216b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXSourceLocation* inclusion_stack, 475316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek unsigned include_len, 475416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 475516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 475616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 475716b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * \brief Visit the set of preprocessor inclusions in a translation unit. 475816b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * The visitor function is called with the provided data for every included 475916b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * file. This does not include headers included by the PCH file (unless one 476016b55a71695a33c094383295cc7b7a2080e098daTed Kremenek * is inspecting the inclusions in the PCH file itself). 476116b55a71695a33c094383295cc7b7a2080e098daTed Kremenek */ 476216b55a71695a33c094383295cc7b7a2080e098daTed KremenekCINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu, 476316b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXInclusionVisitor visitor, 476416b55a71695a33c094383295cc7b7a2080e098daTed Kremenek CXClientData client_data); 476516b55a71695a33c094383295cc7b7a2080e098daTed Kremenek 476616b55a71695a33c094383295cc7b7a2080e098daTed Kremenek/** 476704bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek * @} 476804bb716aea8fd2372ac10b0c640cabc5e5caa615Ted Kremenek */ 47691efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 477097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** \defgroup CINDEX_REMAPPING Remapping functions 477197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 477297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * @{ 477397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 477497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 477597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 477697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief A remapping of original source files and their translated files. 477797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 477897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidistypedef void *CXRemapping; 477997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 478097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 478197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Retrieve a remapping. 478297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 478397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param path the path that contains metadata about remappings. 478497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 478597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \returns the requested remapping. This remapping must be freed 478697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred. 478797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 478897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path); 478997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 479097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 479130660a898545416f0fea2d717f16f75640001e38Ted Kremenek * \brief Retrieve a remapping. 479230660a898545416f0fea2d717f16f75640001e38Ted Kremenek * 479330660a898545416f0fea2d717f16f75640001e38Ted Kremenek * \param filePaths pointer to an array of file paths containing remapping info. 479430660a898545416f0fea2d717f16f75640001e38Ted Kremenek * 479530660a898545416f0fea2d717f16f75640001e38Ted Kremenek * \param numFiles number of file paths. 479630660a898545416f0fea2d717f16f75640001e38Ted Kremenek * 479730660a898545416f0fea2d717f16f75640001e38Ted Kremenek * \returns the requested remapping. This remapping must be freed 479830660a898545416f0fea2d717f16f75640001e38Ted Kremenek * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred. 479930660a898545416f0fea2d717f16f75640001e38Ted Kremenek */ 480030660a898545416f0fea2d717f16f75640001e38Ted KremenekCINDEX_LINKAGE 480130660a898545416f0fea2d717f16f75640001e38Ted KremenekCXRemapping clang_getRemappingsFromFileList(const char **filePaths, 480230660a898545416f0fea2d717f16f75640001e38Ted Kremenek unsigned numFiles); 480330660a898545416f0fea2d717f16f75640001e38Ted Kremenek 480430660a898545416f0fea2d717f16f75640001e38Ted Kremenek/** 480597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Determine the number of remappings. 480697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 480797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping); 480897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 480997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 481097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Get the original and the associated filename from the remapping. 481197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 481297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param original If non-NULL, will be set to the original filename. 481397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * 481497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \param transformed If non-NULL, will be set to the filename that the original 481597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * is associated with. 481697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 481797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index, 481897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis CXString *original, CXString *transformed); 481997c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 482097c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 482197c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * \brief Dispose the remapping. 482297c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 482397c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios KyrtzidisCINDEX_LINKAGE void clang_remap_dispose(CXRemapping); 482497c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 482597c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis/** 482697c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis * @} 482797c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis */ 482897c337c2bdf3ec53073c7e7dd656aa0dd37ee409Argyrios Kyrtzidis 4829aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis/** \defgroup CINDEX_HIGH Higher level API functions 4830aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 4831aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * @{ 4832aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis */ 4833aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4834aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidisenum CXVisitorResult { 4835aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXVisit_Break, 4836aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXVisit_Continue 4837aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis}; 4838aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4839aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidistypedef struct { 4840aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis void *context; 4841aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange); 4842aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis} CXCursorAndRangeVisitor; 4843aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4844aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis/** 4845aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \brief Find references of a declaration in a specific file. 4846aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 4847aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \param cursor pointing to a declaration or a reference of one. 4848aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 4849aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \param file to search for references. 4850aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * 4851aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for 4852aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * each reference found. 4853aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * The CXSourceRange will point inside the file; if the reference is inside 4854aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * a macro (and not a macro argument) the CXSourceRange will be invalid. 4855aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis */ 4856aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios KyrtzidisCINDEX_LINKAGE void clang_findReferencesInFile(CXCursor cursor, CXFile file, 4857aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXCursorAndRangeVisitor visitor); 4858aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4859aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis#ifdef __has_feature 4860aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis# if __has_feature(blocks) 4861aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4862aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidistypedef enum CXVisitorResult 4863aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange); 4864aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4865aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios KyrtzidisCINDEX_LINKAGE 4866aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidisvoid clang_findReferencesInFileWithBlock(CXCursor, CXFile, 4867aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis CXCursorAndRangeVisitorBlock); 4868aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4869aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis# endif 4870aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis#endif 4871aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 4872bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4873bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The client's data object that is associated with a CXFile. 4874bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4875dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef void *CXIdxClientFile; 4876bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis 4877bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 48782957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief The client's data object that is associated with a semantic entity. 48792957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 48802957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidistypedef void *CXIdxClientEntity; 48812957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 48822957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 4883bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The client's data object that is associated with a semantic container 4884bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * of entities. 4885bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4886dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef void *CXIdxClientContainer; 4887bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis 4888bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4889bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The client's data object that is associated with an AST file (PCH 4890bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * or module). 4891bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4892dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef void *CXIdxClientASTFile; 48934e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4894bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 4895dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis * \brief Source location passed to index callbacks. 4896bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 48974e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 48984e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void *ptr_data[2]; 48994e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned int_data; 49004e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxLoc; 49014e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4902bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 49037eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Data for ppIncludedFile callback. 4904bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 49054e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 4906bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 49077eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Location of '#' in the \#include/\#import directive. 4908bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 49094e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc hashLoc; 4910bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 49117eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Filename as written in the \#include/\#import directive. 4912bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 49134e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *filename; 4914bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 49157eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief The actual file that the \#include/\#import directive resolved to. 4916bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 4917dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXFile file; 49184e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isImport; 49194e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isAngled; 49204e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxIncludedFileInfo; 49214e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4922bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 49237eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Data for IndexerCallbacks#importedASTFile. 4924bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 49254e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 49264e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXFile file; 4927bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4928bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Location where the file is imported. It is useful mostly for 4929bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * modules. 4930bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 49314e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 4932bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 4933bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Non-zero if the AST file is a module otherwise it's a PCH. 4934bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 49354e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isModule; 49364e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxImportedASTFileInfo; 49374e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4938dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef enum { 4939dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Unexposed = 0, 4940dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Typedef = 1, 4941dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Function = 2, 4942dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Variable = 3, 4943dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_Field = 4, 4944dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_EnumConstant = 5, 49454e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4946dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_ObjCClass = 6, 4947dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_ObjCProtocol = 7, 4948dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxEntity_ObjCCategory = 8, 49494e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4950c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_ObjCInstanceMethod = 9, 4951c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_ObjCClassMethod = 10, 4952c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_ObjCProperty = 11, 4953c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_ObjCIvar = 12, 49544e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4955c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_Enum = 13, 4956c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_Struct = 14, 4957c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis CXIdxEntity_Union = 15, 49582957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 49592957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXClass = 16, 49602957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXNamespace = 17, 49612957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXNamespaceAlias = 18, 49622957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXStaticVariable = 19, 49632957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXStaticMethod = 20, 49642957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXInstanceMethod = 21, 49652957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXConstructor = 22, 49662957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXDestructor = 23, 49672957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_CXXConversionFunction = 24, 4968838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis CXIdxEntity_CXXTypeAlias = 25 49694e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4970dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxEntityKind; 49714e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 4972838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidistypedef enum { 4973838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis CXIdxEntityLang_None = 0, 4974838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis CXIdxEntityLang_C = 1, 4975838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis CXIdxEntityLang_ObjC = 2, 4976838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis CXIdxEntityLang_CXX = 3 4977838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis} CXIdxEntityLanguage; 4978838d3c23204f52ae27a9f5e9a254238a7ac5d41bArgyrios Kyrtzidis 49792957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 49802957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief Extra C++ template information for an entity. This can apply to: 49812957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_Function 49822957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_CXXClass 49832957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_CXXStaticMethod 49842957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_CXXInstanceMethod 49852957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_CXXConstructor 49862957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_CXXConversionFunction 49872957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * CXIdxEntity_CXXTypeAlias 49882957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 49892957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidistypedef enum { 49902957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_NonTemplate = 0, 49912957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_Template = 1, 49922957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_TemplatePartialSpecialization = 2, 49932957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXIdxEntity_TemplateSpecialization = 3 49942957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis} CXIdxEntityCXXTemplateKind; 49952957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 4996b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidistypedef enum { 4997b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxAttr_Unexposed = 0, 4998b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxAttr_IBAction = 1, 4999b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxAttr_IBOutlet = 2, 5000b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxAttr_IBOutletCollection = 3 5001b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis} CXIdxAttrKind; 5002b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis 5003b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidistypedef struct { 5004b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxAttrKind kind; 5005b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXCursor cursor; 5006b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxLoc loc; 5007b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis} CXIdxAttrInfo; 5008b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis 5009b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidistypedef struct { 5010643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis CXIdxEntityKind kind; 5011643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis CXIdxEntityCXXTemplateKind templateKind; 5012643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis CXIdxEntityLanguage lang; 5013643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis const char *name; 5014643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis const char *USR; 5015643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis CXCursor cursor; 5016643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis const CXIdxAttrInfo *const *attributes; 5017643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis unsigned numAttributes; 5018643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis} CXIdxEntityInfo; 5019643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis 5020643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidistypedef struct { 5021643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis CXCursor cursor; 5022643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis} CXIdxContainerInfo; 5023643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidis 5024643d3ce93c501d19353f2fa578fee3e97f1d1b4bArgyrios Kyrtzidistypedef struct { 5025b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis const CXIdxAttrInfo *attrInfo; 5026b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis const CXIdxEntityInfo *objcClass; 5027b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXCursor classCursor; 5028b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxLoc classLoc; 5029b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis} CXIdxIBOutletCollectionAttrInfo; 5030b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis 50314e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 50326ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxEntityInfo *entityInfo; 5033dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXCursor cursor; 5034dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxLoc loc; 5035b1febb646bf7a2f319ad894c9833968c52d21711Argyrios Kyrtzidis const CXIdxContainerInfo *semanticContainer; 5036b1febb646bf7a2f319ad894c9833968c52d21711Argyrios Kyrtzidis /** 50377eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Generally same as #semanticContainer but can be different in 5038b1febb646bf7a2f319ad894c9833968c52d21711Argyrios Kyrtzidis * cases like out-of-line C++ member functions. 5039b1febb646bf7a2f319ad894c9833968c52d21711Argyrios Kyrtzidis */ 5040b1febb646bf7a2f319ad894c9833968c52d21711Argyrios Kyrtzidis const CXIdxContainerInfo *lexicalContainer; 5041dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis int isRedeclaration; 50424e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int isDefinition; 5043c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis int isContainer; 50442957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis const CXIdxContainerInfo *declAsContainer; 5045c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis /** 5046c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis * \brief Whether the declaration exists in code or was created implicitly 5047c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis * by the compiler, e.g. implicit objc methods for properties. 5048c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis */ 5049c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis int isImplicit; 5050b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis const CXIdxAttrInfo *const *attributes; 5051b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis unsigned numAttributes; 5052dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxDeclInfo; 50534e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 5054dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidistypedef enum { 5055dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxObjCContainer_ForwardRef = 0, 5056dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxObjCContainer_Interface = 1, 5057dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxObjCContainer_Implementation = 2 5058dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxObjCContainerKind; 50594e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 50604e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 50616ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxDeclInfo *declInfo; 5062dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxObjCContainerKind kind; 5063dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis} CXIdxObjCContainerDeclInfo; 50644e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 50654e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 50666ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxEntityInfo *base; 50676ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis CXCursor cursor; 50684e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 50696ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis} CXIdxBaseClassInfo; 50704e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 50714e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 50726ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxEntityInfo *protocol; 50736ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis CXCursor cursor; 50744e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 50754e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxObjCProtocolRefInfo; 50764e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 50774e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 50786ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxObjCProtocolRefInfo *const *protocols; 50794e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned numProtocols; 5080c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis} CXIdxObjCProtocolRefListInfo; 50814e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 50824e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 5083c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis const CXIdxObjCContainerDeclInfo *containerInfo; 5084c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis const CXIdxBaseClassInfo *superInfo; 5085c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis const CXIdxObjCProtocolRefListInfo *protocols; 5086c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidis} CXIdxObjCInterfaceDeclInfo; 50874e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 50882957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidistypedef struct { 5089c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis const CXIdxObjCContainerDeclInfo *containerInfo; 5090c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis const CXIdxEntityInfo *objcClass; 5091c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis CXCursor classCursor; 5092c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis CXIdxLoc classLoc; 5093c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis const CXIdxObjCProtocolRefListInfo *protocols; 5094c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis} CXIdxObjCCategoryDeclInfo; 5095c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidis 5096c10a4c8baff3164bee9b7fc293679a5a5a90eb74Argyrios Kyrtzidistypedef struct { 50972957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis const CXIdxDeclInfo *declInfo; 5098792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidis const CXIdxEntityInfo *getter; 5099792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidis const CXIdxEntityInfo *setter; 5100792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidis} CXIdxObjCPropertyDeclInfo; 5101792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidis 5102792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidistypedef struct { 5103792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidis const CXIdxDeclInfo *declInfo; 51042957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis const CXIdxBaseClassInfo *const *bases; 51052957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis unsigned numBases; 51062957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis} CXIdxCXXClassDeclInfo; 51072957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 5108bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 51097eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Data for IndexerCallbacks#indexEntityReference. 5110bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 5111aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidistypedef enum { 5112bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 5113bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The entity is referenced directly in user's code. 5114bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 5115aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis CXIdxEntityRef_Direct = 1, 5116bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 5117b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis * \brief An implicit reference, e.g. a reference of an ObjC method via the 5118b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis * dot syntax. 5119bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 5120b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXIdxEntityRef_Implicit = 2 5121aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis} CXIdxEntityRefKind; 5122aca19be8731fc31cff68702de0dc7f30ce908979Argyrios Kyrtzidis 5123bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 51247eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Data for IndexerCallbacks#indexEntityReference. 5125bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 51264e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 5127b1febb646bf7a2f319ad894c9833968c52d21711Argyrios Kyrtzidis CXIdxEntityRefKind kind; 5128bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 5129bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Reference cursor. 5130bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 51314e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXCursor cursor; 51324e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXIdxLoc loc; 5133bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 5134bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief The entity that gets referenced. 5135bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 51366ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxEntityInfo *referencedEntity; 5137bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 5138bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Immediate "parent" of the reference. For example: 5139bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 5140bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \code 5141bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * Foo *var; 5142bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \endcode 5143bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 5144bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * The parent of reference of type 'Foo' is the variable 'var'. 5145e422e45a6a89d450b8eca10f671b49874e87617aArgyrios Kyrtzidis * For references inside statement bodies of functions/methods, 5146e422e45a6a89d450b8eca10f671b49874e87617aArgyrios Kyrtzidis * the parentEntity will be the function/method. 5147bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 51486ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxEntityInfo *parentEntity; 5149bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 5150e422e45a6a89d450b8eca10f671b49874e87617aArgyrios Kyrtzidis * \brief Lexical container context of the reference. 5151bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 51522957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis const CXIdxContainerInfo *container; 51534e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} CXIdxEntityRefInfo; 51544e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 51557eee0184570366285589d788bcd7f5dda8345915James Dennett/** 51567eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief A group of callbacks used by #clang_indexSourceFile and 51577eee0184570366285589d788bcd7f5dda8345915James Dennett * #clang_indexTranslationUnit. 51587eee0184570366285589d788bcd7f5dda8345915James Dennett */ 51594e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidistypedef struct { 5160bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 51616ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis * \brief Called periodically to check whether indexing should be aborted. 51626ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis * Should return 0 to continue, and non-zero to abort. 51636ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis */ 51646ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis int (*abortQuery)(CXClientData client_data, void *reserved); 51656ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis 51666ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis /** 5167b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis * \brief Called at the end of indexing; passes the complete diagnostic set. 5168bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 51694e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*diagnostic)(CXClientData client_data, 5170b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis CXDiagnosticSet, void *reserved); 51714e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 5172dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientFile (*enteredMainFile)(CXClientData client_data, 51737eee0184570366285589d788bcd7f5dda8345915James Dennett CXFile mainFile, void *reserved); 5174dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis 5175bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 51767eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Called when a file gets \#included/\#imported. 5177bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 5178dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientFile (*ppIncludedFile)(CXClientData client_data, 51796ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxIncludedFileInfo *); 51804e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 5181bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 5182bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called when a AST file (PCH or module) gets imported. 5183bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 5184bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * AST files will not get indexed (there will not be callbacks to index all 5185bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * the entities in an AST file). The recommended action is that, if the AST 5186bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * file is not already indexed, to block further indexing and initiate a new 51876ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis * indexing job specific to the AST file. 5188bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 5189dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientASTFile (*importedASTFile)(CXClientData client_data, 51906ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxImportedASTFileInfo *); 51914e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 5192bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 5193bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called at the beginning of indexing a translation unit. 5194bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 5195dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data, 51966ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis void *reserved); 51974e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 51986ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis void (*indexDeclaration)(CXClientData client_data, 51992957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis const CXIdxDeclInfo *); 52004e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 5201bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis /** 5202bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Called to index a reference of an entity. 5203bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 52044e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis void (*indexEntityReference)(CXClientData client_data, 52056ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis const CXIdxEntityRefInfo *); 52064e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 52074e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis} IndexerCallbacks; 52084e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 5209ab336c1adca7f6920fd886c132f199e469b63fb5NAKAMURA TakumiCINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind); 52106ec43adc39006a7fce94188956d0239bd54c0363Argyrios KyrtzidisCINDEX_LINKAGE const CXIdxObjCContainerDeclInfo * 52116ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidisclang_index_getObjCContainerDeclInfo(const CXIdxDeclInfo *); 52126ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis 52136ec43adc39006a7fce94188956d0239bd54c0363Argyrios KyrtzidisCINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo * 52146ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidisclang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *); 5215dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis 5216ab336c1adca7f6920fd886c132f199e469b63fb5NAKAMURA TakumiCINDEX_LINKAGE 52176ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidisconst CXIdxObjCCategoryDeclInfo * 52186ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidisclang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *); 52196ec43adc39006a7fce94188956d0239bd54c0363Argyrios Kyrtzidis 5220c71d55469e7d5f7b376a30620617a175a9442da9Argyrios KyrtzidisCINDEX_LINKAGE const CXIdxObjCProtocolRefListInfo * 5221c71d55469e7d5f7b376a30620617a175a9442da9Argyrios Kyrtzidisclang_index_getObjCProtocolRefListInfo(const CXIdxDeclInfo *); 5222dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis 5223792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios KyrtzidisCINDEX_LINKAGE const CXIdxObjCPropertyDeclInfo * 5224792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidisclang_index_getObjCPropertyDeclInfo(const CXIdxDeclInfo *); 5225792db266f3d2f12a7a16bf37d90074f54bca1e6fArgyrios Kyrtzidis 5226b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios KyrtzidisCINDEX_LINKAGE const CXIdxIBOutletCollectionAttrInfo * 5227b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidisclang_index_getIBOutletCollectionAttrInfo(const CXIdxAttrInfo *); 5228b395c63b473bf1b3783bff371a993332e8c4c5e3Argyrios Kyrtzidis 52292957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE const CXIdxCXXClassDeclInfo * 52302957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidisclang_index_getCXXClassDeclInfo(const CXIdxDeclInfo *); 52312957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 52322957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 52332957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief For retrieving a custom CXIdxClientContainer attached to a 52342957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * container. 52352957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 52362957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE CXIdxClientContainer 52372957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidisclang_index_getClientContainer(const CXIdxContainerInfo *); 52382957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 52392957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 52402957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief For setting a custom CXIdxClientContainer attached to a 52412957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * container. 52422957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 52432957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE void 52442957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidisclang_index_setClientContainer(const CXIdxContainerInfo *,CXIdxClientContainer); 52452957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 52462957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 52472957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief For retrieving a custom CXIdxClientEntity attached to an entity. 52482957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 52492957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE CXIdxClientEntity 52502957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidisclang_index_getClientEntity(const CXIdxEntityInfo *); 52512957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 52522957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 52532957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief For setting a custom CXIdxClientEntity attached to an entity. 52542957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 52552957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE void 52562957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidisclang_index_setClientEntity(const CXIdxEntityInfo *, CXIdxClientEntity); 52572957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 52582957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 52592957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief An indexing action, to be applied to one or multiple translation units 52602957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * but not on concurrent threads. If there are threads doing indexing 52612957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * concurrently, they should use different CXIndexAction objects. 52622957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 52632957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidistypedef void *CXIndexAction; 52642957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 52652957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 52662957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief An indexing action, to be applied to one or multiple translation units 52672957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * but not on concurrent threads. If there are threads doing indexing 52682957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * concurrently, they should use different CXIndexAction objects. 52692957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * 52702957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \param CIdx The index object with which the index action will be associated. 52712957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 52722957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE CXIndexAction clang_IndexAction_create(CXIndex CIdx); 52732957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 52742957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis/** 52752957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * \brief Destroy the given index action. 52762957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * 52772957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * The index action must not be destroyed until all of the translation units 52782957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis * created within that index action have been destroyed. 52792957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis */ 52802957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE void clang_IndexAction_dispose(CXIndexAction); 52812957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis 528221ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidistypedef enum { 528321ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis /** 528421ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * \brief Used to indicate that no special indexing options are needed. 528521ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis */ 528621ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis CXIndexOpt_None = 0x0, 528721ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis 528821ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis /** 52897eee0184570366285589d788bcd7f5dda8345915James Dennett * \brief Used to indicate that IndexerCallbacks#indexEntityReference should 52907eee0184570366285589d788bcd7f5dda8345915James Dennett * be invoked for only one reference of an entity per source file that does 52917eee0184570366285589d788bcd7f5dda8345915James Dennett * not also include a declaration/definition of the entity. 529221ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis */ 529322490747c123a78feec089539f30426084d348cfArgyrios Kyrtzidis CXIndexOpt_SuppressRedundantRefs = 0x1, 529422490747c123a78feec089539f30426084d348cfArgyrios Kyrtzidis 529522490747c123a78feec089539f30426084d348cfArgyrios Kyrtzidis /** 529622490747c123a78feec089539f30426084d348cfArgyrios Kyrtzidis * \brief Function-local symbols should be indexed. If this is not set 529722490747c123a78feec089539f30426084d348cfArgyrios Kyrtzidis * function-local symbols will be ignored. 529822490747c123a78feec089539f30426084d348cfArgyrios Kyrtzidis */ 529958d2dbea680a75de266c5eff77cc15c323cfd48aArgyrios Kyrtzidis CXIndexOpt_IndexFunctionLocalSymbols = 0x2, 530058d2dbea680a75de266c5eff77cc15c323cfd48aArgyrios Kyrtzidis 530158d2dbea680a75de266c5eff77cc15c323cfd48aArgyrios Kyrtzidis /** 530258d2dbea680a75de266c5eff77cc15c323cfd48aArgyrios Kyrtzidis * \brief Implicit function/class template instantiations should be indexed. 530358d2dbea680a75de266c5eff77cc15c323cfd48aArgyrios Kyrtzidis * If this is not set, implicit instantiations will be ignored. 530458d2dbea680a75de266c5eff77cc15c323cfd48aArgyrios Kyrtzidis */ 5305b49a29f7e4413a7a014a2b28c5c25fe54e005cf3Argyrios Kyrtzidis CXIndexOpt_IndexImplicitTemplateInstantiations = 0x4, 5306b49a29f7e4413a7a014a2b28c5c25fe54e005cf3Argyrios Kyrtzidis 5307b49a29f7e4413a7a014a2b28c5c25fe54e005cf3Argyrios Kyrtzidis /** 5308b49a29f7e4413a7a014a2b28c5c25fe54e005cf3Argyrios Kyrtzidis * \brief Suppress all compiler warnings when parsing for indexing. 5309b49a29f7e4413a7a014a2b28c5c25fe54e005cf3Argyrios Kyrtzidis */ 5310b49a29f7e4413a7a014a2b28c5c25fe54e005cf3Argyrios Kyrtzidis CXIndexOpt_SuppressWarnings = 0x8 531121ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis} CXIndexOptFlags; 531221ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis 5313bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 5314bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Index the given source file and the translation unit corresponding 53157eee0184570366285589d788bcd7f5dda8345915James Dennett * to that file via callbacks implemented through #IndexerCallbacks. 5316bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 5317bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \param client_data pointer data supplied by the client, which will 5318bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * be passed to the invoked callbacks. 5319bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 5320bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \param index_callbacks Pointer to indexing callbacks that the client 5321bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * implements. 5322bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 53237eee0184570366285589d788bcd7f5dda8345915James Dennett * \param index_callbacks_size Size of #IndexerCallbacks structure that gets 5324bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * passed in index_callbacks. 5325bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 532621ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * \param index_options A bitmask of options that affects how indexing is 532721ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags. 5328bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 5329bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \param out_TU [out] pointer to store a CXTranslationUnit that can be reused 5330bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * after indexing is finished. Set to NULL if you do not require it. 5331bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 533221ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * \returns If there is a failure from which the there is no recovery, returns 5333bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * non-zero, otherwise returns 0. 533421ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * 53357eee0184570366285589d788bcd7f5dda8345915James Dennett * The rest of the parameters are the same as #clang_parseTranslationUnit. 5336bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 53372957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE int clang_indexSourceFile(CXIndexAction, 53384e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXClientData client_data, 53394e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis IndexerCallbacks *index_callbacks, 53404e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned index_callbacks_size, 53414e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned index_options, 53424e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char *source_filename, 53434e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis const char * const *command_line_args, 53444e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis int num_command_line_args, 53454e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis struct CXUnsavedFile *unsaved_files, 53464e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned num_unsaved_files, 53474e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXTranslationUnit *out_TU, 53484e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned TU_options); 53494e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 5350bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 535121ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * \brief Index the given translation unit via callbacks implemented through 53527eee0184570366285589d788bcd7f5dda8345915James Dennett * #IndexerCallbacks. 535321ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * 535421ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * The order of callback invocations is not guaranteed to be the same as 535521ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * when indexing a source file. The high level order will be: 535621ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * 535721ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * -Preprocessor callbacks invocations 535821ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * -Declaration/reference callbacks invocations 535921ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * -Diagnostic callback invocations 536021ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * 53617eee0184570366285589d788bcd7f5dda8345915James Dennett * The parameters are the same as #clang_indexSourceFile. 536221ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * 536321ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * \returns If there is a failure from which the there is no recovery, returns 536421ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis * non-zero, otherwise returns 0. 536521ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis */ 53662957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios KyrtzidisCINDEX_LINKAGE int clang_indexTranslationUnit(CXIndexAction, 536721ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis CXClientData client_data, 536821ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis IndexerCallbacks *index_callbacks, 536921ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis unsigned index_callbacks_size, 53702957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis unsigned index_options, 53712957e6f8c4c2e58a4b9cb639949fea801970fe36Argyrios Kyrtzidis CXTranslationUnit); 537221ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis 537321ee5707e6e59d982d2f2ae28e079c7ff46dc519Argyrios Kyrtzidis/** 5374bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Retrieve the CXIdxFile, file, line, column, and offset represented by 5375bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * the given CXIdxLoc. 5376bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * 5377bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * If the location refers into a macro expansion, retrieves the 5378bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * location of the macro expansion and if it refers into a macro argument 5379bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * retrieves the location of the argument. 5380bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 53814e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc, 5382dd93c596cd95e1b96031ff47efe0a5095ff3d7f1Argyrios Kyrtzidis CXIdxClientFile *indexFile, 53834e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis CXFile *file, 53844e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned *line, 53854e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned *column, 53864e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis unsigned *offset); 53874e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 5388bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis/** 5389bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis * \brief Retrieve the CXSourceLocation represented by the given CXIdxLoc. 5390bd0ddf88415441d3b5741a7bd40a3d56adcd4d66Argyrios Kyrtzidis */ 53914e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCINDEX_LINKAGE 53924e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios KyrtzidisCXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc); 53934e7064fa7e344e8f87a5b8457e96dfdd252c4a9eArgyrios Kyrtzidis 5394aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis/** 5395aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis * @} 5396aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis */ 5397aed123ec3cc37e457fe20a6158fdadf8849ad916Argyrios Kyrtzidis 5398c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor/** 5399c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor * @} 5400c42fefa51f7555bb3644a7cde2ca4bfd0d848d74Douglas Gregor */ 54011efcf3d137c11fb6b21c385911e0d2ca59ca94c3Daniel Dunbar 5402d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#ifdef __cplusplus 5403d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek} 5404d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 5405d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek#endif 5406d2fa56687f8bd5ac6ebf9d9468d0efd714986a54Ted Kremenek 5407