1 //===- llvm/unittest/Support/NativeFormatTests.cpp - formatting tests -----===// 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/Support/NativeFormatting.h" 10 #include "llvm/Support/raw_ostream.h" 11 #include "gtest/gtest.h" 12 13 #include <type_traits> 14 15 using namespace llvm; 16 17 namespace { 18 19 template <typename T> std::string format_number(T N, IntegerStyle Style) { 20 std::string S; 21 llvm::raw_string_ostream Str(S); 22 write_integer(Str, N, 0, Style); 23 return S; 24 } 25 26 std::string format_number(uint64_t N, HexPrintStyle Style, 27 std::optional<size_t> Width = std::nullopt) { 28 std::string S; 29 llvm::raw_string_ostream Str(S); 30 write_hex(Str, N, Style, Width); 31 return S; 32 } 33 34 std::string format_number(double D, FloatStyle Style, 35 std::optional<size_t> Precision = std::nullopt) { 36 std::string S; 37 llvm::raw_string_ostream Str(S); 38 write_double(Str, D, Style, Precision); 39 return S; 40 } 41 42 // Test basic number formatting with various styles and default width and 43 // precision. 44 TEST(NativeFormatTest, BasicIntegerTests) { 45 // Simple integers with no decimal. 46 EXPECT_EQ("0", format_number(0, IntegerStyle::Integer)); 47 EXPECT_EQ("1", format_number(1, IntegerStyle::Integer)); 48 EXPECT_EQ("-1", format_number(-1, IntegerStyle::Integer)); 49 EXPECT_EQ("2425", format_number(2425, IntegerStyle::Integer)); 50 EXPECT_EQ("-2425", format_number(-2425, IntegerStyle::Integer)); 51 52 EXPECT_EQ("0", format_number(0LL, IntegerStyle::Integer)); 53 EXPECT_EQ("257257257235709", 54 format_number(257257257235709LL, IntegerStyle::Integer)); 55 EXPECT_EQ("-257257257235709", 56 format_number(-257257257235709LL, IntegerStyle::Integer)); 57 58 // Number formatting. 59 EXPECT_EQ("0", format_number(0, IntegerStyle::Number)); 60 EXPECT_EQ("2,425", format_number(2425, IntegerStyle::Number)); 61 EXPECT_EQ("-2,425", format_number(-2425, IntegerStyle::Number)); 62 EXPECT_EQ("257,257,257,235,709", 63 format_number(257257257235709LL, IntegerStyle::Number)); 64 EXPECT_EQ("-257,257,257,235,709", 65 format_number(-257257257235709LL, IntegerStyle::Number)); 66 67 // Hex formatting. 68 // lower case, prefix. 69 EXPECT_EQ("0x0", format_number(0, HexPrintStyle::PrefixLower)); 70 EXPECT_EQ("0xbeef", format_number(0xbeefLL, HexPrintStyle::PrefixLower)); 71 EXPECT_EQ("0xdeadbeef", 72 format_number(0xdeadbeefLL, HexPrintStyle::PrefixLower)); 73 74 // upper-case, prefix. 75 EXPECT_EQ("0x0", format_number(0, HexPrintStyle::PrefixUpper)); 76 EXPECT_EQ("0xBEEF", format_number(0xbeefLL, HexPrintStyle::PrefixUpper)); 77 EXPECT_EQ("0xDEADBEEF", 78 format_number(0xdeadbeefLL, HexPrintStyle::PrefixUpper)); 79 80 // lower-case, no prefix 81 EXPECT_EQ("0", format_number(0, HexPrintStyle::Lower)); 82 EXPECT_EQ("beef", format_number(0xbeefLL, HexPrintStyle::Lower)); 83 EXPECT_EQ("deadbeef", format_number(0xdeadbeefLL, HexPrintStyle::Lower)); 84 85 // upper-case, no prefix. 86 EXPECT_EQ("0", format_number(0, HexPrintStyle::Upper)); 87 EXPECT_EQ("BEEF", format_number(0xbeef, HexPrintStyle::Upper)); 88 EXPECT_EQ("DEADBEEF", format_number(0xdeadbeef, HexPrintStyle::Upper)); 89 } 90 91 // Test basic floating point formatting with various styles and default width 92 // and precision. 93 TEST(NativeFormatTest, BasicFloatingPointTests) { 94 // Double 95 EXPECT_EQ("0.000000e+00", format_number(0.0, FloatStyle::Exponent)); 96 EXPECT_EQ("-0.000000e+00", format_number(-0.0, FloatStyle::Exponent)); 97 EXPECT_EQ("1.100000e+00", format_number(1.1, FloatStyle::Exponent)); 98 EXPECT_EQ("1.100000E+00", format_number(1.1, FloatStyle::ExponentUpper)); 99 100 // Default precision is 2 for floating points. 101 EXPECT_EQ("1.10", format_number(1.1, FloatStyle::Fixed)); 102 EXPECT_EQ("1.34", format_number(1.34, FloatStyle::Fixed)); 103 EXPECT_EQ("1.34", format_number(1.344, FloatStyle::Fixed)); 104 EXPECT_EQ("1.35", format_number(1.346, FloatStyle::Fixed)); 105 } 106 107 // Test common boundary cases and min/max conditions. 108 TEST(NativeFormatTest, BoundaryTests) { 109 // Min and max. 110 EXPECT_EQ("18446744073709551615", 111 format_number(UINT64_MAX, IntegerStyle::Integer)); 112 113 EXPECT_EQ("9223372036854775807", 114 format_number(INT64_MAX, IntegerStyle::Integer)); 115 EXPECT_EQ("-9223372036854775808", 116 format_number(INT64_MIN, IntegerStyle::Integer)); 117 118 EXPECT_EQ("4294967295", format_number(UINT32_MAX, IntegerStyle::Integer)); 119 EXPECT_EQ("2147483647", format_number(INT32_MAX, IntegerStyle::Integer)); 120 EXPECT_EQ("-2147483648", format_number(INT32_MIN, IntegerStyle::Integer)); 121 122 EXPECT_EQ("nan", format_number(std::numeric_limits<double>::quiet_NaN(), 123 FloatStyle::Fixed)); 124 EXPECT_EQ("INF", format_number(std::numeric_limits<double>::infinity(), 125 FloatStyle::Fixed)); 126 EXPECT_EQ("-INF", format_number(-std::numeric_limits<double>::infinity(), 127 FloatStyle::Fixed)); 128 } 129 130 TEST(NativeFormatTest, HexTests) { 131 // Test hex formatting with different widths and precisions. 132 133 // Width less than the value should print the full value anyway. 134 EXPECT_EQ("0x0", format_number(0, HexPrintStyle::PrefixLower, 0)); 135 EXPECT_EQ("0xabcde", format_number(0xABCDE, HexPrintStyle::PrefixLower, 3)); 136 137 // Precision greater than the value should pad with 0s. 138 // TODO: The prefix should not be counted in the precision. But unfortunately 139 // it is and we have to live with it unless we fix all existing users of 140 // prefixed hex formatting. 141 EXPECT_EQ("0x000", format_number(0, HexPrintStyle::PrefixLower, 5)); 142 EXPECT_EQ("0x0abcde", format_number(0xABCDE, HexPrintStyle::PrefixLower, 8)); 143 144 EXPECT_EQ("00000", format_number(0, HexPrintStyle::Lower, 5)); 145 EXPECT_EQ("000abcde", format_number(0xABCDE, HexPrintStyle::Lower, 8)); 146 147 // Try printing more digits than can fit in a uint64. 148 EXPECT_EQ("0x00000000000000abcde", 149 format_number(0xABCDE, HexPrintStyle::PrefixLower, 21)); 150 } 151 152 TEST(NativeFormatTest, IntegerTests) { 153 EXPECT_EQ("-10", format_number(-10, IntegerStyle::Integer)); 154 EXPECT_EQ("-100", format_number(-100, IntegerStyle::Integer)); 155 EXPECT_EQ("-1000", format_number(-1000, IntegerStyle::Integer)); 156 EXPECT_EQ("-1234567890", format_number(-1234567890, IntegerStyle::Integer)); 157 EXPECT_EQ("10", format_number(10, IntegerStyle::Integer)); 158 EXPECT_EQ("100", format_number(100, IntegerStyle::Integer)); 159 EXPECT_EQ("1000", format_number(1000, IntegerStyle::Integer)); 160 EXPECT_EQ("1234567890", format_number(1234567890, IntegerStyle::Integer)); 161 } 162 163 TEST(NativeFormatTest, CommaTests) { 164 EXPECT_EQ("0", format_number(0, IntegerStyle::Number)); 165 EXPECT_EQ("10", format_number(10, IntegerStyle::Number)); 166 EXPECT_EQ("100", format_number(100, IntegerStyle::Number)); 167 EXPECT_EQ("1,000", format_number(1000, IntegerStyle::Number)); 168 EXPECT_EQ("1,234,567,890", format_number(1234567890, IntegerStyle::Number)); 169 170 EXPECT_EQ("-10", format_number(-10, IntegerStyle::Number)); 171 EXPECT_EQ("-100", format_number(-100, IntegerStyle::Number)); 172 EXPECT_EQ("-1,000", format_number(-1000, IntegerStyle::Number)); 173 EXPECT_EQ("-1,234,567,890", format_number(-1234567890, IntegerStyle::Number)); 174 } 175 } 176