1 //===- StringExtrasTest.cpp - Unit tests for String extras ----------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "llvm/ADT/StringExtras.h"
10 #include "llvm/Support/raw_ostream.h"
11 #include "gmock/gmock.h"
12 #include "gtest/gtest.h"
13 
14 using namespace llvm;
15 
16 TEST(StringExtrasTest, isPrint) {
17   EXPECT_FALSE(isPrint('\0'));
18   EXPECT_FALSE(isPrint('\t'));
19   EXPECT_TRUE(isPrint('0'));
20   EXPECT_TRUE(isPrint('a'));
21   EXPECT_TRUE(isPrint('A'));
22   EXPECT_TRUE(isPrint(' '));
23   EXPECT_TRUE(isPrint('~'));
24   EXPECT_TRUE(isPrint('?'));
25 }
26 
27 TEST(StringExtrasTest, isSpace) {
28   EXPECT_TRUE(isSpace(' '));
29   EXPECT_TRUE(isSpace('\t'));
30   EXPECT_TRUE(isSpace('\n'));
31   EXPECT_TRUE(isSpace('\v'));
32   EXPECT_TRUE(isSpace('\f'));
33   EXPECT_TRUE(isSpace('\v'));
34   EXPECT_FALSE(isSpace('\0'));
35   EXPECT_FALSE(isSpace('_'));
36 }
37 
38 TEST(StringExtrasTest, Join) {
39   std::vector<std::string> Items;
40   EXPECT_EQ("", join(Items.begin(), Items.end(), " <sep> "));
41 
42   Items = {"foo"};
43   EXPECT_EQ("foo", join(Items.begin(), Items.end(), " <sep> "));
44 
45   Items = {"foo", "bar"};
46   EXPECT_EQ("foo <sep> bar", join(Items.begin(), Items.end(), " <sep> "));
47 
48   Items = {"foo", "bar", "baz"};
49   EXPECT_EQ("foo <sep> bar <sep> baz",
50             join(Items.begin(), Items.end(), " <sep> "));
51 }
52 
53 TEST(StringExtrasTest, JoinItems) {
54   const char *Foo = "foo";
55   std::string Bar = "bar";
56   llvm::StringRef Baz = "baz";
57   char X = 'x';
58 
59   EXPECT_EQ("", join_items(" <sep> "));
60   EXPECT_EQ("", join_items('/'));
61 
62   EXPECT_EQ("foo", join_items(" <sep> ", Foo));
63   EXPECT_EQ("foo", join_items('/', Foo));
64 
65   EXPECT_EQ("foo <sep> bar", join_items(" <sep> ", Foo, Bar));
66   EXPECT_EQ("foo/bar", join_items('/', Foo, Bar));
67 
68   EXPECT_EQ("foo <sep> bar <sep> baz", join_items(" <sep> ", Foo, Bar, Baz));
69   EXPECT_EQ("foo/bar/baz", join_items('/', Foo, Bar, Baz));
70 
71   EXPECT_EQ("foo <sep> bar <sep> baz <sep> x",
72             join_items(" <sep> ", Foo, Bar, Baz, X));
73 
74   EXPECT_EQ("foo/bar/baz/x", join_items('/', Foo, Bar, Baz, X));
75 }
76 
77 TEST(StringExtrasTest, ToAndFromHex) {
78   std::vector<uint8_t> OddBytes = {0x5, 0xBD, 0x0D, 0x3E, 0xCD};
79   std::string OddStr = "05BD0D3ECD";
80   StringRef OddData(reinterpret_cast<const char *>(OddBytes.data()),
81                     OddBytes.size());
82   EXPECT_EQ(OddStr, toHex(OddData));
83   EXPECT_EQ(OddData, fromHex(StringRef(OddStr).drop_front()));
84   EXPECT_EQ(StringRef(OddStr).lower(), toHex(OddData, true));
85 
86   std::vector<uint8_t> EvenBytes = {0xA5, 0xBD, 0x0D, 0x3E, 0xCD};
87   std::string EvenStr = "A5BD0D3ECD";
88   StringRef EvenData(reinterpret_cast<const char *>(EvenBytes.data()),
89                      EvenBytes.size());
90   EXPECT_EQ(EvenStr, toHex(EvenData));
91   EXPECT_EQ(EvenData, fromHex(EvenStr));
92   EXPECT_EQ(StringRef(EvenStr).lower(), toHex(EvenData, true));
93 
94   std::string InvalidStr = "A50\xFF";
95   std::string IgnoredOutput;
96   EXPECT_FALSE(tryGetFromHex(InvalidStr, IgnoredOutput));
97 }
98 
99 TEST(StringExtrasTest, to_float) {
100   float F;
101   EXPECT_TRUE(to_float("4.7", F));
102   EXPECT_FLOAT_EQ(4.7f, F);
103 
104   double D;
105   EXPECT_TRUE(to_float("4.7", D));
106   EXPECT_DOUBLE_EQ(4.7, D);
107 
108   long double LD;
109   EXPECT_TRUE(to_float("4.7", LD));
110   EXPECT_DOUBLE_EQ(4.7, LD);
111 
112   EXPECT_FALSE(to_float("foo", F));
113   EXPECT_FALSE(to_float("7.4 foo", F));
114   EXPECT_FLOAT_EQ(4.7f, F); // F should be unchanged
115 }
116 
117 TEST(StringExtrasTest, printLowerCase) {
118   std::string str;
119   raw_string_ostream OS(str);
120   printLowerCase("ABCdefg01234.,&!~`'}\"", OS);
121   EXPECT_EQ("abcdefg01234.,&!~`'}\"", OS.str());
122 }
123 
124 TEST(StringExtrasTest, printEscapedString) {
125   std::string str;
126   raw_string_ostream OS(str);
127   printEscapedString("ABCdef123&<>\\\"'\t", OS);
128   EXPECT_EQ("ABCdef123&<>\\\\\\22'\\09", OS.str());
129 }
130 
131 TEST(StringExtrasTest, printHTMLEscaped) {
132   std::string str;
133   raw_string_ostream OS(str);
134   printHTMLEscaped("ABCdef123&<>\"'", OS);
135   EXPECT_EQ("ABCdef123&amp;&lt;&gt;&quot;&apos;", OS.str());
136 }
137 
138 TEST(StringExtrasTest, ConvertToSnakeFromCamelCase) {
139   auto testConvertToSnakeCase = [](llvm::StringRef input,
140                                    llvm::StringRef expected) {
141     EXPECT_EQ(convertToSnakeFromCamelCase(input), expected.str());
142   };
143 
144   testConvertToSnakeCase("OpName", "op_name");
145   testConvertToSnakeCase("opName", "op_name");
146   testConvertToSnakeCase("_OpName", "_op_name");
147   testConvertToSnakeCase("Op_Name", "op_name");
148   testConvertToSnakeCase("", "");
149   testConvertToSnakeCase("A", "a");
150   testConvertToSnakeCase("_", "_");
151   testConvertToSnakeCase("a", "a");
152   testConvertToSnakeCase("op_name", "op_name");
153   testConvertToSnakeCase("_op_name", "_op_name");
154   testConvertToSnakeCase("__op_name", "__op_name");
155   testConvertToSnakeCase("op__name", "op__name");
156 }
157 
158 TEST(StringExtrasTest, ConvertToCamelFromSnakeCase) {
159   auto testConvertToCamelCase = [](bool capitalizeFirst, llvm::StringRef input,
160                                    llvm::StringRef expected) {
161     EXPECT_EQ(convertToCamelFromSnakeCase(input, capitalizeFirst),
162               expected.str());
163   };
164 
165   testConvertToCamelCase(false, "op_name", "opName");
166   testConvertToCamelCase(false, "_op_name", "_opName");
167   testConvertToCamelCase(false, "__op_name", "_OpName");
168   testConvertToCamelCase(false, "op__name", "op_Name");
169   testConvertToCamelCase(false, "", "");
170   testConvertToCamelCase(false, "A", "A");
171   testConvertToCamelCase(false, "_", "_");
172   testConvertToCamelCase(false, "a", "a");
173   testConvertToCamelCase(false, "OpName", "OpName");
174   testConvertToCamelCase(false, "opName", "opName");
175   testConvertToCamelCase(false, "_OpName", "_OpName");
176   testConvertToCamelCase(false, "Op_Name", "Op_Name");
177   testConvertToCamelCase(true, "op_name", "OpName");
178   testConvertToCamelCase(true, "_op_name", "_opName");
179   testConvertToCamelCase(true, "__op_name", "_OpName");
180   testConvertToCamelCase(true, "op__name", "Op_Name");
181   testConvertToCamelCase(true, "", "");
182   testConvertToCamelCase(true, "A", "A");
183   testConvertToCamelCase(true, "_", "_");
184   testConvertToCamelCase(true, "a", "A");
185   testConvertToCamelCase(true, "OpName", "OpName");
186   testConvertToCamelCase(true, "_OpName", "_OpName");
187   testConvertToCamelCase(true, "Op_Name", "Op_Name");
188   testConvertToCamelCase(true, "opName", "OpName");
189 }
190 
191 constexpr uint64_t MaxUint64 = std::numeric_limits<uint64_t>::max();
192 constexpr int64_t MaxInt64 = std::numeric_limits<int64_t>::max();
193 constexpr int64_t MinInt64 = std::numeric_limits<int64_t>::min();
194 
195 TEST(StringExtrasTest, UToStr) {
196   EXPECT_EQ("0", utostr(0));
197   EXPECT_EQ("0", utostr(0, /*isNeg=*/false));
198   EXPECT_EQ("1", utostr(1));
199   EXPECT_EQ("1", utostr(1, /*isNeg=*/false));
200   EXPECT_EQ(std::to_string(MaxUint64), utostr(MaxUint64));
201   EXPECT_EQ(std::to_string(MaxUint64), utostr(MaxUint64, /*isNeg=*/false));
202 
203   EXPECT_EQ("-0", utostr(0, /*isNeg=*/true));
204   EXPECT_EQ("-1", utostr(1, /*isNeg=*/true));
205   EXPECT_EQ("-" + std::to_string(MaxInt64), utostr(MaxInt64, /*isNeg=*/true));
206   constexpr uint64_t MinusMinInt64 = -static_cast<uint64_t>(MinInt64);
207   EXPECT_EQ("-" + std::to_string(MinusMinInt64),
208             utostr(MinusMinInt64, /*isNeg=*/true));
209   EXPECT_EQ("-" + std::to_string(MaxUint64), utostr(MaxUint64, /*isNeg=*/true));
210 }
211 
212 TEST(StringExtrasTest, IToStr) {
213   EXPECT_EQ("0", itostr(0));
214   EXPECT_EQ("1", itostr(1));
215   EXPECT_EQ("-1", itostr(-1));
216   EXPECT_EQ(std::to_string(MinInt64), itostr(MinInt64));
217   EXPECT_EQ(std::to_string(MaxInt64), itostr(MaxInt64));
218 }
219 
220 TEST(StringExtrasTest, ListSeparator) {
221   ListSeparator LS;
222   StringRef S = LS;
223   EXPECT_EQ(S, "");
224   S = LS;
225   EXPECT_EQ(S, ", ");
226 
227   ListSeparator LS2(" ");
228   S = LS2;
229   EXPECT_EQ(S, "");
230   S = LS2;
231   EXPECT_EQ(S, " ");
232 }
233 
234 TEST(StringExtrasTest, toStringAPInt) {
235   bool isSigned;
236 
237   EXPECT_EQ(toString(APInt(8, 0), 2, true, true), "0b0");
238   EXPECT_EQ(toString(APInt(8, 0), 8, true, true), "00");
239   EXPECT_EQ(toString(APInt(8, 0), 10, true, true), "0");
240   EXPECT_EQ(toString(APInt(8, 0), 16, true, true), "0x0");
241   EXPECT_EQ(toString(APInt(8, 0), 36, true, false), "0");
242 
243   isSigned = false;
244   EXPECT_EQ(toString(APInt(8, 255, isSigned), 2, isSigned, true), "0b11111111");
245   EXPECT_EQ(toString(APInt(8, 255, isSigned), 8, isSigned, true), "0377");
246   EXPECT_EQ(toString(APInt(8, 255, isSigned), 10, isSigned, true), "255");
247   EXPECT_EQ(toString(APInt(8, 255, isSigned), 16, isSigned, true), "0xFF");
248   EXPECT_EQ(toString(APInt(8, 255, isSigned), 36, isSigned, false), "73");
249 
250   isSigned = true;
251   EXPECT_EQ(toString(APInt(8, 255, isSigned), 2, isSigned, true), "-0b1");
252   EXPECT_EQ(toString(APInt(8, 255, isSigned), 8, isSigned, true), "-01");
253   EXPECT_EQ(toString(APInt(8, 255, isSigned), 10, isSigned, true), "-1");
254   EXPECT_EQ(toString(APInt(8, 255, isSigned), 16, isSigned, true), "-0x1");
255   EXPECT_EQ(toString(APInt(8, 255, isSigned), 36, isSigned, false), "-1");
256 }
257 
258 TEST(StringExtrasTest, toStringAPSInt) {
259   bool isUnsigned;
260 
261   EXPECT_EQ(toString(APSInt(APInt(8, 0), false), 2), "0");
262   EXPECT_EQ(toString(APSInt(APInt(8, 0), false), 8), "0");
263   EXPECT_EQ(toString(APSInt(APInt(8, 0), false), 10), "0");
264   EXPECT_EQ(toString(APSInt(APInt(8, 0), false), 16), "0");
265 
266   isUnsigned = true;
267   EXPECT_EQ(toString(APSInt(APInt(8, 255), isUnsigned), 2), "11111111");
268   EXPECT_EQ(toString(APSInt(APInt(8, 255), isUnsigned), 8), "377");
269   EXPECT_EQ(toString(APSInt(APInt(8, 255), isUnsigned), 10), "255");
270   EXPECT_EQ(toString(APSInt(APInt(8, 255), isUnsigned), 16), "FF");
271 
272   isUnsigned = false;
273   EXPECT_EQ(toString(APSInt(APInt(8, 255), isUnsigned), 2), "-1");
274   EXPECT_EQ(toString(APSInt(APInt(8, 255), isUnsigned), 8), "-1");
275   EXPECT_EQ(toString(APSInt(APInt(8, 255), isUnsigned), 10), "-1");
276   EXPECT_EQ(toString(APSInt(APInt(8, 255), isUnsigned), 16), "-1");
277 }
278 
279 TEST(StringExtrasTest, splitStringRef) {
280   auto Spl = split("foo<=>bar<=><=>baz", "<=>");
281   auto It = Spl.begin();
282   auto End = Spl.end();
283 
284   ASSERT_NE(It, End);
285   EXPECT_EQ(*It, StringRef("foo"));
286   ASSERT_NE(++It, End);
287   EXPECT_EQ(*It, StringRef("bar"));
288   ASSERT_NE(++It, End);
289   EXPECT_EQ(*It, StringRef(""));
290   ASSERT_NE(++It, End);
291   EXPECT_EQ(*It, StringRef("baz"));
292   ASSERT_EQ(++It, End);
293 }
294 
295 TEST(StringExtrasTest, splitStringRefForLoop) {
296   llvm::SmallVector<StringRef, 4> Result;
297   for (StringRef x : split("foo<=>bar<=><=>baz", "<=>"))
298     Result.push_back(x);
299   EXPECT_THAT(Result, testing::ElementsAre("foo", "bar", "", "baz"));
300 }
301 
302 TEST(StringExtrasTest, splitChar) {
303   auto Spl = split("foo,bar,,baz", ',');
304   auto It = Spl.begin();
305   auto End = Spl.end();
306 
307   ASSERT_NE(It, End);
308   EXPECT_EQ(*It, StringRef("foo"));
309   ASSERT_NE(++It, End);
310   EXPECT_EQ(*It, StringRef("bar"));
311   ASSERT_NE(++It, End);
312   EXPECT_EQ(*It, StringRef(""));
313   ASSERT_NE(++It, End);
314   EXPECT_EQ(*It, StringRef("baz"));
315   ASSERT_EQ(++It, End);
316 }
317 
318 TEST(StringExtrasTest, splitCharForLoop) {
319   llvm::SmallVector<StringRef, 4> Result;
320   for (StringRef x : split("foo,bar,,baz", ','))
321     Result.push_back(x);
322   EXPECT_THAT(Result, testing::ElementsAre("foo", "bar", "", "baz"));
323 }
324