1 //===--- StringRef.h - Constant String Reference Wrapper --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_ADT_STRINGREF_H
11 #define LLVM_ADT_STRINGREF_H
20 class SmallVectorImpl;
23 /// StringRef - Represent a constant reference to a string, i.e. a character
24 /// array and a length, which need not be null terminated.
26 /// This class does not own the string data, it is expected to be used in
27 /// situations where the character data resides in some other buffer, whose
28 /// lifetime extends past that of the StringRef. For this reason, it is not in
29 /// general safe to store a StringRef.
32 typedef const char *iterator;
33 typedef const char *const_iterator;
34 static const size_t npos = ~size_t(0);
35 typedef size_t size_type;
38 /// The start of the string, in an external buffer.
41 /// The length of the string.
44 // Workaround PR5482: nearly all gcc 4.x miscompile StringRef and std::min()
45 // Changing the arg of min to be an integer, instead of a reference to an
46 // integer works around this bug.
47 static size_t min(size_t a, size_t b) { return a < b ? a : b; }
48 static size_t max(size_t a, size_t b) { return a > b ? a : b; }
51 /// @name Constructors
54 /// Construct an empty string ref.
55 /*implicit*/ StringRef() : Data(0), Length(0) {}
57 /// Construct a string ref from a cstring.
58 /*implicit*/ StringRef(const char *Str)
59 : Data(Str), Length(::strlen(Str)) {}
61 /// Construct a string ref from a pointer and length.
62 /*implicit*/ StringRef(const char *data, size_t length)
63 : Data(data), Length(length) {}
65 /// Construct a string ref from an std::string.
66 /*implicit*/ StringRef(const std::string &Str)
67 : Data(Str.data()), Length(Str.length()) {}
73 iterator begin() const { return Data; }
75 iterator end() const { return Data + Length; }
78 /// @name String Operations
81 /// data - Get a pointer to the start of the string (which may not be null
83 const char *data() const { return Data; }
85 /// empty - Check if the string is empty.
86 bool empty() const { return Length == 0; }
88 /// size - Get the string size.
89 size_t size() const { return Length; }
91 /// front - Get the first character in the string.
97 /// back - Get the last character in the string.
100 return Data[Length-1];
103 /// equals - Check for string equality, this is more efficient than
104 /// compare() when the relative ordering of inequal strings isn't needed.
105 bool equals(StringRef RHS) const {
106 return (Length == RHS.Length &&
107 memcmp(Data, RHS.Data, RHS.Length) == 0);
110 /// equals_lower - Check for string equality, ignoring case.
111 bool equals_lower(StringRef RHS) const {
112 return Length == RHS.Length && compare_lower(RHS) == 0;
115 /// compare - Compare two strings; the result is -1, 0, or 1 if this string
116 /// is lexicographically less than, equal to, or greater than the \arg RHS.
117 int compare(StringRef RHS) const {
118 // Check the prefix for a mismatch.
119 if (int Res = memcmp(Data, RHS.Data, min(Length, RHS.Length)))
120 return Res < 0 ? -1 : 1;
122 // Otherwise the prefixes match, so we only need to check the lengths.
123 if (Length == RHS.Length)
125 return Length < RHS.Length ? -1 : 1;
128 /// compare_lower - Compare two strings, ignoring case.
129 int compare_lower(StringRef RHS) const;
131 /// compare_numeric - Compare two strings, treating sequences of digits as
133 int compare_numeric(StringRef RHS) const;
135 /// \brief Determine the edit distance between this string and another
138 /// \param Other the string to compare this string against.
140 /// \param AllowReplacements whether to allow character
141 /// replacements (change one character into another) as a single
142 /// operation, rather than as two operations (an insertion and a
145 /// \param MaxEditDistance If non-zero, the maximum edit distance that
146 /// this routine is allowed to compute. If the edit distance will exceed
147 /// that maximum, returns \c MaxEditDistance+1.
149 /// \returns the minimum number of character insertions, removals,
150 /// or (if \p AllowReplacements is \c true) replacements needed to
151 /// transform one of the given strings into the other. If zero,
152 /// the strings are identical.
153 unsigned edit_distance(StringRef Other, bool AllowReplacements = true,
154 unsigned MaxEditDistance = 0);
156 /// str - Get the contents as an std::string.
157 std::string str() const {
158 if (Data == 0) return std::string();
159 return std::string(Data, Length);
163 /// @name Operator Overloads
166 char operator[](size_t Index) const {
167 assert(Index < Length && "Invalid index!");
172 /// @name Type Conversions
175 operator std::string() const {
180 /// @name String Predicates
183 /// startswith - Check if this string starts with the given \arg Prefix.
184 bool startswith(StringRef Prefix) const {
185 return Length >= Prefix.Length &&
186 memcmp(Data, Prefix.Data, Prefix.Length) == 0;
189 /// endswith - Check if this string ends with the given \arg Suffix.
190 bool endswith(StringRef Suffix) const {
191 return Length >= Suffix.Length &&
192 memcmp(end() - Suffix.Length, Suffix.Data, Suffix.Length) == 0;
196 /// @name String Searching
199 /// find - Search for the first character \arg C in the string.
201 /// \return - The index of the first occurrence of \arg C, or npos if not
203 size_t find(char C, size_t From = 0) const {
204 for (size_t i = min(From, Length), e = Length; i != e; ++i)
210 /// find - Search for the first string \arg Str in the string.
212 /// \return - The index of the first occurrence of \arg Str, or npos if not
214 size_t find(StringRef Str, size_t From = 0) const;
216 /// rfind - Search for the last character \arg C in the string.
218 /// \return - The index of the last occurrence of \arg C, or npos if not
220 size_t rfind(char C, size_t From = npos) const {
221 From = min(From, Length);
231 /// rfind - Search for the last string \arg Str in the string.
233 /// \return - The index of the last occurrence of \arg Str, or npos if not
235 size_t rfind(StringRef Str) const;
237 /// find_first_of - Find the first character in the string that is \arg C,
238 /// or npos if not found. Same as find.
239 size_type find_first_of(char C, size_t From = 0) const {
240 return find(C, From);
243 /// find_first_of - Find the first character in the string that is in \arg
244 /// Chars, or npos if not found.
246 /// Note: O(size() + Chars.size())
247 size_type find_first_of(StringRef Chars, size_t From = 0) const;
249 /// find_first_not_of - Find the first character in the string that is not
250 /// \arg C or npos if not found.
251 size_type find_first_not_of(char C, size_t From = 0) const;
253 /// find_first_not_of - Find the first character in the string that is not
254 /// in the string \arg Chars, or npos if not found.
256 /// Note: O(size() + Chars.size())
257 size_type find_first_not_of(StringRef Chars, size_t From = 0) const;
260 /// @name Helpful Algorithms
263 /// count - Return the number of occurrences of \arg C in the string.
264 size_t count(char C) const {
266 for (size_t i = 0, e = Length; i != e; ++i)
272 /// count - Return the number of non-overlapped occurrences of \arg Str in
274 size_t count(StringRef Str) const;
276 /// getAsInteger - Parse the current string as an integer of the specified
277 /// radix. If Radix is specified as zero, this does radix autosensing using
278 /// extended C rules: 0 is octal, 0x is hex, 0b is binary.
280 /// If the string is invalid or if only a subset of the string is valid,
281 /// this returns true to signify the error. The string is considered
282 /// erroneous if empty.
284 bool getAsInteger(unsigned Radix, long long &Result) const;
285 bool getAsInteger(unsigned Radix, unsigned long long &Result) const;
286 bool getAsInteger(unsigned Radix, int &Result) const;
287 bool getAsInteger(unsigned Radix, unsigned &Result) const;
289 // TODO: Provide overloads for int/unsigned that check for overflow.
291 /// getAsInteger - Parse the current string as an integer of the
292 /// specified radix, or of an autosensed radix if the radix given
293 /// is 0. The current value in Result is discarded, and the
294 /// storage is changed to be wide enough to store the parsed
297 /// Returns true if the string does not solely consist of a valid
298 /// non-empty number in the appropriate base.
300 /// APInt::fromString is superficially similar but assumes the
301 /// string is well-formed in the given radix.
302 bool getAsInteger(unsigned Radix, APInt &Result) const;
305 /// @name Substring Operations
308 /// substr - Return a reference to the substring from [Start, Start + N).
310 /// \param Start - The index of the starting character in the substring; if
311 /// the index is npos or greater than the length of the string then the
312 /// empty substring will be returned.
314 /// \param N - The number of characters to included in the substring. If N
315 /// exceeds the number of characters remaining in the string, the string
316 /// suffix (starting with \arg Start) will be returned.
317 StringRef substr(size_t Start, size_t N = npos) const {
318 Start = min(Start, Length);
319 return StringRef(Data + Start, min(N, Length - Start));
322 /// slice - Return a reference to the substring from [Start, End).
324 /// \param Start - The index of the starting character in the substring; if
325 /// the index is npos or greater than the length of the string then the
326 /// empty substring will be returned.
328 /// \param End - The index following the last character to include in the
329 /// substring. If this is npos, or less than \arg Start, or exceeds the
330 /// number of characters remaining in the string, the string suffix
331 /// (starting with \arg Start) will be returned.
332 StringRef slice(size_t Start, size_t End) const {
333 Start = min(Start, Length);
334 End = min(max(Start, End), Length);
335 return StringRef(Data + Start, End - Start);
338 /// split - Split into two substrings around the first occurrence of a
339 /// separator character.
341 /// If \arg Separator is in the string, then the result is a pair (LHS, RHS)
342 /// such that (*this == LHS + Separator + RHS) is true and RHS is
343 /// maximal. If \arg Separator is not in the string, then the result is a
344 /// pair (LHS, RHS) where (*this == LHS) and (RHS == "").
346 /// \param Separator - The character to split on.
347 /// \return - The split substrings.
348 std::pair<StringRef, StringRef> split(char Separator) const {
349 size_t Idx = find(Separator);
351 return std::make_pair(*this, StringRef());
352 return std::make_pair(slice(0, Idx), slice(Idx+1, npos));
355 /// split - Split into two substrings around the first occurrence of a
356 /// separator string.
358 /// If \arg Separator is in the string, then the result is a pair (LHS, RHS)
359 /// such that (*this == LHS + Separator + RHS) is true and RHS is
360 /// maximal. If \arg Separator is not in the string, then the result is a
361 /// pair (LHS, RHS) where (*this == LHS) and (RHS == "").
363 /// \param Separator - The string to split on.
364 /// \return - The split substrings.
365 std::pair<StringRef, StringRef> split(StringRef Separator) const {
366 size_t Idx = find(Separator);
368 return std::make_pair(*this, StringRef());
369 return std::make_pair(slice(0, Idx), slice(Idx + Separator.size(), npos));
372 /// split - Split into substrings around the occurrences of a separator
375 /// Each substring is stored in \arg A. If \arg MaxSplit is >= 0, at most
376 /// \arg MaxSplit splits are done and consequently <= \arg MaxSplit
377 /// elements are added to A.
378 /// If \arg KeepEmpty is false, empty strings are not added to \arg A. They
379 /// still count when considering \arg MaxSplit
380 /// An useful invariant is that
381 /// Separator.join(A) == *this if MaxSplit == -1 and KeepEmpty == true
383 /// \param A - Where to put the substrings.
384 /// \param Separator - The string to split on.
385 /// \param MaxSplit - The maximum number of times the string is split.
386 /// \param KeepEmpty - True if empty substring should be added.
387 void split(SmallVectorImpl<StringRef> &A,
388 StringRef Separator, int MaxSplit = -1,
389 bool KeepEmpty = true) const;
391 /// rsplit - Split into two substrings around the last occurrence of a
392 /// separator character.
394 /// If \arg Separator is in the string, then the result is a pair (LHS, RHS)
395 /// such that (*this == LHS + Separator + RHS) is true and RHS is
396 /// minimal. If \arg Separator is not in the string, then the result is a
397 /// pair (LHS, RHS) where (*this == LHS) and (RHS == "").
399 /// \param Separator - The character to split on.
400 /// \return - The split substrings.
401 std::pair<StringRef, StringRef> rsplit(char Separator) const {
402 size_t Idx = rfind(Separator);
404 return std::make_pair(*this, StringRef());
405 return std::make_pair(slice(0, Idx), slice(Idx+1, npos));
411 /// @name StringRef Comparison Operators
414 inline bool operator==(StringRef LHS, StringRef RHS) {
415 return LHS.equals(RHS);
418 inline bool operator!=(StringRef LHS, StringRef RHS) {
419 return !(LHS == RHS);
422 inline bool operator<(StringRef LHS, StringRef RHS) {
423 return LHS.compare(RHS) == -1;
426 inline bool operator<=(StringRef LHS, StringRef RHS) {
427 return LHS.compare(RHS) != 1;
430 inline bool operator>(StringRef LHS, StringRef RHS) {
431 return LHS.compare(RHS) == 1;
434 inline bool operator>=(StringRef LHS, StringRef RHS) {
435 return LHS.compare(RHS) != -1;