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 /// StringRef - Represent a constant reference to a string, i.e. a character
21 /// array and a length, which need not be null terminated.
23 /// This class does not own the string data, it is expected to be used in
24 /// situations where the character data resides in some other buffer, whose
25 /// lifetime extends past that of the StringRef. For this reason, it is not in
26 /// general safe to store a StringRef.
29 typedef const char *iterator;
30 static const size_t npos = ~size_t(0);
31 typedef size_t size_type;
34 /// The start of the string, in an external buffer.
37 /// The length of the string.
41 /// @name Constructors
44 /// Construct an empty string ref.
45 /*implicit*/ StringRef() : Data(0), Length(0) {}
47 /// Construct a string ref from a cstring.
48 /*implicit*/ StringRef(const char *Str)
49 : Data(Str) { if (Str) Length = ::strlen(Str); else Length = 0; }
51 /// Construct a string ref from a pointer and length.
52 /*implicit*/ StringRef(const char *data, size_t length)
53 : Data(data), Length(length) {}
55 /// Construct a string ref from an std::string.
56 /*implicit*/ StringRef(const std::string &Str)
57 : Data(Str.c_str()), Length(Str.length()) {}
63 iterator begin() const { return Data; }
65 iterator end() const { return Data + Length; }
68 /// @name String Operations
71 /// data - Get a pointer to the start of the string (which may not be null
73 const char *data() const { return Data; }
75 /// empty - Check if the string is empty.
76 bool empty() const { return Length == 0; }
78 /// size - Get the string size.
79 size_t size() const { return Length; }
81 /// front - Get the first character in the string.
87 /// back - Get the last character in the string.
90 return Data[Length-1];
93 /// equals - Check for string equality, this is more efficient than
94 /// compare() when the relative ordering of inequal strings isn't needed.
95 bool equals(const StringRef &RHS) const {
96 return (Length == RHS.Length &&
97 memcmp(Data, RHS.Data, RHS.Length) == 0);
100 /// compare - Compare two strings; the result is -1, 0, or 1 if this string
101 /// is lexicographically less than, equal to, or greater than the \arg RHS.
102 int compare(const StringRef &RHS) const {
103 // Check the prefix for a mismatch.
104 if (int Res = memcmp(Data, RHS.Data, std::min(Length, RHS.Length)))
105 return Res < 0 ? -1 : 1;
107 // Otherwise the prefixes match, so we only need to check the lengths.
108 if (Length == RHS.Length)
110 return Length < RHS.Length ? -1 : 1;
113 /// str - Get the contents as an std::string.
114 std::string str() const { return std::string(Data, Length); }
117 /// @name Operator Overloads
120 char operator[](size_t Index) const {
121 assert(Index < Length && "Invalid index!");
126 /// @name Type Conversions
129 operator std::string() const {
134 /// @name String Predicates
137 /// startswith - Check if this string starts with the given \arg Prefix.
138 bool startswith(const StringRef &Prefix) const {
139 return substr(0, Prefix.Length).equals(Prefix);
142 /// endswith - Check if this string ends with the given \arg Suffix.
143 bool endswith(const StringRef &Suffix) const {
144 return slice(size() - Suffix.Length, size()).equals(Suffix);
148 /// @name String Searching
151 /// find - Search for the first character \arg C in the string.
153 /// \return - The index of the first occurence of \arg C, or npos if not
155 size_t find(char C) const {
156 for (size_t i = 0, e = Length; i != e; ++i)
162 /// find - Search for the first string \arg Str in the string.
164 /// \return - The index of the first occurence of \arg Str, or npos if not
166 size_t find(const StringRef &Str) const;
168 /// rfind - Search for the last character \arg C in the string.
170 /// \return - The index of the last occurence of \arg C, or npos if not
172 size_t rfind(char C, size_t From = npos) const {
173 From = std::min(From, Length);
183 /// rfind - Search for the last string \arg Str in the string.
185 /// \return - The index of the last occurence of \arg Str, or npos if not
187 size_t rfind(const StringRef &Str) const;
189 /// find_first_of - Find the first instance of the specified character or
190 /// return npos if not in string. Same as find.
191 size_type find_first_of(char C) const { return find(C); }
193 /// find_first_of - Find the first character from the string 'Chars' in the
194 /// current string or return npos if not in string.
195 size_type find_first_of(StringRef Chars) const;
197 /// find_first_not_of - Find the first character in the string that is not
198 /// in the string 'Chars' or return npos if all are in string. Same as find.
199 size_type find_first_not_of(StringRef Chars) const;
202 /// @name Helpful Algorithms
205 /// count - Return the number of occurrences of \arg C in the string.
206 size_t count(char C) const {
208 for (size_t i = 0, e = Length; i != e; ++i)
214 /// count - Return the number of non-overlapped occurrences of \arg Str in
216 size_t count(const StringRef &Str) const;
218 /// getAsInteger - Parse the current string as an integer of the specified
219 /// radix. If Radix is specified as zero, this does radix autosensing using
220 /// extended C rules: 0 is octal, 0x is hex, 0b is binary.
222 /// If the string is invalid or if only a subset of the string is valid,
223 /// this returns true to signify the error. The string is considered
224 /// erroneous if empty.
226 bool getAsInteger(unsigned Radix, long long &Result) const;
227 bool getAsInteger(unsigned Radix, unsigned long long &Result) const;
228 bool getAsInteger(unsigned Radix, int &Result) const;
229 bool getAsInteger(unsigned Radix, unsigned &Result) const;
231 // TODO: Provide overloads for int/unsigned that check for overflow.
234 /// @name Substring Operations
237 /// substr - Return a reference to the substring from [Start, Start + N).
239 /// \param Start - The index of the starting character in the substring; if
240 /// the index is npos or greater than the length of the string then the
241 /// empty substring will be returned.
243 /// \param N - The number of characters to included in the substring. If N
244 /// exceeds the number of characters remaining in the string, the string
245 /// suffix (starting with \arg Start) will be returned.
246 StringRef substr(size_t Start, size_t N = npos) const {
247 Start = std::min(Start, Length);
248 return StringRef(Data + Start, std::min(N, Length - Start));
251 /// slice - Return a reference to the substring from [Start, End).
253 /// \param Start - The index of the starting character in the substring; if
254 /// the index is npos or greater than the length of the string then the
255 /// empty substring will be returned.
257 /// \param End - The index following the last character to include in the
258 /// substring. If this is npos, or less than \arg Start, or exceeds the
259 /// number of characters remaining in the string, the string suffix
260 /// (starting with \arg Start) will be returned.
261 StringRef slice(size_t Start, size_t End) const {
262 Start = std::min(Start, Length);
263 End = std::min(std::max(Start, End), Length);
264 return StringRef(Data + Start, End - Start);
267 /// split - Split into two substrings around the first occurence of a
268 /// separator character.
270 /// If \arg Separator is in the string, then the result is a pair (LHS, RHS)
271 /// such that (*this == LHS + Separator + RHS) is true and RHS is
272 /// maximal. If \arg Separator is not in the string, then the result is a
273 /// pair (LHS, RHS) where (*this == LHS) and (RHS == "").
275 /// \param Separator - The character to split on.
276 /// \return - The split substrings.
277 std::pair<StringRef, StringRef> split(char Separator) const {
278 size_t Idx = find(Separator);
280 return std::make_pair(*this, StringRef());
281 return std::make_pair(slice(0, Idx), slice(Idx+1, npos));
284 /// rsplit - Split into two substrings around the last occurence of a
285 /// separator character.
287 /// If \arg Separator is in the string, then the result is a pair (LHS, RHS)
288 /// such that (*this == LHS + Separator + RHS) is true and RHS is
289 /// minimal. If \arg Separator is not in the string, then the result is a
290 /// pair (LHS, RHS) where (*this == LHS) and (RHS == "").
292 /// \param Separator - The character to split on.
293 /// \return - The split substrings.
294 std::pair<StringRef, StringRef> rsplit(char Separator) const {
295 size_t Idx = rfind(Separator);
297 return std::make_pair(*this, StringRef());
298 return std::make_pair(slice(0, Idx), slice(Idx+1, npos));
304 /// @name StringRef Comparison Operators
307 inline bool operator==(const StringRef &LHS, const StringRef &RHS) {
308 return LHS.equals(RHS);
311 inline bool operator!=(const StringRef &LHS, const StringRef &RHS) {
312 return !(LHS == RHS);
315 inline bool operator<(const StringRef &LHS, const StringRef &RHS) {
316 return LHS.compare(RHS) == -1;
319 inline bool operator<=(const StringRef &LHS, const StringRef &RHS) {
320 return LHS.compare(RHS) != 1;
323 inline bool operator>(const StringRef &LHS, const StringRef &RHS) {
324 return LHS.compare(RHS) == 1;
327 inline bool operator>=(const StringRef &LHS, const StringRef &RHS) {
328 return LHS.compare(RHS) != -1;