Document the edit-distance algorithm used in StringRef, switch it over
[oota-llvm.git] / lib / Support / StringRef.cpp
1 //===-- StringRef.cpp - Lightweight String References ---------------------===//
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 #include "llvm/ADT/StringRef.h"
11 #include "llvm/ADT/SmallVector.h"
12 using namespace llvm;
13
14 // MSVC emits references to this into the translation units which reference it.
15 #ifndef _MSC_VER
16 const size_t StringRef::npos;
17 #endif
18
19 static char ascii_tolower(char x) {
20   if (x >= 'A' && x <= 'Z')
21     return x - 'A' + 'a';
22   return x;
23 }
24
25 /// compare_lower - Compare strings, ignoring case.
26 int StringRef::compare_lower(StringRef RHS) const {
27   for (size_t I = 0, E = min(Length, RHS.Length); I != E; ++I) {
28     char LHC = ascii_tolower(Data[I]);
29     char RHC = ascii_tolower(RHS.Data[I]);
30     if (LHC != RHC)
31       return LHC < RHC ? -1 : 1;
32   }
33
34   if (Length == RHS.Length)
35         return 0;
36   return Length < RHS.Length ? -1 : 1;
37 }
38
39 // Compute the edit distance between the two given strings.
40 unsigned StringRef::edit_distance(llvm::StringRef Other, 
41                                   bool AllowReplacements) {
42   // The algorithm implemented below is the "classic"
43   // dynamic-programming algorithm for computing the Levenshtein
44   // distance, which is described here:
45   //
46   //   http://en.wikipedia.org/wiki/Levenshtein_distance
47   //
48   // Although the algorithm is typically described using an m x n
49   // array, only two rows are used at a time, so this implemenation
50   // just keeps two separate vectors for those two rows.
51   size_type m = size();
52   size_type n = Other.size();
53
54   SmallVector<unsigned, 32> previous(n+1, 0);
55   for (SmallVector<unsigned, 32>::size_type i = 0; i <= n; ++i) 
56     previous[i] = i;
57
58   SmallVector<unsigned, 32> current(n+1, 0);
59   for (size_type y = 1; y <= m; ++y) {
60     current.assign(n+1, 0);
61     current[0] = y;
62     for (size_type x = 1; x <= n; ++x) {
63       if (AllowReplacements) {
64         current[x] = min(previous[x-1] + ((*this)[y-1] == Other[x-1]? 0u:1u),
65                          min(current[x-1], previous[x])+1);
66       }
67       else {
68         if ((*this)[y-1] == Other[x-1]) current[x] = previous[x-1];
69         else current[x] = min(current[x-1], previous[x]) + 1;
70       }
71     }
72     current.swap(previous);
73   }
74
75   return previous[n];
76 }
77
78 //===----------------------------------------------------------------------===//
79 // String Searching
80 //===----------------------------------------------------------------------===//
81
82
83 /// find - Search for the first string \arg Str in the string.
84 ///
85 /// \return - The index of the first occurence of \arg Str, or npos if not
86 /// found.
87 size_t StringRef::find(StringRef Str, size_t From) const {
88   size_t N = Str.size();
89   if (N > Length)
90     return npos;
91   for (size_t e = Length - N + 1, i = min(From, e); i != e; ++i)
92     if (substr(i, N).equals(Str))
93       return i;
94   return npos;
95 }
96
97 /// rfind - Search for the last string \arg Str in the string.
98 ///
99 /// \return - The index of the last occurence of \arg Str, or npos if not
100 /// found.
101 size_t StringRef::rfind(StringRef Str) const {
102   size_t N = Str.size();
103   if (N > Length)
104     return npos;
105   for (size_t i = Length - N + 1, e = 0; i != e;) {
106     --i;
107     if (substr(i, N).equals(Str))
108       return i;
109   }
110   return npos;
111 }
112
113 /// find_first_of - Find the first character in the string that is in \arg
114 /// Chars, or npos if not found.
115 ///
116 /// Note: O(size() * Chars.size())
117 StringRef::size_type StringRef::find_first_of(StringRef Chars,
118                                               size_t From) const {
119   for (size_type i = min(From, Length), e = Length; i != e; ++i)
120     if (Chars.find(Data[i]) != npos)
121       return i;
122   return npos;
123 }
124
125 /// find_first_not_of - Find the first character in the string that is not
126 /// \arg C or npos if not found.
127 StringRef::size_type StringRef::find_first_not_of(char C, size_t From) const {
128   for (size_type i = min(From, Length), e = Length; i != e; ++i)
129     if (Data[i] != C)
130       return i;
131   return npos;
132 }
133
134 /// find_first_not_of - Find the first character in the string that is not
135 /// in the string \arg Chars, or npos if not found.
136 ///
137 /// Note: O(size() * Chars.size())
138 StringRef::size_type StringRef::find_first_not_of(StringRef Chars,
139                                                   size_t From) const {
140   for (size_type i = min(From, Length), e = Length; i != e; ++i)
141     if (Chars.find(Data[i]) == npos)
142       return i;
143   return npos;
144 }
145
146
147 //===----------------------------------------------------------------------===//
148 // Helpful Algorithms
149 //===----------------------------------------------------------------------===//
150
151 /// count - Return the number of non-overlapped occurrences of \arg Str in
152 /// the string.
153 size_t StringRef::count(StringRef Str) const {
154   size_t Count = 0;
155   size_t N = Str.size();
156   if (N > Length)
157     return 0;
158   for (size_t i = 0, e = Length - N + 1; i != e; ++i)
159     if (substr(i, N).equals(Str))
160       ++Count;
161   return Count;
162 }
163
164 /// GetAsUnsignedInteger - Workhorse method that converts a integer character
165 /// sequence of radix up to 36 to an unsigned long long value.
166 static bool GetAsUnsignedInteger(StringRef Str, unsigned Radix,
167                                  unsigned long long &Result) {
168   // Autosense radix if not specified.
169   if (Radix == 0) {
170     if (Str.startswith("0x")) {
171       Str = Str.substr(2);
172       Radix = 16;
173     } else if (Str.startswith("0b")) {
174       Str = Str.substr(2);
175       Radix = 2;
176     } else if (Str.startswith("0"))
177       Radix = 8;
178     else
179       Radix = 10;
180   }
181   
182   // Empty strings (after the radix autosense) are invalid.
183   if (Str.empty()) return true;
184   
185   // Parse all the bytes of the string given this radix.  Watch for overflow.
186   Result = 0;
187   while (!Str.empty()) {
188     unsigned CharVal;
189     if (Str[0] >= '0' && Str[0] <= '9')
190       CharVal = Str[0]-'0';
191     else if (Str[0] >= 'a' && Str[0] <= 'z')
192       CharVal = Str[0]-'a'+10;
193     else if (Str[0] >= 'A' && Str[0] <= 'Z')
194       CharVal = Str[0]-'A'+10;
195     else
196       return true;
197     
198     // If the parsed value is larger than the integer radix, the string is
199     // invalid.
200     if (CharVal >= Radix)
201       return true;
202     
203     // Add in this character.
204     unsigned long long PrevResult = Result;
205     Result = Result*Radix+CharVal;
206     
207     // Check for overflow.
208     if (Result < PrevResult)
209       return true;
210
211     Str = Str.substr(1);
212   }
213   
214   return false;
215 }
216
217 bool StringRef::getAsInteger(unsigned Radix, unsigned long long &Result) const {
218   return GetAsUnsignedInteger(*this, Radix, Result);
219 }
220
221
222 bool StringRef::getAsInteger(unsigned Radix, long long &Result) const {
223   unsigned long long ULLVal;
224   
225   // Handle positive strings first.
226   if (empty() || front() != '-') {
227     if (GetAsUnsignedInteger(*this, Radix, ULLVal) ||
228         // Check for value so large it overflows a signed value.
229         (long long)ULLVal < 0)
230       return true;
231     Result = ULLVal;
232     return false;
233   }
234   
235   // Get the positive part of the value.
236   if (GetAsUnsignedInteger(substr(1), Radix, ULLVal) ||
237       // Reject values so large they'd overflow as negative signed, but allow
238       // "-0".  This negates the unsigned so that the negative isn't undefined
239       // on signed overflow.
240       (long long)-ULLVal > 0)
241     return true;
242   
243   Result = -ULLVal;
244   return false;
245 }
246
247 bool StringRef::getAsInteger(unsigned Radix, int &Result) const {
248   long long Val;
249   if (getAsInteger(Radix, Val) ||
250       (int)Val != Val)
251     return true;
252   Result = Val;
253   return false;
254 }
255
256 bool StringRef::getAsInteger(unsigned Radix, unsigned &Result) const {
257   unsigned long long Val;
258   if (getAsInteger(Radix, Val) ||
259       (unsigned)Val != Val)
260     return true;
261   Result = Val;
262   return false;
263 }