Ted Kremenek | ea834df | 2010-11-16 02:03:55 +0000 | [diff] [blame] | 1 | //===- CXString.cpp - Routines for manipulating CXStrings -----------------===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file defines routines for manipulating CXStrings. It should be the |
| 11 | // only file that has internal knowledge of the encoding of the data in |
| 12 | // CXStrings. |
| 13 | // |
| 14 | //===----------------------------------------------------------------------===// |
| 15 | |
| 16 | #include "CXString.h" |
Ted Kremenek | 0a90d32 | 2010-11-17 23:24:11 +0000 | [diff] [blame] | 17 | #include "CXTranslationUnit.h" |
Ted Kremenek | ea834df | 2010-11-16 02:03:55 +0000 | [diff] [blame] | 18 | #include "clang-c/Index.h" |
Chandler Carruth | f59edb9 | 2012-12-04 09:25:21 +0000 | [diff] [blame] | 19 | #include "clang/Frontend/ASTUnit.h" |
Ted Kremenek | a60ed47 | 2010-11-16 08:15:36 +0000 | [diff] [blame] | 20 | #include "llvm/ADT/SmallString.h" |
Ted Kremenek | ea834df | 2010-11-16 02:03:55 +0000 | [diff] [blame] | 21 | #include "llvm/Support/ErrorHandling.h" |
| 22 | |
| 23 | using namespace clang; |
Ted Kremenek | ea834df | 2010-11-16 02:03:55 +0000 | [diff] [blame] | 24 | |
Dmitri Gribenko | 17c1a24 | 2013-02-01 16:36:31 +0000 | [diff] [blame] | 25 | /// Describes the kind of underlying data in CXString. |
| 26 | enum CXStringFlag { |
| 27 | /// CXString contains a 'const char *' that it doesn't own. |
| 28 | CXS_Unmanaged, |
| 29 | |
| 30 | /// CXString contains a 'const char *' that it allocated with malloc(). |
| 31 | CXS_Malloc, |
| 32 | |
| 33 | /// CXString contains a CXStringBuf that needs to be returned to the |
| 34 | /// CXStringPool. |
| 35 | CXS_StringBuf |
| 36 | }; |
Ted Kremenek | a60ed47 | 2010-11-16 08:15:36 +0000 | [diff] [blame] | 37 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 38 | namespace clang { |
| 39 | namespace cxstring { |
| 40 | |
Ted Kremenek | a60ed47 | 2010-11-16 08:15:36 +0000 | [diff] [blame] | 41 | //===----------------------------------------------------------------------===// |
| 42 | // Basic generation of CXStrings. |
| 43 | //===----------------------------------------------------------------------===// |
Ted Kremenek | ea834df | 2010-11-16 02:03:55 +0000 | [diff] [blame] | 44 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 45 | CXString createEmpty() { |
Dmitri Gribenko | dc66adb | 2013-02-01 14:21:22 +0000 | [diff] [blame] | 46 | CXString Str; |
| 47 | Str.data = ""; |
| 48 | Str.private_flags = CXS_Unmanaged; |
| 49 | return Str; |
| 50 | } |
| 51 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 52 | CXString createNull() { |
Dmitri Gribenko | dad4c1a | 2013-02-01 14:13:32 +0000 | [diff] [blame] | 53 | CXString Str; |
Stephen Hines | c568f1e | 2014-07-21 00:47:37 -0700 | [diff] [blame] | 54 | Str.data = nullptr; |
Dmitri Gribenko | dad4c1a | 2013-02-01 14:13:32 +0000 | [diff] [blame] | 55 | Str.private_flags = CXS_Unmanaged; |
| 56 | return Str; |
| 57 | } |
| 58 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 59 | CXString createRef(const char *String) { |
Dmitri Gribenko | 0c4394c | 2013-02-02 00:02:12 +0000 | [diff] [blame] | 60 | if (String && String[0] == '\0') |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 61 | return createEmpty(); |
Dmitri Gribenko | 0c4394c | 2013-02-02 00:02:12 +0000 | [diff] [blame] | 62 | |
Ted Kremenek | ea834df | 2010-11-16 02:03:55 +0000 | [diff] [blame] | 63 | CXString Str; |
Dmitri Gribenko | 0c4394c | 2013-02-02 00:02:12 +0000 | [diff] [blame] | 64 | Str.data = String; |
| 65 | Str.private_flags = CXS_Unmanaged; |
| 66 | return Str; |
| 67 | } |
| 68 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 69 | CXString createDup(const char *String) { |
Dmitri Gribenko | 0c4394c | 2013-02-02 00:02:12 +0000 | [diff] [blame] | 70 | if (!String) |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 71 | return createNull(); |
Dmitri Gribenko | 0c4394c | 2013-02-02 00:02:12 +0000 | [diff] [blame] | 72 | |
| 73 | if (String[0] == '\0') |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 74 | return createEmpty(); |
Dmitri Gribenko | 0c4394c | 2013-02-02 00:02:12 +0000 | [diff] [blame] | 75 | |
| 76 | CXString Str; |
| 77 | Str.data = strdup(String); |
| 78 | Str.private_flags = CXS_Malloc; |
Ted Kremenek | ea834df | 2010-11-16 02:03:55 +0000 | [diff] [blame] | 79 | return Str; |
| 80 | } |
| 81 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 82 | CXString createRef(StringRef String) { |
Dmitri Gribenko | 5595ded | 2013-02-02 02:19:29 +0000 | [diff] [blame] | 83 | // If the string is not nul-terminated, we have to make a copy. |
Stephen Hines | c568f1e | 2014-07-21 00:47:37 -0700 | [diff] [blame] | 84 | |
| 85 | // FIXME: This is doing a one past end read, and should be removed! For memory |
| 86 | // we don't manage, the API string can become unterminated at any time outside |
| 87 | // our control. |
| 88 | |
Dmitri Gribenko | 5595ded | 2013-02-02 02:19:29 +0000 | [diff] [blame] | 89 | if (!String.empty() && String.data()[String.size()] != 0) |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 90 | return createDup(String); |
Dmitri Gribenko | 5595ded | 2013-02-02 02:19:29 +0000 | [diff] [blame] | 91 | |
Ted Kremenek | ea834df | 2010-11-16 02:03:55 +0000 | [diff] [blame] | 92 | CXString Result; |
Dmitri Gribenko | 5595ded | 2013-02-02 02:19:29 +0000 | [diff] [blame] | 93 | Result.data = String.data(); |
| 94 | Result.private_flags = (unsigned) CXS_Unmanaged; |
| 95 | return Result; |
| 96 | } |
| 97 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 98 | CXString createDup(StringRef String) { |
Dmitri Gribenko | 5595ded | 2013-02-02 02:19:29 +0000 | [diff] [blame] | 99 | CXString Result; |
| 100 | char *Spelling = static_cast<char *>(malloc(String.size() + 1)); |
| 101 | memmove(Spelling, String.data(), String.size()); |
| 102 | Spelling[String.size()] = 0; |
| 103 | Result.data = Spelling; |
| 104 | Result.private_flags = (unsigned) CXS_Malloc; |
Ted Kremenek | ea834df | 2010-11-16 02:03:55 +0000 | [diff] [blame] | 105 | return Result; |
| 106 | } |
| 107 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 108 | CXString createCXString(CXStringBuf *buf) { |
Ted Kremenek | a60ed47 | 2010-11-16 08:15:36 +0000 | [diff] [blame] | 109 | CXString Str; |
| 110 | Str.data = buf; |
| 111 | Str.private_flags = (unsigned) CXS_StringBuf; |
| 112 | return Str; |
| 113 | } |
| 114 | |
| 115 | |
| 116 | //===----------------------------------------------------------------------===// |
| 117 | // String pools. |
| 118 | //===----------------------------------------------------------------------===// |
| 119 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 120 | CXStringPool::~CXStringPool() { |
Dmitri Gribenko | 9c48d16 | 2013-01-26 22:44:19 +0000 | [diff] [blame] | 121 | for (std::vector<CXStringBuf *>::iterator I = Pool.begin(), E = Pool.end(); |
| 122 | I != E; ++I) { |
| 123 | delete *I; |
Ted Kremenek | a60ed47 | 2010-11-16 08:15:36 +0000 | [diff] [blame] | 124 | } |
| 125 | } |
| 126 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 127 | CXStringBuf *CXStringPool::getCXStringBuf(CXTranslationUnit TU) { |
Dmitri Gribenko | 9c48d16 | 2013-01-26 22:44:19 +0000 | [diff] [blame] | 128 | if (Pool.empty()) |
Ted Kremenek | a60ed47 | 2010-11-16 08:15:36 +0000 | [diff] [blame] | 129 | return new CXStringBuf(TU); |
Dmitri Gribenko | 9c48d16 | 2013-01-26 22:44:19 +0000 | [diff] [blame] | 130 | |
| 131 | CXStringBuf *Buf = Pool.back(); |
| 132 | Buf->Data.clear(); |
| 133 | Pool.pop_back(); |
| 134 | return Buf; |
Ted Kremenek | a60ed47 | 2010-11-16 08:15:36 +0000 | [diff] [blame] | 135 | } |
| 136 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 137 | CXStringBuf *getCXStringBuf(CXTranslationUnit TU) { |
Dmitri Gribenko | 9c48d16 | 2013-01-26 22:44:19 +0000 | [diff] [blame] | 138 | return TU->StringPool->getCXStringBuf(TU); |
| 139 | } |
| 140 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 141 | void CXStringBuf::dispose() { |
Dmitri Gribenko | 9c48d16 | 2013-01-26 22:44:19 +0000 | [diff] [blame] | 142 | TU->StringPool->Pool.push_back(this); |
Ted Kremenek | a60ed47 | 2010-11-16 08:15:36 +0000 | [diff] [blame] | 143 | } |
| 144 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 145 | bool isManagedByPool(CXString str) { |
Ted Kremenek | baf82b0 | 2011-08-17 22:19:53 +0000 | [diff] [blame] | 146 | return ((CXStringFlag) str.private_flags) == CXS_StringBuf; |
| 147 | } |
| 148 | |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 149 | } // end namespace cxstring |
| 150 | } // end namespace clang |
| 151 | |
Ted Kremenek | ea834df | 2010-11-16 02:03:55 +0000 | [diff] [blame] | 152 | //===----------------------------------------------------------------------===// |
| 153 | // libClang public APIs. |
| 154 | //===----------------------------------------------------------------------===// |
| 155 | |
| 156 | extern "C" { |
| 157 | const char *clang_getCString(CXString string) { |
Ted Kremenek | a60ed47 | 2010-11-16 08:15:36 +0000 | [diff] [blame] | 158 | if (string.private_flags == (unsigned) CXS_StringBuf) { |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 159 | return static_cast<const cxstring::CXStringBuf *>(string.data)->Data.data(); |
Ted Kremenek | a60ed47 | 2010-11-16 08:15:36 +0000 | [diff] [blame] | 160 | } |
Dmitri Gribenko | e358fd5 | 2013-01-11 23:13:36 +0000 | [diff] [blame] | 161 | return static_cast<const char *>(string.data); |
Ted Kremenek | ea834df | 2010-11-16 02:03:55 +0000 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | void clang_disposeString(CXString string) { |
Ted Kremenek | a60ed47 | 2010-11-16 08:15:36 +0000 | [diff] [blame] | 165 | switch ((CXStringFlag) string.private_flags) { |
| 166 | case CXS_Unmanaged: |
| 167 | break; |
| 168 | case CXS_Malloc: |
| 169 | if (string.data) |
Dmitri Gribenko | 689d747 | 2013-01-11 23:08:18 +0000 | [diff] [blame] | 170 | free(const_cast<void *>(string.data)); |
Ted Kremenek | a60ed47 | 2010-11-16 08:15:36 +0000 | [diff] [blame] | 171 | break; |
| 172 | case CXS_StringBuf: |
Dmitri Gribenko | f06faad | 2013-02-03 13:54:26 +0000 | [diff] [blame] | 173 | static_cast<cxstring::CXStringBuf *>( |
Dmitri Gribenko | 9c48d16 | 2013-01-26 22:44:19 +0000 | [diff] [blame] | 174 | const_cast<void *>(string.data))->dispose(); |
Ted Kremenek | a60ed47 | 2010-11-16 08:15:36 +0000 | [diff] [blame] | 175 | break; |
| 176 | } |
Ted Kremenek | ea834df | 2010-11-16 02:03:55 +0000 | [diff] [blame] | 177 | } |
| 178 | } // end: extern "C" |
| 179 | |