LLVM  7.0.0svn
StringExtras.h
Go to the documentation of this file.
1 //===- llvm/ADT/StringExtras.h - Useful string functions --------*- C++ -*-===//
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 contains some functions that are useful when dealing with strings.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_ADT_STRINGEXTRAS_H
15 #define LLVM_ADT_STRINGEXTRAS_H
16 
17 #include "llvm/ADT/ArrayRef.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/ADT/Twine.h"
21 #include <cassert>
22 #include <cstddef>
23 #include <cstdint>
24 #include <cstdlib>
25 #include <cstring>
26 #include <iterator>
27 #include <string>
28 #include <utility>
29 
30 namespace llvm {
31 
32 template<typename T> class SmallVectorImpl;
33 class raw_ostream;
34 
35 /// hexdigit - Return the hexadecimal character for the
36 /// given number \p X (which should be less than 16).
37 inline char hexdigit(unsigned X, bool LowerCase = false) {
38  const char HexChar = LowerCase ? 'a' : 'A';
39  return X < 10 ? '0' + X : HexChar + X - 10;
40 }
41 
42 /// Given an array of c-style strings terminated by a null pointer, construct
43 /// a vector of StringRefs representing the same strings without the terminating
44 /// null string.
45 inline std::vector<StringRef> toStringRefArray(const char *const *Strings) {
46  std::vector<StringRef> Result;
47  while (*Strings)
48  Result.push_back(*Strings++);
49  return Result;
50 }
51 
52 /// Construct a string ref from a boolean.
53 inline StringRef toStringRef(bool B) { return StringRef(B ? "true" : "false"); }
54 
55 /// Construct a string ref from an array ref of unsigned chars.
57  return StringRef(reinterpret_cast<const char *>(Input.begin()), Input.size());
58 }
59 
60 /// Construct a string ref from an array ref of unsigned chars.
62  return {Input.bytes_begin(), Input.bytes_end()};
63 }
64 
65 /// Interpret the given character \p C as a hexadecimal digit and return its
66 /// value.
67 ///
68 /// If \p C is not a valid hex digit, -1U is returned.
69 inline unsigned hexDigitValue(char C) {
70  if (C >= '0' && C <= '9') return C-'0';
71  if (C >= 'a' && C <= 'f') return C-'a'+10U;
72  if (C >= 'A' && C <= 'F') return C-'A'+10U;
73  return -1U;
74 }
75 
76 /// Checks if character \p C is one of the 10 decimal digits.
77 inline bool isDigit(char C) { return C >= '0' && C <= '9'; }
78 
79 /// Checks if character \p C is a hexadecimal numeric character.
80 inline bool isHexDigit(char C) { return hexDigitValue(C) != -1U; }
81 
82 /// Checks if character \p C is a valid letter as classified by "C" locale.
83 inline bool isAlpha(char C) {
84  return ('a' <= C && C <= 'z') || ('A' <= C && C <= 'Z');
85 }
86 
87 /// Checks whether character \p C is either a decimal digit or an uppercase or
88 /// lowercase letter as classified by "C" locale.
89 inline bool isAlnum(char C) { return isAlpha(C) || isDigit(C); }
90 
91 /// Checks whether character \p C is valid ASCII (high bit is zero).
92 inline bool isASCII(char C) { return static_cast<unsigned char>(C) <= 127; }
93 
94 /// Checks whether all characters in S are ASCII.
95 inline bool isASCII(llvm::StringRef S) {
96  for (char C : S)
97  if (LLVM_UNLIKELY(!isASCII(C)))
98  return false;
99  return true;
100 }
101 
102 /// Returns the corresponding lowercase character if \p x is uppercase.
103 inline char toLower(char x) {
104  if (x >= 'A' && x <= 'Z')
105  return x - 'A' + 'a';
106  return x;
107 }
108 
109 /// Returns the corresponding uppercase character if \p x is lowercase.
110 inline char toUpper(char x) {
111  if (x >= 'a' && x <= 'z')
112  return x - 'a' + 'A';
113  return x;
114 }
115 
116 inline std::string utohexstr(uint64_t X, bool LowerCase = false) {
117  char Buffer[17];
118  char *BufPtr = std::end(Buffer);
119 
120  if (X == 0) *--BufPtr = '0';
121 
122  while (X) {
123  unsigned char Mod = static_cast<unsigned char>(X) & 15;
124  *--BufPtr = hexdigit(Mod, LowerCase);
125  X >>= 4;
126  }
127 
128  return std::string(BufPtr, std::end(Buffer));
129 }
130 
131 /// Convert buffer \p Input to its hexadecimal representation.
132 /// The returned string is double the size of \p Input.
133 inline std::string toHex(StringRef Input) {
134  static const char *const LUT = "0123456789ABCDEF";
135  size_t Length = Input.size();
136 
137  std::string Output;
138  Output.reserve(2 * Length);
139  for (size_t i = 0; i < Length; ++i) {
140  const unsigned char c = Input[i];
141  Output.push_back(LUT[c >> 4]);
142  Output.push_back(LUT[c & 15]);
143  }
144  return Output;
145 }
146 
147 inline std::string toHex(ArrayRef<uint8_t> Input) {
148  return toHex(toStringRef(Input));
149 }
150 
151 inline uint8_t hexFromNibbles(char MSB, char LSB) {
152  unsigned U1 = hexDigitValue(MSB);
153  unsigned U2 = hexDigitValue(LSB);
154  assert(U1 != -1U && U2 != -1U);
155 
156  return static_cast<uint8_t>((U1 << 4) | U2);
157 }
158 
159 /// Convert hexadecimal string \p Input to its binary representation.
160 /// The return string is half the size of \p Input.
161 inline std::string fromHex(StringRef Input) {
162  if (Input.empty())
163  return std::string();
164 
165  std::string Output;
166  Output.reserve((Input.size() + 1) / 2);
167  if (Input.size() % 2 == 1) {
168  Output.push_back(hexFromNibbles('0', Input.front()));
169  Input = Input.drop_front();
170  }
171 
172  assert(Input.size() % 2 == 0);
173  while (!Input.empty()) {
174  uint8_t Hex = hexFromNibbles(Input[0], Input[1]);
175  Output.push_back(Hex);
176  Input = Input.drop_front(2);
177  }
178  return Output;
179 }
180 
181 /// Convert the string \p S to an integer of the specified type using
182 /// the radix \p Base. If \p Base is 0, auto-detects the radix.
183 /// Returns true if the number was successfully converted, false otherwise.
184 template <typename N> bool to_integer(StringRef S, N &Num, unsigned Base = 0) {
185  return !S.getAsInteger(Base, Num);
186 }
187 
188 namespace detail {
189 template <typename N>
190 inline bool to_float(const Twine &T, N &Num, N (*StrTo)(const char *, char **)) {
191  SmallString<32> Storage;
192  StringRef S = T.toNullTerminatedStringRef(Storage);
193  char *End;
194  N Temp = StrTo(S.data(), &End);
195  if (*End != '\0')
196  return false;
197  Num = Temp;
198  return true;
199 }
200 }
201 
202 inline bool to_float(const Twine &T, float &Num) {
203  return detail::to_float(T, Num, strtof);
204 }
205 
206 inline bool to_float(const Twine &T, double &Num) {
207  return detail::to_float(T, Num, strtod);
208 }
209 
210 inline bool to_float(const Twine &T, long double &Num) {
211  return detail::to_float(T, Num, strtold);
212 }
213 
214 inline std::string utostr(uint64_t X, bool isNeg = false) {
215  char Buffer[21];
216  char *BufPtr = std::end(Buffer);
217 
218  if (X == 0) *--BufPtr = '0'; // Handle special case...
219 
220  while (X) {
221  *--BufPtr = '0' + char(X % 10);
222  X /= 10;
223  }
224 
225  if (isNeg) *--BufPtr = '-'; // Add negative sign...
226  return std::string(BufPtr, std::end(Buffer));
227 }
228 
229 inline std::string itostr(int64_t X) {
230  if (X < 0)
231  return utostr(static_cast<uint64_t>(-X), true);
232  else
233  return utostr(static_cast<uint64_t>(X));
234 }
235 
236 /// StrInStrNoCase - Portable version of strcasestr. Locates the first
237 /// occurrence of string 's1' in string 's2', ignoring case. Returns
238 /// the offset of s2 in s1 or npos if s2 cannot be found.
240 
241 /// getToken - This function extracts one token from source, ignoring any
242 /// leading characters that appear in the Delimiters string, and ending the
243 /// token at any of the characters that appear in the Delimiters string. If
244 /// there are no tokens in the source string, an empty string is returned.
245 /// The function returns a pair containing the extracted token and the
246 /// remaining tail string.
247 std::pair<StringRef, StringRef> getToken(StringRef Source,
248  StringRef Delimiters = " \t\n\v\f\r");
249 
250 /// SplitString - Split up the specified string according to the specified
251 /// delimiters, appending the result fragments to the output list.
252 void SplitString(StringRef Source,
253  SmallVectorImpl<StringRef> &OutFragments,
254  StringRef Delimiters = " \t\n\v\f\r");
255 
256 /// Returns the English suffix for an ordinal integer (-st, -nd, -rd, -th).
257 inline StringRef getOrdinalSuffix(unsigned Val) {
258  // It is critically important that we do this perfectly for
259  // user-written sequences with over 100 elements.
260  switch (Val % 100) {
261  case 11:
262  case 12:
263  case 13:
264  return "th";
265  default:
266  switch (Val % 10) {
267  case 1: return "st";
268  case 2: return "nd";
269  case 3: return "rd";
270  default: return "th";
271  }
272  }
273 }
274 
275 /// Print each character of the specified string, escaping it if it is not
276 /// printable or if it is an escape char.
278 
279 /// Print each character of the specified string, escaping HTML special
280 /// characters.
281 void printHTMLEscaped(StringRef String, raw_ostream &Out);
282 
283 /// printLowerCase - Print each character as lowercase if it is uppercase.
284 void printLowerCase(StringRef String, raw_ostream &Out);
285 
286 namespace detail {
287 
288 template <typename IteratorT>
289 inline std::string join_impl(IteratorT Begin, IteratorT End,
290  StringRef Separator, std::input_iterator_tag) {
291  std::string S;
292  if (Begin == End)
293  return S;
294 
295  S += (*Begin);
296  while (++Begin != End) {
297  S += Separator;
298  S += (*Begin);
299  }
300  return S;
301 }
302 
303 template <typename IteratorT>
304 inline std::string join_impl(IteratorT Begin, IteratorT End,
305  StringRef Separator, std::forward_iterator_tag) {
306  std::string S;
307  if (Begin == End)
308  return S;
309 
310  size_t Len = (std::distance(Begin, End) - 1) * Separator.size();
311  for (IteratorT I = Begin; I != End; ++I)
312  Len += (*Begin).size();
313  S.reserve(Len);
314  S += (*Begin);
315  while (++Begin != End) {
316  S += Separator;
317  S += (*Begin);
318  }
319  return S;
320 }
321 
322 template <typename Sep>
323 inline void join_items_impl(std::string &Result, Sep Separator) {}
324 
325 template <typename Sep, typename Arg>
326 inline void join_items_impl(std::string &Result, Sep Separator,
327  const Arg &Item) {
328  Result += Item;
329 }
330 
331 template <typename Sep, typename Arg1, typename... Args>
332 inline void join_items_impl(std::string &Result, Sep Separator, const Arg1 &A1,
333  Args &&... Items) {
334  Result += A1;
335  Result += Separator;
336  join_items_impl(Result, Separator, std::forward<Args>(Items)...);
337 }
338 
339 inline size_t join_one_item_size(char C) { return 1; }
340 inline size_t join_one_item_size(const char *S) { return S ? ::strlen(S) : 0; }
341 
342 template <typename T> inline size_t join_one_item_size(const T &Str) {
343  return Str.size();
344 }
345 
346 inline size_t join_items_size() { return 0; }
347 
348 template <typename A1> inline size_t join_items_size(const A1 &A) {
349  return join_one_item_size(A);
350 }
351 template <typename A1, typename... Args>
352 inline size_t join_items_size(const A1 &A, Args &&... Items) {
353  return join_one_item_size(A) + join_items_size(std::forward<Args>(Items)...);
354 }
355 
356 } // end namespace detail
357 
358 /// Joins the strings in the range [Begin, End), adding Separator between
359 /// the elements.
360 template <typename IteratorT>
361 inline std::string join(IteratorT Begin, IteratorT End, StringRef Separator) {
362  using tag = typename std::iterator_traits<IteratorT>::iterator_category;
363  return detail::join_impl(Begin, End, Separator, tag());
364 }
365 
366 /// Joins the strings in the range [R.begin(), R.end()), adding Separator
367 /// between the elements.
368 template <typename Range>
369 inline std::string join(Range &&R, StringRef Separator) {
370  return join(R.begin(), R.end(), Separator);
371 }
372 
373 /// Joins the strings in the parameter pack \p Items, adding \p Separator
374 /// between the elements. All arguments must be implicitly convertible to
375 /// std::string, or there should be an overload of std::string::operator+=()
376 /// that accepts the argument explicitly.
377 template <typename Sep, typename... Args>
378 inline std::string join_items(Sep Separator, Args &&... Items) {
379  std::string Result;
380  if (sizeof...(Items) == 0)
381  return Result;
382 
383  size_t NS = detail::join_one_item_size(Separator);
384  size_t NI = detail::join_items_size(std::forward<Args>(Items)...);
385  Result.reserve(NI + (sizeof...(Items) - 1) * NS + 1);
386  detail::join_items_impl(Result, Separator, std::forward<Args>(Items)...);
387  return Result;
388 }
389 
390 } // end namespace llvm
391 
392 #endif // LLVM_ADT_STRINGEXTRAS_H
bool to_float(const Twine &T, N &Num, N(*StrTo)(const char *, char **))
Definition: StringExtras.h:190
uint64_t CallInst * C
const_iterator end(StringRef path)
Get end iterator over path.
Definition: Path.cpp:250
std::string join_items(Sep Separator, Args &&... Items)
Joins the strings in the parameter pack Items, adding Separator between the elements.
Definition: StringExtras.h:378
static GCMetadataPrinterRegistry::Add< ErlangGCPrinter > X("erlang", "erlang-compatible garbage collector")
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
const unsigned char * bytes_end() const
Definition: StringRef.h:113
bool to_integer(StringRef S, N &Num, unsigned Base=0)
Convert the string S to an integer of the specified type using the radix Base.
Definition: StringExtras.h:184
#define LLVM_UNLIKELY(EXPR)
Definition: Compiler.h:179
iterator begin() const
Definition: ArrayRef.h:137
size_t join_items_size()
Definition: StringExtras.h:346
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE size_t size() const
size - Get the string size.
Definition: StringRef.h:138
bool isASCII(char C)
Checks whether character C is valid ASCII (high bit is zero).
Definition: StringExtras.h:92
void printEscapedString(StringRef Name, raw_ostream &Out)
Print each character of the specified string, escaping it if it is not printable or if it is an escap...
ArrayRef< uint8_t > arrayRefFromStringRef(StringRef Input)
Construct a string ref from an array ref of unsigned chars.
Definition: StringExtras.h:61
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE const char * data() const
data - Get a pointer to the start of the string (which may not be null terminated).
Definition: StringRef.h:128
std::string fromHex(StringRef Input)
Convert hexadecimal string Input to its binary representation.
Definition: StringExtras.h:161
bool isAlnum(char C)
Checks whether character C is either a decimal digit or an uppercase or lowercase letter as classifie...
Definition: StringExtras.h:89
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
std::string join(IteratorT Begin, IteratorT End, StringRef Separator)
Joins the strings in the range [Begin, End), adding Separator between the elements.
Definition: StringExtras.h:361
void SplitString(StringRef Source, SmallVectorImpl< StringRef > &OutFragments, StringRef Delimiters=" \\\)
SplitString - Split up the specified string according to the specified delimiters, appending the result fragments to the output list.
std::pair< StringRef, StringRef > getToken(StringRef Source, StringRef Delimiters=" \\\)
getToken - This function extracts one token from source, ignoring any leading characters that appear ...
std::string itostr(int64_t X)
Definition: StringExtras.h:229
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:133
char hexdigit(unsigned X, bool LowerCase=false)
hexdigit - Return the hexadecimal character for the given number X (which should be less than 16)...
Definition: StringExtras.h:37
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
void join_items_impl(std::string &Result, Sep Separator)
Definition: StringExtras.h:323
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:149
bool isHexDigit(char C)
Checks if character C is a hexadecimal numeric character.
Definition: StringExtras.h:80
StringRef toNullTerminatedStringRef(SmallVectorImpl< char > &Out) const
This returns the twine as a single null terminated StringRef if it can be represented as such...
Definition: Twine.cpp:38
bool isAlpha(char C)
Checks if character C is a valid letter as classified by "C" locale.
Definition: StringExtras.h:83
char toLower(char x)
Returns the corresponding lowercase character if x is uppercase.
Definition: StringExtras.h:103
StringRef toStringRef(bool B)
Construct a string ref from a boolean.
Definition: StringExtras.h:53
size_t join_one_item_size(char C)
Definition: StringExtras.h:339
std::enable_if< std::numeric_limits< T >::is_signed, bool >::type getAsInteger(unsigned Radix, T &Result) const
Parse the current string as an integer of the specified radix.
Definition: StringRef.h:497
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE StringRef drop_front(size_t N=1) const
Return a StringRef equal to &#39;this&#39; but with the first N elements dropped.
Definition: StringRef.h:645
std::string utostr(uint64_t X, bool isNeg=false)
Definition: StringExtras.h:214
The access may modify the value stored in memory.
std::string toHex(StringRef Input)
Convert buffer Input to its hexadecimal representation.
Definition: StringExtras.h:133
unsigned hexDigitValue(char C)
Interpret the given character C as a hexadecimal digit and return its value.
Definition: StringExtras.h:69
amdgpu Simplify well known AMD library false Value Value * Arg
bool isDigit(char C)
Checks if character C is one of the 10 decimal digits.
Definition: StringExtras.h:77
const unsigned char * bytes_begin() const
Definition: StringRef.h:110
#define I(x, y, z)
Definition: MD5.cpp:58
#define N
StringRef::size_type StrInStrNoCase(StringRef s1, StringRef s2)
StrInStrNoCase - Portable version of strcasestr.
StringRef getOrdinalSuffix(unsigned Val)
Returns the English suffix for an ordinal integer (-st, -nd, -rd, -th).
Definition: StringExtras.h:257
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
char toUpper(char x)
Returns the corresponding uppercase character if x is lowercase.
Definition: StringExtras.h:110
LLVM_NODISCARD char front() const
front - Get the first character in the string.
Definition: StringRef.h:142
void printLowerCase(StringRef String, raw_ostream &Out)
printLowerCase - Print each character as lowercase if it is uppercase.
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:46
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
uint8_t hexFromNibbles(char MSB, char LSB)
Definition: StringExtras.h:151
void printHTMLEscaped(StringRef String, raw_ostream &Out)
Print each character of the specified string, escaping HTML special characters.
constexpr char Args[]
Key for Kernel::Metadata::mArgs.
std::string join_impl(IteratorT Begin, IteratorT End, StringRef Separator, std::input_iterator_tag)
Definition: StringExtras.h:289
std::vector< StringRef > toStringRefArray(const char *const *Strings)
Given an array of c-style strings terminated by a null pointer, construct a vector of StringRefs repr...
Definition: StringExtras.h:45
std::string utohexstr(uint64_t X, bool LowerCase=false)
Definition: StringExtras.h:116