summaryrefslogtreecommitdiff
path: root/Tests/AK/TestFormat.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'Tests/AK/TestFormat.cpp')
-rw-r--r--Tests/AK/TestFormat.cpp291
1 files changed, 291 insertions, 0 deletions
diff --git a/Tests/AK/TestFormat.cpp b/Tests/AK/TestFormat.cpp
new file mode 100644
index 0000000000..237d1a4354
--- /dev/null
+++ b/Tests/AK/TestFormat.cpp
@@ -0,0 +1,291 @@
+/*
+ * Copyright (c) 2020, the SerenityOS developers.
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include <LibTest/TestCase.h>
+
+#include <AK/String.h>
+#include <AK/StringBuilder.h>
+
+TEST_CASE(is_integral_works_properly)
+{
+ EXPECT(!IsIntegral<const char*>);
+ EXPECT(IsIntegral<unsigned long>);
+}
+
+TEST_CASE(format_string_literals)
+{
+ EXPECT_EQ(String::formatted("prefix-{}-suffix", "abc"), "prefix-abc-suffix");
+ EXPECT_EQ(String::formatted("{}{}{}", "a", "b", "c"), "abc");
+}
+
+TEST_CASE(format_integers)
+{
+ EXPECT_EQ(String::formatted("{}", 42u), "42");
+ EXPECT_EQ(String::formatted("{:4}", 42u), " 42");
+ EXPECT_EQ(String::formatted("{:08}", 42u), "00000042");
+ EXPECT_EQ(String::formatted("{:7}", -17), " -17");
+ EXPECT_EQ(String::formatted("{}", -17), "-17");
+ EXPECT_EQ(String::formatted("{:04}", 13), "0013");
+ EXPECT_EQ(String::formatted("{:08x}", 4096), "00001000");
+ EXPECT_EQ(String::formatted("{:x}", 0x1111222233334444ull), "1111222233334444");
+ EXPECT_EQ(String::formatted("{:4}", 12345678), "12345678");
+}
+
+TEST_CASE(reorder_format_arguments)
+{
+ EXPECT_EQ(String::formatted("{1}{0}", "a", "b"), "ba");
+ EXPECT_EQ(String::formatted("{0}{1}", "a", "b"), "ab");
+ // Compiletime check bypass: ignoring a passed argument.
+ EXPECT_EQ(String::formatted(StringView { "{0}{0}{0}" }, "a", "b"), "aaa");
+ // Compiletime check bypass: ignoring a passed argument.
+ EXPECT_EQ(String::formatted(StringView { "{1}{}{0}" }, "a", "b", "c"), "baa");
+}
+
+TEST_CASE(escape_braces)
+{
+ EXPECT_EQ(String::formatted("{{{}", "foo"), "{foo");
+ EXPECT_EQ(String::formatted("{}}}", "bar"), "bar}");
+}
+
+TEST_CASE(everything)
+{
+ EXPECT_EQ(String::formatted("{{{:04}/{}/{0:8}/{1}", 42u, "foo"), "{0042/foo/ 42/foo");
+}
+
+TEST_CASE(string_builder)
+{
+ StringBuilder builder;
+ builder.appendff(" {} ", 42);
+ builder.appendff("{1}{0} ", 1, 2);
+
+ EXPECT_EQ(builder.to_string(), " 42 21 ");
+}
+
+TEST_CASE(format_without_arguments)
+{
+ EXPECT_EQ(String::formatted("foo"), "foo");
+}
+
+TEST_CASE(format_upper_case_integer)
+{
+ EXPECT_EQ(String::formatted("{:4X}", 0xff), " FF");
+ EXPECT_EQ(String::formatted("{:#4X}", 0xff), "0XFF");
+
+ EXPECT_EQ(String::formatted("{:b}", 0xff), "11111111");
+ EXPECT_EQ(String::formatted("{:B}", 0xff), "11111111");
+ EXPECT_EQ(String::formatted("{:#b}", 0xff), "0b11111111");
+}
+
+TEST_CASE(format_aligned)
+{
+ EXPECT_EQ(String::formatted("{:*<8}", 13), "13******");
+ EXPECT_EQ(String::formatted("{:*^8}", 13), "***13***");
+ EXPECT_EQ(String::formatted("{:*>8}", 13), "******13");
+ EXPECT_EQ(String::formatted("{:*>+8}", 13), "*****+13");
+ EXPECT_EQ(String::formatted("{:*^ 8}", 13), "** 13***");
+}
+
+TEST_CASE(format_octal)
+{
+ EXPECT_EQ(String::formatted("{:o}", 0744), "744");
+ EXPECT_EQ(String::formatted("{:#o}", 0744), "0744");
+}
+
+TEST_CASE(zero_pad)
+{
+ EXPECT_EQ(String::formatted("{: <010}", 42), "42 ");
+ EXPECT_EQ(String::formatted("{:010}", 42), "0000000042");
+ EXPECT_EQ(String::formatted("{:/^010}", 42), "////42////");
+ EXPECT_EQ(String::formatted("{:04x}", -32), "-0020");
+ EXPECT_EQ(String::formatted("{:#06x}", -64), "-0x000040");
+}
+
+TEST_CASE(replacement_field)
+{
+ // FIXME: Compiletime check bypass: cannot parse '}}' correctly.
+ EXPECT_EQ(String::formatted(StringView { "{:*>{1}}" }, 13, static_cast<size_t>(10)), "********13");
+ EXPECT_EQ(String::formatted(StringView { "{:*<{1}}" }, 7, 4), "7***");
+ EXPECT_EQ(String::formatted(StringView { "{:{2}}" }, -5, 8, 16), " -5");
+ EXPECT_EQ(String::formatted(StringView { "{{{:*^{1}}}}" }, 1, 3), "{*1*}");
+ EXPECT_EQ(String::formatted(StringView { "{:0{}}" }, 1, 3), "001");
+}
+
+TEST_CASE(replacement_field_regression)
+{
+ // FIXME: Compiletime check bypass: cannot parse '}}' correctly.
+ EXPECT_EQ(String::formatted(StringView { "{:{}}" }, "", static_cast<unsigned long>(6)), " ");
+}
+
+TEST_CASE(complex_string_specifiers)
+{
+ EXPECT_EQ(String::formatted("{:.8}", "123456789"), "12345678");
+ EXPECT_EQ(String::formatted("{:9}", "abcd"), "abcd ");
+ EXPECT_EQ(String::formatted("{:>9}", "abcd"), " abcd");
+ EXPECT_EQ(String::formatted("{:^9}", "abcd"), " abcd ");
+}
+
+TEST_CASE(cast_integer_to_character)
+{
+ EXPECT_EQ(String::formatted("{:c}", static_cast<int>('a')), "a");
+ EXPECT_EQ(String::formatted("{:c}", static_cast<unsigned int>('f')), "f");
+}
+
+TEST_CASE(boolean_values)
+{
+ EXPECT_EQ(String::formatted("{}", true), "true");
+ EXPECT_EQ(String::formatted("{}", false), "false");
+ EXPECT_EQ(String::formatted("{:6}", true), "true ");
+ EXPECT_EQ(String::formatted("{:>4}", false), "false");
+ EXPECT_EQ(String::formatted("{:d}", false), "0");
+ EXPECT_EQ(String::formatted("{:d}", true), "1");
+ EXPECT_EQ(String::formatted("{:#08x}", true), "0x00000001");
+}
+
+TEST_CASE(pointers)
+{
+ void* ptr = reinterpret_cast<void*>(0x4000);
+
+ if (sizeof(void*) == 4) {
+ EXPECT_EQ(String::formatted("{:p}", 32), "0x00000020");
+ EXPECT_EQ(String::formatted("{:p}", ptr), "0x00004000");
+ EXPECT_EQ(String::formatted("{}", ptr), "0x00004000");
+ } else if (sizeof(void*) == 8) {
+ EXPECT_EQ(String::formatted("{:p}", 32), "0x0000000000000020");
+ EXPECT_EQ(String::formatted("{:p}", ptr), "0x0000000000004000");
+ EXPECT_EQ(String::formatted("{}", ptr), "0x0000000000004000");
+ } else {
+ VERIFY_NOT_REACHED();
+ }
+}
+
+// If the format implementation did absolutely nothing, all tests would pass. This
+// is because when a test fails we only write "FAIL" to stdout using format.
+//
+// This is a bit scary, thus this test. At least this test should fail in this case.
+TEST_CASE(ensure_that_format_works)
+{
+ if (String::formatted("FAIL") != "FAIL") {
+ fprintf(stderr, "FAIL\n");
+ exit(1);
+ }
+
+ if (String::formatted("{} FAIL {}", 1, 2) != "1 FAIL 2") {
+ fprintf(stderr, "FAIL\n");
+ exit(1);
+ }
+}
+
+TEST_CASE(format_string_literal_as_pointer)
+{
+ const char* literal = "abc";
+ EXPECT_EQ(String::formatted("{:p}", literal), String::formatted("{:p}", reinterpret_cast<FlatPtr>(literal)));
+}
+
+TEST_CASE(format_character)
+{
+ char a = 'a';
+ EXPECT_EQ(String::formatted("{}", true ? a : 'b'), "a");
+}
+
+struct A {
+};
+struct B {
+};
+template<>
+struct AK::Formatter<B> : Formatter<StringView> {
+ void format(FormatBuilder& builder, B)
+ {
+ Formatter<StringView>::format(builder, "B");
+ }
+};
+
+TEST_CASE(format_if_supported)
+{
+ EXPECT_EQ(String::formatted("{}", FormatIfSupported { A {} }), "?");
+ EXPECT_EQ(String::formatted("{}", FormatIfSupported { B {} }), "B");
+}
+
+TEST_CASE(file_descriptor)
+{
+ char filename[] = "/tmp/test-file-descriptor-XXXXXX";
+
+ int fd = mkstemp(filename);
+ FILE* file = fdopen(fd, "w+");
+
+ outln(file, "{}", "Hello, World!");
+ out(file, "foo");
+ outln(file, "bar");
+
+ rewind(file);
+
+ Array<u8, 256> buffer;
+ const auto nread = fread(buffer.data(), 1, buffer.size(), file);
+
+ EXPECT_EQ(StringView { "Hello, World!\nfoobar\n" }, StringView { buffer.span().trim(nread) });
+
+ fclose(file);
+}
+
+TEST_CASE(floating_point_numbers)
+{
+ EXPECT_EQ(String::formatted("{}", 1.12), "1.12");
+ EXPECT_EQ(String::formatted("{}", 1.), "1");
+ EXPECT_EQ(String::formatted("{:.3}", 1.12), "1.12");
+ EXPECT_EQ(String::formatted("{:.1}", 1.12), "1.1");
+ EXPECT_EQ(String::formatted("{}", -1.12), "-1.12");
+
+ // FIXME: There is always the question what we mean with the width field. Do we mean significant digits?
+ // Do we mean the whole width? This is what was the simplest to implement:
+ EXPECT_EQ(String::formatted("{:x>5.1}", 1.12), "xx1.1");
+}
+
+TEST_CASE(no_precision_no_trailing_number)
+{
+ EXPECT_EQ(String::formatted("{:.0}", 0.1), "0");
+}
+
+TEST_CASE(yay_this_implementation_sucks)
+{
+ EXPECT_EQ(String::formatted("{:.0}", .99999999999), "0");
+}
+
+TEST_CASE(magnitude_less_than_zero)
+{
+ EXPECT_EQ(String::formatted("{}", -0.654), "-0.654");
+ EXPECT_EQ(String::formatted("{}", 0.654), "0.654");
+}
+
+TEST_CASE(format_nullptr)
+{
+ EXPECT_EQ(String::formatted("{}", nullptr), String::formatted("{:p}", static_cast<FlatPtr>(0)));
+}
+
+struct C {
+ int i;
+};
+template<>
+struct AK::Formatter<C> : AK::Formatter<FormatString> {
+ void format(FormatBuilder& builder, C c)
+ {
+ return AK::Formatter<FormatString>::format(builder, "C(i={})", c.i);
+ }
+};
+
+TEST_CASE(use_format_string_formatter)
+{
+ EXPECT_EQ(String::formatted("{:*<10}", C { 42 }), "C(i=42)***");
+}
+
+TEST_CASE(long_long_regression)
+{
+ EXPECT_EQ(String::formatted("{}", 0x0123456789abcdefLL), "81985529216486895");
+
+ StringBuilder builder;
+ AK::FormatBuilder fmtbuilder { builder };
+ fmtbuilder.put_i64(0x0123456789abcdefLL);
+
+ EXPECT_EQ(builder.string_view(), "81985529216486895");
+}