1 /*===-- clang-c/CXString.h - C Index strings --------------------*- C -*-===*\ 2 |* *| 3 |* Part of the LLVM Project, under the Apache License v2.0 with LLVM *| 4 |* Exceptions. *| 5 |* See https://llvm.org/LICENSE.txt for license information. *| 6 |* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *| 7 |* *| 8 |*===----------------------------------------------------------------------===*| 9 |* *| 10 |* This header provides the interface to C Index strings. *| 11 |* *| 12 \*===----------------------------------------------------------------------===*/ 13 14 #ifndef LLVM_CLANG_C_CXSTRING_H 15 #define LLVM_CLANG_C_CXSTRING_H 16 17 #include "clang-c/ExternC.h" 18 #include "clang-c/Platform.h" 19 20 LLVM_CLANG_C_EXTERN_C_BEGIN 21 22 /** 23 * \defgroup CINDEX_STRING String manipulation routines 24 * \ingroup CINDEX 25 * 26 * @{ 27 */ 28 29 /** 30 * A character string. 31 * 32 * The \c CXString type is used to return strings from the interface when 33 * the ownership of that string might differ from one call to the next. 34 * Use \c clang_getCString() to retrieve the string data and, once finished 35 * with the string data, call \c clang_disposeString() to free the string. 36 */ 37 typedef struct { 38 const void *data; 39 unsigned private_flags; 40 } CXString; 41 42 typedef struct { 43 CXString *Strings; 44 unsigned Count; 45 } CXStringSet; 46 47 /** 48 * Retrieve the character data associated with the given string. 49 * 50 * The returned data is a reference and not owned by the user. This data 51 * is only valid while the `CXString` is valid. This function is similar 52 * to `std::string::c_str()`. 53 */ 54 CINDEX_LINKAGE const char *clang_getCString(CXString string); 55 56 /** 57 * Free the given string. 58 */ 59 CINDEX_LINKAGE void clang_disposeString(CXString string); 60 61 /** 62 * Free the given string set. 63 */ 64 CINDEX_LINKAGE void clang_disposeStringSet(CXStringSet *set); 65 66 /** 67 * @} 68 */ 69 70 LLVM_CLANG_C_EXTERN_C_END 71 72 #endif 73 74