1 //===- llvm/ADT/SmallString.h - 'Normally small' strings --------*- 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 // This file defines the SmallString class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_ADT_SMALLSTRING_H
15 #define LLVM_ADT_SMALLSTRING_H
17 #include "llvm/ADT/SmallVector.h"
18 #include "llvm/ADT/StringRef.h"
22 /// SmallString - A SmallString is just a SmallVector with methods and accessors
23 /// that make it work better as a string (e.g. operator+ etc).
24 template<unsigned InternalLen>
25 class SmallString : public SmallVector<char, InternalLen> {
27 /// Default ctor - Initialize to empty.
30 /// Initialize from a StringRef.
31 SmallString(StringRef S) : SmallVector<char, InternalLen>(S.begin(), S.end()) {}
33 /// Initialize with a range.
34 template<typename ItTy>
35 SmallString(ItTy S, ItTy E) : SmallVector<char, InternalLen>(S, E) {}
37 // Note that in order to add new overloads for append & assign, we have to
38 // duplicate the inherited versions so as not to inadvertently hide them.
41 /// @name String Assignment
44 /// Assign from a repeated element.
45 void assign(size_t NumElts, char Elt) {
46 this->SmallVectorImpl<char>::assign(NumElts, Elt);
49 /// Assign from an iterator pair.
50 template<typename in_iter>
51 void assign(in_iter S, in_iter E) {
53 SmallVectorImpl<char>::append(S, E);
56 /// Assign from a StringRef.
57 void assign(StringRef RHS) {
59 SmallVectorImpl<char>::append(RHS.begin(), RHS.end());
62 /// Assign from a SmallVector.
63 void assign(const SmallVectorImpl<char> &RHS) {
65 SmallVectorImpl<char>::append(RHS.begin(), RHS.end());
69 /// @name String Concatenation
72 /// Append from an iterator pair.
73 template<typename in_iter>
74 void append(in_iter S, in_iter E) {
75 SmallVectorImpl<char>::append(S, E);
78 void append(size_t NumInputs, char Elt) {
79 SmallVectorImpl<char>::append(NumInputs, Elt);
83 /// Append from a StringRef.
84 void append(StringRef RHS) {
85 SmallVectorImpl<char>::append(RHS.begin(), RHS.end());
88 /// Append from a SmallVector.
89 void append(const SmallVectorImpl<char> &RHS) {
90 SmallVectorImpl<char>::append(RHS.begin(), RHS.end());
94 /// @name String Comparison
97 /// Check for string equality. This is more efficient than compare() when
98 /// the relative ordering of inequal strings isn't needed.
99 bool equals(StringRef RHS) const {
100 return str().equals(RHS);
103 /// Check for string equality, ignoring case.
104 bool equals_lower(StringRef RHS) const {
105 return str().equals_lower(RHS);
108 /// Compare two strings; the result is -1, 0, or 1 if this string is
109 /// lexicographically less than, equal to, or greater than the \p RHS.
110 int compare(StringRef RHS) const {
111 return str().compare(RHS);
114 /// compare_lower - Compare two strings, ignoring case.
115 int compare_lower(StringRef RHS) const {
116 return str().compare_lower(RHS);
119 /// compare_numeric - Compare two strings, treating sequences of digits as
121 int compare_numeric(StringRef RHS) const {
122 return str().compare_numeric(RHS);
126 /// @name String Predicates
129 /// startswith - Check if this string starts with the given \p Prefix.
130 bool startswith(StringRef Prefix) const {
131 return str().startswith(Prefix);
134 /// endswith - Check if this string ends with the given \p Suffix.
135 bool endswith(StringRef Suffix) const {
136 return str().endswith(Suffix);
140 /// @name String Searching
143 /// find - Search for the first character \p C in the string.
145 /// \return - The index of the first occurrence of \p C, or npos if not
147 size_t find(char C, size_t From = 0) const {
148 return str().find(C, From);
151 /// Search for the first string \p Str in the string.
153 /// \returns The index of the first occurrence of \p Str, or npos if not
155 size_t find(StringRef Str, size_t From = 0) const {
156 return str().find(Str, From);
159 /// Search for the last character \p C in the string.
161 /// \returns The index of the last occurrence of \p C, or npos if not
163 size_t rfind(char C, size_t From = StringRef::npos) const {
164 return str().rfind(C, From);
167 /// Search for the last string \p Str in the string.
169 /// \returns The index of the last occurrence of \p Str, or npos if not
171 size_t rfind(StringRef Str) const {
172 return str().rfind(Str);
175 /// Find the first character in the string that is \p C, or npos if not
176 /// found. Same as find.
177 size_t find_first_of(char C, size_t From = 0) const {
178 return str().find_first_of(C, From);
181 /// Find the first character in the string that is in \p Chars, or npos if
184 /// Complexity: O(size() + Chars.size())
185 size_t find_first_of(StringRef Chars, size_t From = 0) const {
186 return str().find_first_of(Chars, From);
189 /// Find the first character in the string that is not \p C or npos if not
191 size_t find_first_not_of(char C, size_t From = 0) const {
192 return str().find_first_not_of(C, From);
195 /// Find the first character in the string that is not in the string
196 /// \p Chars, or npos if not found.
198 /// Complexity: O(size() + Chars.size())
199 size_t find_first_not_of(StringRef Chars, size_t From = 0) const {
200 return str().find_first_not_of(Chars, From);
203 /// Find the last character in the string that is \p C, or npos if not
205 size_t find_last_of(char C, size_t From = StringRef::npos) const {
206 return str().find_last_of(C, From);
209 /// Find the last character in the string that is in \p C, or npos if not
212 /// Complexity: O(size() + Chars.size())
214 StringRef Chars, size_t From = StringRef::npos) const {
215 return str().find_last_of(Chars, From);
219 /// @name Helpful Algorithms
222 /// Return the number of occurrences of \p C in the string.
223 size_t count(char C) const {
224 return str().count(C);
227 /// Return the number of non-overlapped occurrences of \p Str in the
229 size_t count(StringRef Str) const {
230 return str().count(Str);
234 /// @name Substring Operations
237 /// 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 \p N
244 /// exceeds the number of characters remaining in the string, the string
245 /// suffix (starting with \p Start) will be returned.
246 StringRef substr(size_t Start, size_t N = StringRef::npos) const {
247 return str().substr(Start, N);
250 /// Return a reference to the substring from [Start, End).
252 /// \param Start The index of the starting character in the substring; if
253 /// the index is npos or greater than the length of the string then the
254 /// empty substring will be returned.
256 /// \param End The index following the last character to include in the
257 /// substring. If this is npos, or less than \p Start, or exceeds the
258 /// number of characters remaining in the string, the string suffix
259 /// (starting with \p Start) will be returned.
260 StringRef slice(size_t Start, size_t End) const {
261 return str().slice(Start, End);
266 /// Explicit conversion to StringRef.
267 StringRef str() const { return StringRef(this->begin(), this->size()); }
269 // TODO: Make this const, if it's safe...
270 const char* c_str() {
276 /// Implicit conversion to StringRef.
277 operator StringRef() const { return str(); }
280 const SmallString &operator=(StringRef RHS) {
285 SmallString &operator+=(StringRef RHS) {
286 this->append(RHS.begin(), RHS.end());
289 SmallString &operator+=(char C) {