2 * Copyright 2015 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include <folly/Format.h>
19 #include <gflags/gflags.h>
20 #include <gtest/gtest.h>
24 using namespace folly;
27 void compareOctal(Uint u) {
28 char buf1[detail::kMaxOctalLength + 1];
29 buf1[detail::kMaxOctalLength] = '\0';
30 char* p = buf1 + detail::uintToOctal(buf1, detail::kMaxOctalLength, u);
32 char buf2[detail::kMaxOctalLength + 1];
33 EXPECT_LT(snprintf(buf2, sizeof(buf2), "%jo", static_cast<uintmax_t>(u)),
36 EXPECT_EQ(std::string(buf2), std::string(p));
40 void compareHex(Uint u) {
41 char buf1[detail::kMaxHexLength + 1];
42 buf1[detail::kMaxHexLength] = '\0';
43 char* p = buf1 + detail::uintToHexLower(buf1, detail::kMaxHexLength, u);
45 char buf2[detail::kMaxHexLength + 1];
46 EXPECT_LT(snprintf(buf2, sizeof(buf2), "%jx", static_cast<uintmax_t>(u)),
49 EXPECT_EQ(std::string(buf2), std::string(p));
53 void compareBinary(Uint u) {
54 char buf[detail::kMaxBinaryLength + 1];
55 buf[detail::kMaxBinaryLength] = '\0';
56 char* p = buf + detail::uintToBinary(buf, detail::kMaxBinaryLength, u);
64 tmp.push_back(u & 1 ? '1' : '0');
66 repr.assign(tmp.rbegin(), tmp.rend());
69 EXPECT_EQ(repr, std::string(p));
72 TEST(Format, uintToOctal) {
73 for (unsigned i = 0; i < (1u << 16) + 2; i++) {
78 TEST(Format, uintToHex) {
79 for (unsigned i = 0; i < (1u << 16) + 2; i++) {
84 TEST(Format, uintToBinary) {
85 for (unsigned i = 0; i < (1u << 16) + 2; i++) {
90 TEST(Format, Simple) {
91 EXPECT_EQ("hello", sformat("hello"));
92 EXPECT_EQ("42", sformat("{}", 42));
93 EXPECT_EQ("42 42", sformat("{0} {0}", 42));
94 EXPECT_EQ("00042 23 42", sformat("{0:05} {1:3} {0:4}", 42, 23));
95 EXPECT_EQ("hello world hello 42",
96 sformat("{0} {1} {0} {2}", "hello", "world", 42));
97 EXPECT_EQ("XXhelloXX", sformat("{:X^9}", "hello"));
98 EXPECT_EQ("XXX42XXXX", sformat("{:X^9}", 42));
99 EXPECT_EQ("-0xYYYY2a", sformat("{:Y=#9x}", -42));
100 EXPECT_EQ("*", sformat("{}", '*'));
101 EXPECT_EQ("42", sformat("{}", 42));
102 EXPECT_EQ("0042", sformat("{:04}", 42));
104 EXPECT_EQ("hello ", sformat("{:7}", "hello"));
105 EXPECT_EQ("hello ", sformat("{:<7}", "hello"));
106 EXPECT_EQ(" hello", sformat("{:>7}", "hello"));
108 EXPECT_EQ(" hi", sformat("{:>*}", 4, "hi"));
109 EXPECT_EQ(" hi!", sformat("{:*}{}", 3, "", "hi!"));
110 EXPECT_EQ(" 123", sformat("{:*}", 7, 123));
111 EXPECT_EQ("123 ", sformat("{:<*}", 7, 123));
112 EXPECT_EQ("----<=>----", sformat("{:-^*}", 11, "<=>"));
113 EXPECT_EQ("+++456+++", sformat("{2:+^*0}", 9, "unused", 456));
115 std::vector<int> v1 {10, 20, 30};
116 EXPECT_EQ("0020", sformat("{0[1]:04}", v1));
117 EXPECT_EQ("0020", svformat("{1:04}", v1));
118 EXPECT_EQ("10 20", svformat("{} {}", v1));
120 const std::vector<int> v2 = v1;
121 EXPECT_EQ("0020", sformat("{0[1]:04}", v2));
122 EXPECT_EQ("0020", svformat("{1:04}", v2));
123 EXPECT_THROW(sformat("{0[3]:04}", v2), std::out_of_range);
124 EXPECT_THROW(svformat("{3:04}", v2), std::out_of_range);
125 EXPECT_EQ("0020", sformat("{0[1]:04}", defaulted(v2, 42)));
126 EXPECT_EQ("0020", svformat("{1:04}", defaulted(v2, 42)));
127 EXPECT_EQ("0042", sformat("{0[3]:04}", defaulted(v2, 42)));
128 EXPECT_EQ("0042", svformat("{3:04}", defaulted(v2, 42)));
130 const int p[] = {10, 20, 30};
132 EXPECT_EQ("0020", sformat("{0[1]:04}", p));
133 EXPECT_EQ("0020", svformat("{1:04}", p));
134 EXPECT_EQ("0020", sformat("{0[1]:04}", q));
135 EXPECT_EQ("0020", svformat("{1:04}", q));
136 EXPECT_NE("", sformat("{}", q));
138 EXPECT_EQ("0x", sformat("{}", p).substr(0, 2));
139 EXPECT_EQ("10", svformat("{}", p));
140 EXPECT_EQ("0x", sformat("{}", q).substr(0, 2));
141 EXPECT_EQ("10", svformat("{}", q));
143 EXPECT_EQ("(null)", sformat("{}", q));
145 std::map<int, std::string> m { {10, "hello"}, {20, "world"} };
146 EXPECT_EQ("worldXX", sformat("{[20]:X<7}", m));
147 EXPECT_EQ("worldXX", svformat("{20:X<7}", m));
148 EXPECT_THROW(sformat("{[42]:X<7}", m), std::out_of_range);
149 EXPECT_THROW(svformat("{42:X<7}", m), std::out_of_range);
150 EXPECT_EQ("worldXX", sformat("{[20]:X<7}", defaulted(m, "meow")));
151 EXPECT_EQ("worldXX", svformat("{20:X<7}", defaulted(m, "meow")));
152 EXPECT_EQ("meowXXX", sformat("{[42]:X<7}", defaulted(m, "meow")));
153 EXPECT_EQ("meowXXX", svformat("{42:X<7}", defaulted(m, "meow")));
155 std::map<std::string, std::string> m2 { {"hello", "world"} };
156 EXPECT_EQ("worldXX", sformat("{[hello]:X<7}", m2));
157 EXPECT_EQ("worldXX", svformat("{hello:X<7}", m2));
158 EXPECT_THROW(sformat("{[none]:X<7}", m2), std::out_of_range);
159 EXPECT_THROW(svformat("{none:X<7}", m2), std::out_of_range);
160 EXPECT_EQ("worldXX", sformat("{[hello]:X<7}", defaulted(m2, "meow")));
161 EXPECT_EQ("worldXX", svformat("{hello:X<7}", defaulted(m2, "meow")));
162 EXPECT_EQ("meowXXX", sformat("{[none]:X<7}", defaulted(m2, "meow")));
163 EXPECT_EQ("meowXXX", svformat("{none:X<7}", defaulted(m2, "meow")));
165 // Test indexing in strings
166 EXPECT_EQ("61 62", sformat("{0[0]:x} {0[1]:x}", "abcde"));
167 EXPECT_EQ("61 62", svformat("{0:x} {1:x}", "abcde"));
168 EXPECT_EQ("61 62", sformat("{0[0]:x} {0[1]:x}", std::string("abcde")));
169 EXPECT_EQ("61 62", svformat("{0:x} {1:x}", std::string("abcde")));
172 EXPECT_EQ("true", sformat("{}", true));
173 EXPECT_EQ("1", sformat("{:d}", true));
174 EXPECT_EQ("false", sformat("{}", false));
175 EXPECT_EQ("0", sformat("{:d}", false));
179 std::pair<int, std::string> p {42, "hello"};
180 EXPECT_EQ(" 42 hello ", sformat("{0[0]:6} {0[1]:6}", p));
181 EXPECT_EQ(" 42 hello ", svformat("{:6} {:6}", p));
186 std::tuple<int, std::string, int> t { 42, "hello", 23 };
187 EXPECT_EQ(" 42 hello 23", sformat("{0[0]:6} {0[1]:6} {0[2]:6}", t));
188 EXPECT_EQ(" 42 hello 23", svformat("{:6} {:6} {:6}", t));
191 // Test writing to stream
192 std::ostringstream os;
193 os << format("{} {}", 42, 23);
194 EXPECT_EQ("42 23", os.str());
196 // Test appending to string
198 format(&s, "{} {}", 42, 23);
199 format(&s, " hello {:X<7}", "world");
200 EXPECT_EQ("42 23 hello worldXX", s);
203 TEST(Format, Float) {
205 EXPECT_EQ("1", sformat("{}", 1.0));
206 EXPECT_EQ("0.1", sformat("{}", 0.1));
207 EXPECT_EQ("0.01", sformat("{}", 0.01));
208 EXPECT_EQ("0.001", sformat("{}", 0.001));
209 EXPECT_EQ("0.0001", sformat("{}", 0.0001));
210 EXPECT_EQ("1e-5", sformat("{}", 0.00001));
211 EXPECT_EQ("1e-6", sformat("{}", 0.000001));
213 EXPECT_EQ("10", sformat("{}", 10.0));
214 EXPECT_EQ("100", sformat("{}", 100.0));
215 EXPECT_EQ("1000", sformat("{}", 1000.0));
216 EXPECT_EQ("10000", sformat("{}", 10000.0));
217 EXPECT_EQ("100000", sformat("{}", 100000.0));
218 EXPECT_EQ("1e+6", sformat("{}", 1000000.0));
219 EXPECT_EQ("1e+7", sformat("{}", 10000000.0));
221 EXPECT_EQ("1.00", sformat("{:.2f}", 1.0));
222 EXPECT_EQ("0.10", sformat("{:.2f}", 0.1));
223 EXPECT_EQ("0.01", sformat("{:.2f}", 0.01));
224 EXPECT_EQ("0.00", sformat("{:.2f}", 0.001));
226 EXPECT_EQ("100000. !== 100000", sformat("{:.} !== {:.}", 100000.0, 100000));
227 EXPECT_EQ("100000.", sformat("{:.}", 100000.0));
228 EXPECT_EQ("1e+6", sformat("{:.}", 1000000.0));
229 EXPECT_EQ(" 100000.", sformat("{:8.}", 100000.0));
230 EXPECT_EQ("100000.", sformat("{:4.}", 100000.0));
231 EXPECT_EQ(" 100000", sformat("{:8.8}", 100000.0));
232 EXPECT_EQ(" 100000.", sformat("{:8.8.}", 100000.0));
235 TEST(Format, MultiLevel) {
236 std::vector<std::map<std::string, std::string>> v = {
242 EXPECT_EQ("world", sformat("{[0.hello]}", v));
245 TEST(Format, separatorDecimalInteger) {
246 EXPECT_EQ("0", sformat("{:,d}", 0));
247 EXPECT_EQ("1", sformat("{:d}", 1));
248 EXPECT_EQ("1", sformat("{:,d}", 1));
249 EXPECT_EQ("1", sformat("{:,}", 1));
250 EXPECT_EQ("123", sformat("{:d}", 123));
251 EXPECT_EQ("123", sformat("{:,d}", 123));
252 EXPECT_EQ("123", sformat("{:,}", 123));
253 EXPECT_EQ("1234", sformat("{:d}", 1234));
254 EXPECT_EQ("1,234", sformat("{:,d}", 1234));
255 EXPECT_EQ("1,234", sformat("{:,}", 1234));
256 EXPECT_EQ("12345678", sformat("{:d}", 12345678));
257 EXPECT_EQ("12,345,678", sformat("{:,d}", 12345678));
258 EXPECT_EQ("12,345,678", sformat("{:,}", 12345678));
259 EXPECT_EQ("-1234", sformat("{:d}", -1234));
260 EXPECT_EQ("-1,234", sformat("{:,d}", -1234));
261 EXPECT_EQ("-1,234", sformat("{:,}", -1234));
263 int64_t max_int64_t = std::numeric_limits<int64_t>::max();
264 int64_t min_int64_t = std::numeric_limits<int64_t>::min();
265 uint64_t max_uint64_t = std::numeric_limits<uint64_t>::max();
266 EXPECT_EQ("9223372036854775807", sformat("{:d}", max_int64_t));
267 EXPECT_EQ("9,223,372,036,854,775,807", sformat("{:,d}", max_int64_t));
268 EXPECT_EQ("9,223,372,036,854,775,807", sformat("{:,}", max_int64_t));
269 EXPECT_EQ("-9223372036854775808", sformat("{:d}", min_int64_t));
270 EXPECT_EQ("-9,223,372,036,854,775,808", sformat("{:,d}", min_int64_t));
271 EXPECT_EQ("-9,223,372,036,854,775,808", sformat("{:,}", min_int64_t));
272 EXPECT_EQ("18446744073709551615", sformat("{:d}", max_uint64_t));
273 EXPECT_EQ("18,446,744,073,709,551,615", sformat("{:,d}", max_uint64_t));
274 EXPECT_EQ("18,446,744,073,709,551,615", sformat("{:,}", max_uint64_t));
276 EXPECT_EQ(" -1,234", sformat("{: 8,}", -1234));
277 EXPECT_EQ("-001,234", sformat("{:08,d}", -1234));
278 EXPECT_EQ("-00001,234", sformat("{:010,d}", -1234));
279 EXPECT_EQ(" -1,234 ", sformat("{:^ 8,d}", -1234));
282 // Note that sformat("{:n}", ...) uses the current locale setting to insert the
283 // appropriate number separator characters.
284 TEST(Format, separatorNumber) {
285 EXPECT_EQ("0", sformat("{:n}", 0));
286 EXPECT_EQ("1", sformat("{:n}", 1));
287 EXPECT_EQ("123", sformat("{:n}", 123));
288 EXPECT_EQ("1234", sformat("{:n}", 1234));
289 EXPECT_EQ("12345678", sformat("{:n}", 12345678));
290 EXPECT_EQ("-1234", sformat("{:n}", -1234));
292 int64_t max_int64_t = std::numeric_limits<int64_t>::max();
293 int64_t min_int64_t = std::numeric_limits<int64_t>::min();
294 uint64_t max_uint64_t = std::numeric_limits<uint64_t>::max();
295 EXPECT_EQ("9223372036854775807", sformat("{:n}", max_int64_t));
296 EXPECT_EQ("-9223372036854775808", sformat("{:n}", min_int64_t));
297 EXPECT_EQ("18446744073709551615", sformat("{:n}", max_uint64_t));
299 EXPECT_EQ(" -1234", sformat("{: 8n}", -1234));
300 EXPECT_EQ("-0001234", sformat("{:08n}", -1234));
301 EXPECT_EQ("-000001234", sformat("{:010n}", -1234));
302 EXPECT_EQ(" -1234 ", sformat("{:^ 8n}", -1234));
305 // insertThousandsGroupingUnsafe requires non-const params
306 static void testGrouping(const char* a_str, const char* expected) {
308 char* end_ptr = str + snprintf(str, sizeof(str), "%s", a_str);
309 ASSERT_LT(end_ptr, str + sizeof(str));
310 folly::detail::insertThousandsGroupingUnsafe(str, &end_ptr);
311 ASSERT_STREQ(expected, str);
314 TEST(Format, separatorUnit) {
315 testGrouping("0", "0");
316 testGrouping("1", "1");
317 testGrouping("12", "12");
318 testGrouping("123", "123");
319 testGrouping("1234", "1,234");
320 testGrouping("12345", "12,345");
321 testGrouping("123456", "123,456");
322 testGrouping("1234567", "1,234,567");
323 testGrouping("1234567890", "1,234,567,890");
324 testGrouping("9223372036854775807", "9,223,372,036,854,775,807");
325 testGrouping("18446744073709551615", "18,446,744,073,709,551,615");
340 template <> class FormatValue<KeyValue> {
342 explicit FormatValue(const KeyValue& kv) : kv_(kv) { }
344 template <class FormatCallback>
345 void format(FormatArg& arg, FormatCallback& cb) const {
346 format_value::formatFormatter(
347 folly::format("<key={}, value={}>", kv_.key, kv_.value),
357 TEST(Format, Custom) {
358 KeyValue kv { "hello", 42 };
360 EXPECT_EQ("<key=hello, value=42>", sformat("{}", kv));
361 EXPECT_EQ("<key=hello, value=42>", sformat("{:10}", kv));
362 EXPECT_EQ("<key=hello", sformat("{:.10}", kv));
363 EXPECT_EQ("<key=hello, value=42>XX", sformat("{:X<23}", kv));
364 EXPECT_EQ("XX<key=hello, value=42>", sformat("{:X>23}", kv));
365 EXPECT_EQ("<key=hello, value=42>", sformat("{0[0]}", &kv));
366 EXPECT_NE("", sformat("{}", &kv));
377 #define EXPECT_THROW_STR(code, type, str) \
379 bool caught = false; \
382 } catch (const type& e) { \
384 EXPECT_TRUE(strstr(e.what(), (str)) != nullptr) << \
385 "Expected message [" << (str) << "], actual message [" << \
387 } catch (const std::exception& e) { \
389 ADD_FAILURE() << "Caught different exception type; expected " #type \
390 ", caught " << folly::demangle(typeid(e)); \
393 ADD_FAILURE() << "Caught unknown exception type; expected " #type; \
396 ADD_FAILURE() << "Expected exception " #type ", caught nothing"; \
400 #define EXPECT_FORMAT_ERROR(code, str) \
401 EXPECT_THROW_STR(code, folly::BadFormatArg, (str))
403 TEST(Format, Unformatted) {
405 EXPECT_NE("", sformat("{}", &o));
406 EXPECT_FORMAT_ERROR(sformat("{0[0]}", &o),
407 "No formatter available for this type");
410 TEST(Format, Nested) {
411 EXPECT_EQ("1 2 3 4", sformat("{} {} {}", 1, 2, format("{} {}", 3, 4)));
413 // not copyable, must hold temporary in scope instead.
414 auto&& saved = format("{} {}", 3, 4);
415 EXPECT_EQ("1 2 3 4", sformat("{} {} {}", 1, 2, saved));
418 TEST(Format, OutOfBounds) {
419 std::vector<int> ints{1, 2, 3, 4, 5};
420 EXPECT_EQ("1 3 5", sformat("{0[0]} {0[2]} {0[4]}", ints));
421 EXPECT_THROW(sformat("{[5]}", ints), std::out_of_range);
423 std::map<std::string, int> map{{"hello", 0}, {"world", 1}};
424 EXPECT_EQ("hello = 0", sformat("hello = {[hello]}", map));
425 EXPECT_THROW(sformat("{[nope]}", map), std::out_of_range);
426 EXPECT_THROW(svformat("{nope}", map), std::out_of_range);
429 TEST(Format, BogusFormatString) {
430 EXPECT_FORMAT_ERROR(sformat("}"), "single '}' in format string");
431 EXPECT_FORMAT_ERROR(sformat("foo}bar"), "single '}' in format string");
432 EXPECT_FORMAT_ERROR(sformat("foo{bar"), "missing ending '}'");
433 EXPECT_FORMAT_ERROR(sformat("{[test]"), "missing ending '}'");
434 EXPECT_FORMAT_ERROR(sformat("{-1.3}"), "argument index must be non-negative");
435 EXPECT_FORMAT_ERROR(sformat("{1.3}", 0, 1, 2), "index not allowed");
436 EXPECT_FORMAT_ERROR(sformat("{0} {} {1}", 0, 1, 2),
437 "may not have both default and explicit arg indexes");
438 EXPECT_FORMAT_ERROR(sformat("{:*}", 1.2),
439 "dynamic field width argument must be integral");
440 EXPECT_FORMAT_ERROR(sformat("{} {:*}", "hi"),
441 "argument index out of range, max=1");
443 sformat("{:*0}", 12, "ok"),
444 "cannot provide width arg index without value arg index"
447 sformat("{0:*}", 12, "ok"),
448 "cannot provide value arg index without width arg index"
451 std::vector<int> v{1, 2, 3};
452 EXPECT_FORMAT_ERROR(svformat("{:*}", v),
453 "dynamic field width not supported in vformat()");
455 // This one fails in detail::enforceWhitespace(), which throws
457 EXPECT_THROW_STR(sformat("{0[test}"), std::range_error,
458 "Non-whitespace: [");
461 template <bool containerMode, class... Args>
462 class TestExtendingFormatter;
464 template <bool containerMode, class... Args>
465 class TestExtendingFormatter
466 : public BaseFormatter<TestExtendingFormatter<containerMode, Args...>,
470 explicit TestExtendingFormatter(StringPiece& str, Args&&... args)
471 : BaseFormatter<TestExtendingFormatter<containerMode, Args...>,
473 Args...>(str, std::forward<Args>(args)...) {}
475 template <size_t K, class Callback>
476 void doFormatArg(FormatArg& arg, Callback& cb) const {
478 auto appender = [&result](StringPiece s) {
479 result.append(s.data(), s.size());
481 std::get<K>(this->values_).format(arg, appender);
482 result = sformat("{{{}}}", result);
483 cb(StringPiece(result));
486 friend class BaseFormatter<TestExtendingFormatter<containerMode, Args...>,
490 template <class... A>
491 friend std::string texsformat(StringPiece fmt, A&&... arg);
494 template <class... Args>
495 std::string texsformat(StringPiece fmt, Args&&... args) {
496 return TestExtendingFormatter<false, Args...>(
497 fmt, std::forward<Args>(args)...).str();
500 TEST(Format, Extending) {
501 EXPECT_EQ(texsformat("I {} brackets", "love"), "I {love} brackets");
502 EXPECT_EQ(texsformat("I {} nesting", sformat("really {}", "love")),
503 "I {really love} nesting");
505 sformat("I also {} nesting", texsformat("have an {} for", "affinity")),
506 "I also have an {affinity} for nesting");
507 EXPECT_EQ(texsformat("Extending {} in {}",
508 texsformat("a {}", "formatter"),
509 "another formatter"),
510 "Extending {a {formatter}} in {another formatter}");
513 int main(int argc, char *argv[]) {
514 testing::InitGoogleTest(&argc, argv);
515 gflags::ParseCommandLineFlags(&argc, &argv, true);
516 return RUN_ALL_TESTS();