unittests/Support/NativeFormatTests.cpp

   1 //===- llvm/unittest/Support/NativeFormatTests.cpp - formatting tests -----===//
   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/SmallString.h"
  11 #include "llvm/Support/NativeFormatting.h"
  12 #include "llvm/Support/raw_ostream.h"
  13 #include "gtest/gtest.h"
  14
  15 #include <type_traits>
  16
  17 using namespace llvm;
  18
  19 namespace {
  20
  21 template <typename T>
  22 std::string format_number(T N, IntegerStyle Style,
  23                           Optional<size_t> Precision = None,
  24                           Optional<int> Width = None) {
  25   std::string S;
  26   llvm::raw_string_ostream Str(S);
  27   write_integer(Str, N, Style, Precision, Width);
  28   Str.flush();
  29   return S;
  30 }
  31
  32 template <typename T>
  33 typename std::enable_if<std::is_pointer<T>::value, std::string>::type
  34 format_number(T N, HexPrintStyle Style, Optional<size_t> Precision = None,
  35               Optional<int> Width = None) {
  36   IntegerStyle IS = hexStyleToIntHexStyle(Style);
  37   return format_number(reinterpret_cast<uintptr_t>(N), IS, Precision, Width);
  38 }
  39
  40 std::string format_number(uint64_t N, HexPrintStyle Style,
  41                           Optional<size_t> Precision = None,
  42                           Optional<int> Width = None) {
  43   std::string S;
  44   llvm::raw_string_ostream Str(S);
  45   write_hex(Str, N, Style, Precision, Width);
  46   Str.flush();
  47   return S;
  48 }
  49
  50 std::string format_number(double D, FloatStyle Style,
  51                           Optional<size_t> Precision = None,
  52                           Optional<int> Width = None) {
  53   std::string S;
  54   llvm::raw_string_ostream Str(S);
  55   write_double(Str, D, Style, Precision, Width);
  56   Str.flush();
  57   return S;
  58 }
  59
  60 // Test basic number formatting with various styles and default width and
  61 // precision.
  62 TEST(NativeFormatTest, BasicIntegerTests) {
  63   // Simple fixed point integers.  Default precision is 2.
  64   EXPECT_EQ("0.00", format_number(0, IntegerStyle::Fixed));
  65   EXPECT_EQ("2425.00", format_number(2425, IntegerStyle::Fixed));
  66   EXPECT_EQ("-2425.00", format_number(-2425, IntegerStyle::Fixed));
  67
  68   EXPECT_EQ("0.00", format_number(0LL, IntegerStyle::Fixed));
  69   EXPECT_EQ("257257257235709.00",
  70             format_number(257257257235709LL, IntegerStyle::Fixed));
  71   EXPECT_EQ("-257257257235709.00",
  72             format_number(-257257257235709LL, IntegerStyle::Fixed));
  73
  74   // Simple integers with no decimal.  Default precision is 0.
  75   EXPECT_EQ("0", format_number(0, IntegerStyle::Integer));
  76   EXPECT_EQ("2425", format_number(2425, IntegerStyle::Integer));
  77   EXPECT_EQ("-2425", format_number(-2425, IntegerStyle::Integer));
  78
  79   EXPECT_EQ("0", format_number(0LL, IntegerStyle::Integer));
  80   EXPECT_EQ("257257257235709",
  81             format_number(257257257235709LL, IntegerStyle::Integer));
  82   EXPECT_EQ("-257257257235709",
  83             format_number(-257257257235709LL, IntegerStyle::Integer));
  84
  85   // Exponent based integers.  Default precision is 6.
  86   EXPECT_EQ("3.700000e+01", format_number(37, IntegerStyle::Exponent));
  87   EXPECT_EQ("4.238000e+03", format_number(4238, IntegerStyle::Exponent));
  88   EXPECT_EQ("3.700000E+01", format_number(37, IntegerStyle::ExponentUpper));
  89   EXPECT_EQ("4.238000E+03", format_number(4238, IntegerStyle::ExponentUpper));
  90
  91   // Number formatting.  Default precision is 0.
  92   EXPECT_EQ("0", format_number(0, IntegerStyle::Number));
  93   EXPECT_EQ("2,425", format_number(2425, IntegerStyle::Number));
  94   EXPECT_EQ("-2,425", format_number(-2425, IntegerStyle::Number));
  95   EXPECT_EQ("257,257,257,235,709",
  96             format_number(257257257235709LL, IntegerStyle::Number));
  97   EXPECT_EQ("-257,257,257,235,709",
  98             format_number(-257257257235709LL, IntegerStyle::Number));
  99
 100   // Percent formatting.  Default precision is 0.
 101   EXPECT_EQ("0%", format_number(0, IntegerStyle::Percent));
 102   EXPECT_EQ("100%", format_number(1, IntegerStyle::Percent));
 103   EXPECT_EQ("-100%", format_number(-1, IntegerStyle::Percent));
 104
 105   // Hex formatting.  Default precision is 0.
 106   // lower case, prefix.
 107   EXPECT_EQ("0x0", format_number(0, HexPrintStyle::PrefixLower));
 108   EXPECT_EQ("0xbeef", format_number(0xbeefLL, HexPrintStyle::PrefixLower));
 109   EXPECT_EQ("0xdeadbeef",
 110             format_number(0xdeadbeefLL, HexPrintStyle::PrefixLower));
 111
 112   // upper-case, prefix.
 113   EXPECT_EQ("0x0", format_number(0, HexPrintStyle::PrefixUpper));
 114   EXPECT_EQ("0xBEEF", format_number(0xbeefLL, HexPrintStyle::PrefixUpper));
 115   EXPECT_EQ("0xDEADBEEF",
 116             format_number(0xdeadbeefLL, HexPrintStyle::PrefixUpper));
 117
 118   // lower-case, no prefix
 119   EXPECT_EQ("0", format_number(0, HexPrintStyle::Lower));
 120   EXPECT_EQ("beef", format_number(0xbeefLL, HexPrintStyle::Lower));
 121   EXPECT_EQ("deadbeef", format_number(0xdeadbeefLL, HexPrintStyle::Lower));
 122
 123   // upper-case, no prefix.
 124   EXPECT_EQ("0", format_number(0, HexPrintStyle::Upper));
 125   EXPECT_EQ("BEEF", format_number(0xbeef, HexPrintStyle::Upper));
 126   EXPECT_EQ("DEADBEEF", format_number(0xdeadbeef, HexPrintStyle::Upper));
 127
 128   EXPECT_EQ("0xFFFFFFFF", format_number(-1, IntegerStyle::HexUpperPrefix));
 129 }
 130
 131 // Test pointer type formatting with various styles and default width and
 132 // precision.
 133 TEST(NativeFormatTest, BasicPointerTests) {
 134   // lower-case, prefix
 135   EXPECT_EQ("0x0", format_number((void *)nullptr, HexPrintStyle::PrefixLower));
 136   EXPECT_EQ("0xbeef",
 137             format_number((void *)0xbeefLL, HexPrintStyle::PrefixLower));
 138   EXPECT_EQ("0xdeadbeef",
 139             format_number((void *)0xdeadbeefLL, HexPrintStyle::PrefixLower));
 140
 141   // upper-case, prefix.
 142   EXPECT_EQ("0x0", format_number((void *)nullptr, HexPrintStyle::PrefixUpper));
 143   EXPECT_EQ("0xBEEF",
 144             format_number((void *)0xbeefLL, HexPrintStyle::PrefixUpper));
 145   EXPECT_EQ("0xDEADBEEF",
 146             format_number((void *)0xdeadbeefLL, HexPrintStyle::PrefixUpper));
 147
 148   // lower-case, no prefix
 149   EXPECT_EQ("0", format_number((void *)nullptr, HexPrintStyle::Lower));
 150   EXPECT_EQ("beef", format_number((void *)0xbeefLL, HexPrintStyle::Lower));
 151   EXPECT_EQ("deadbeef",
 152             format_number((void *)0xdeadbeefLL, HexPrintStyle::Lower));
 153
 154   // upper-case, no prefix.
 155   EXPECT_EQ("0", format_number((void *)nullptr, HexPrintStyle::Upper));
 156   EXPECT_EQ("BEEF", format_number((void *)0xbeefLL, HexPrintStyle::Upper));
 157   EXPECT_EQ("DEADBEEF",
 158             format_number((void *)0xdeadbeefLL, HexPrintStyle::Upper));
 159 }
 160
 161 // Test basic floating point formatting with various styles and default width
 162 // and precision.
 163 TEST(NativeFormatTest, BasicFloatingPointTests) {
 164   // Double
 165   EXPECT_EQ("0.000000e+00", format_number(0.0, FloatStyle::Exponent));
 166   EXPECT_EQ("-0.000000e+00", format_number(-0.0, FloatStyle::Exponent));
 167   EXPECT_EQ("1.100000e+00", format_number(1.1, FloatStyle::Exponent));
 168   EXPECT_EQ("1.100000E+00", format_number(1.1, FloatStyle::ExponentUpper));
 169
 170   // Default precision is 2 for floating points.
 171   EXPECT_EQ("1.10", format_number(1.1, FloatStyle::Fixed));
 172   EXPECT_EQ("1.34", format_number(1.34, FloatStyle::Fixed));
 173   EXPECT_EQ("1.34", format_number(1.344, FloatStyle::Fixed));
 174   EXPECT_EQ("1.35", format_number(1.346, FloatStyle::Fixed));
 175 }
 176
 177 // Test common boundary cases and min/max conditions.
 178 TEST(NativeFormatTest, BoundaryTests) {
 179   // Min and max.
 180   EXPECT_EQ("18446744073709551615",
 181             format_number(UINT64_MAX, IntegerStyle::Integer));
 182
 183   EXPECT_EQ("9223372036854775807",
 184             format_number(INT64_MAX, IntegerStyle::Integer));
 185   EXPECT_EQ("-9223372036854775808",
 186             format_number(INT64_MIN, IntegerStyle::Integer));
 187
 188   EXPECT_EQ("4294967295", format_number(UINT32_MAX, IntegerStyle::Integer));
 189   EXPECT_EQ("2147483647", format_number(INT32_MAX, IntegerStyle::Integer));
 190   EXPECT_EQ("-2147483648", format_number(INT32_MIN, IntegerStyle::Integer));
 191
 192   EXPECT_EQ("nan", format_number(std::numeric_limits<double>::quiet_NaN(),
 193                                  FloatStyle::Fixed));
 194   EXPECT_EQ("INF", format_number(std::numeric_limits<double>::infinity(),
 195                                  FloatStyle::Fixed));
 196 }
 197
 198 TEST(NativeFormatTest, HexTests) {
 199   // Test hex formatting with different widths and precisions.
 200
 201   // Precision less than the value should print the full value anyway.
 202   EXPECT_EQ("0x0", format_number(0, IntegerStyle::HexLowerPrefix, 0));
 203   EXPECT_EQ("0xabcde", format_number(0xABCDE, IntegerStyle::HexLowerPrefix, 3));
 204
 205   // Precision greater than the value should pad with 0s.
 206   // TODO: The prefix should not be counted in the precision.  But unfortunately
 207   // it is and we have to live with it unless we fix all existing users of
 208   // prefixed hex formatting.
 209   EXPECT_EQ("0x000", format_number(0, IntegerStyle::HexLowerPrefix, 5));
 210   EXPECT_EQ("0x0abcde",
 211             format_number(0xABCDE, IntegerStyle::HexLowerPrefix, 8));
 212
 213   EXPECT_EQ("00000", format_number(0, IntegerStyle::HexLowerNoPrefix, 5));
 214   EXPECT_EQ("000abcde",
 215             format_number(0xABCDE, IntegerStyle::HexLowerNoPrefix, 8));
 216
 217   // Try printing more digits than can fit in a uint64.
 218   EXPECT_EQ("0x00000000000000abcde",
 219             format_number(0xABCDE, IntegerStyle::HexLowerPrefix, 21));
 220
 221   // Width less than the amount to be printed should print the full amount.
 222   EXPECT_EQ("0x0", format_number(0, IntegerStyle::HexLowerPrefix, 0, 0));
 223   EXPECT_EQ("0xabcde",
 224             format_number(0xABCDE, IntegerStyle::HexLowerPrefix, 0, 0));
 225
 226   // Width greater than the value should pad with spaces.
 227   EXPECT_EQ("  0x0", format_number(0, IntegerStyle::HexLowerPrefix, 0, 5));
 228   EXPECT_EQ(" 0xabcde",
 229             format_number(0xABCDE, IntegerStyle::HexLowerPrefix, 0, 8));
 230
 231   // Should also work with no prefix.
 232   EXPECT_EQ("  000", format_number(0, IntegerStyle::HexLowerNoPrefix, 3, 5));
 233   EXPECT_EQ("   0abcde",
 234             format_number(0xABCDE, IntegerStyle::HexLowerNoPrefix, 6, 9));
 235
 236   // And with pointers.
 237   EXPECT_EQ("  0x000",
 238             format_number((void *)nullptr, HexPrintStyle::PrefixLower, 5, 7));
 239
 240   // Try printing more digits than can fit in a uint64.
 241   EXPECT_EQ("     0x000abcde",
 242             format_number(0xABCDE, IntegerStyle::HexLowerPrefix, 10, 15));
 243 }
 244
 245 TEST(NativeFormatTest, IntegerTests) {
 246   // Test plain integer formatting with non-default widths and precisions.
 247
 248   // Too low precision should print the whole number.
 249   EXPECT_EQ("-10", format_number(-10, IntegerStyle::Integer, 1));
 250
 251   // Additional precision should padd with 0s.
 252   EXPECT_EQ("-00010", format_number(-10, IntegerStyle::Integer, 5));
 253   EXPECT_EQ("-00100", format_number(-100, IntegerStyle::Integer, 5));
 254   EXPECT_EQ("-01000", format_number(-1000, IntegerStyle::Integer, 5));
 255   EXPECT_EQ("-001234567890",
 256             format_number(-1234567890, IntegerStyle::Integer, 12));
 257   EXPECT_EQ("00010", format_number(10, IntegerStyle::Integer, 5));
 258   EXPECT_EQ("00100", format_number(100, IntegerStyle::Integer, 5));
 259   EXPECT_EQ("01000", format_number(1000, IntegerStyle::Integer, 5));
 260   EXPECT_EQ("001234567890",
 261             format_number(1234567890, IntegerStyle::Integer, 12));
 262
 263   // Too low width should print the full number.
 264   EXPECT_EQ("-10", format_number(-10, IntegerStyle::Integer, None, 2));
 265
 266   // Additional width should padd with spaces.
 267   EXPECT_EQ("  -00010", format_number(-10, IntegerStyle::Integer, 5, 8));
 268   EXPECT_EQ("  -00100", format_number(-100, IntegerStyle::Integer, 5, 8));
 269   EXPECT_EQ("  -01000", format_number(-1000, IntegerStyle::Integer, 5, 8));
 270   EXPECT_EQ(" -001234567890",
 271             format_number(-1234567890, IntegerStyle::Integer, 12, 14));
 272   EXPECT_EQ("   00010", format_number(10, IntegerStyle::Integer, 5, 8));
 273   EXPECT_EQ("   00100", format_number(100, IntegerStyle::Integer, 5, 8));
 274   EXPECT_EQ("   01000", format_number(1000, IntegerStyle::Integer, 5, 8));
 275   EXPECT_EQ("  001234567890",
 276             format_number(1234567890, IntegerStyle::Integer, 12, 14));
 277 }
 278
 279 TEST(NativeFormatTest, CommaTests) {
 280   // Test comma grouping with default widths and precisions.
 281   EXPECT_EQ("0", format_number(0, IntegerStyle::Number));
 282   EXPECT_EQ("10", format_number(10, IntegerStyle::Number));
 283   EXPECT_EQ("100", format_number(100, IntegerStyle::Number));
 284   EXPECT_EQ("1,000", format_number(1000, IntegerStyle::Number));
 285   EXPECT_EQ("1,234,567,890", format_number(1234567890, IntegerStyle::Number));
 286
 287   // Test comma grouping with non-default widths and precisions.
 288   EXPECT_EQ("-10", format_number(-10, IntegerStyle::Number));
 289   EXPECT_EQ("-100", format_number(-100, IntegerStyle::Number));
 290   EXPECT_EQ("-1,000", format_number(-1000, IntegerStyle::Number));
 291   EXPECT_EQ("-1,234,567,890", format_number(-1234567890, IntegerStyle::Number));
 292
 293   EXPECT_EQ("  1,000", format_number(1000, IntegerStyle::Number, None, 7));
 294   EXPECT_EQ(" -1,000", format_number(-1000, IntegerStyle::Number, None, 7));
 295   EXPECT_EQ(" -0,001,000", format_number(-1000, IntegerStyle::Number, 7, 11));
 296   EXPECT_EQ("  0,001,000", format_number(1000, IntegerStyle::Number, 7, 11));
 297 }
 298
 299 TEST(NativeFormatTest, PercentTests) {
 300   // Integer percents.
 301   EXPECT_EQ("0%", format_number(0, IntegerStyle::Percent));
 302   EXPECT_EQ("0.00%", format_number(0, IntegerStyle::Percent, 2));
 303   EXPECT_EQ("  0.00%", format_number(0, IntegerStyle::Percent, 2, 7));
 304
 305   EXPECT_EQ(" 100.00%", format_number(1, IntegerStyle::Percent, 2, 8));
 306
 307   EXPECT_EQ("    100%", format_number(1, IntegerStyle::Percent, None, 8));
 308   EXPECT_EQ(" 100.000%", format_number(1, IntegerStyle::Percent, 3, 9));
 309
 310   // Floating point percents.  Default precision is 2 for floating point types,
 311   // even for 0.
 312   EXPECT_EQ("0.00%", format_number(0.0, FloatStyle::Percent));
 313   EXPECT_EQ("0%", format_number(0.0, FloatStyle::Percent, 0));
 314   EXPECT_EQ(" 0.00%", format_number(0.0, FloatStyle::Percent, 2, 6));
 315   EXPECT_EQ(" 4.2%", format_number(.042379, FloatStyle::Percent, 1, 5));
 316   EXPECT_EQ("4.24%", format_number(.042379, FloatStyle::Percent, 2, 5));
 317   EXPECT_EQ("4.238%", format_number(.042379, FloatStyle::Percent, 3, 5));
 318   EXPECT_EQ("  0.424%", format_number(.0042379, FloatStyle::Percent, 3, 8));
 319   EXPECT_EQ(" -0.424%", format_number(-.0042379, FloatStyle::Percent, 3, 8));
 320 }
 321
 322 TEST(NativeFormatTest, FixedTests) {
 323   // Integer fixed numbers.  Default precision is 2.  Make sure no decimal
 324   // is printed with 0 precision.
 325   EXPECT_EQ("1.00", format_number(1, IntegerStyle::Fixed));
 326   EXPECT_EQ("1", format_number(1, IntegerStyle::Fixed, 0));
 327   EXPECT_EQ("  1.00", format_number(1, IntegerStyle::Fixed, 2, 6));
 328   EXPECT_EQ("-1.00", format_number(-1, IntegerStyle::Fixed));
 329   EXPECT_EQ("-1.00", format_number(-1, IntegerStyle::Fixed, 2));
 330   EXPECT_EQ(" -1.00", format_number(-1, IntegerStyle::Fixed, 2, 6));
 331
 332   // Float fixed numbers.  Default precision is 2.
 333   EXPECT_EQ("0.00", format_number(0.0, FloatStyle::Fixed));
 334   EXPECT_EQ("1.00", format_number(1.0, FloatStyle::Fixed));
 335
 336   // But can be forced to 0
 337   EXPECT_EQ("0", format_number(0.0, FloatStyle::Fixed, 0));
 338
 339   // It should round up when appropriate.
 340   EXPECT_EQ("3.14", format_number(3.1415, FloatStyle::Fixed, 2));
 341   EXPECT_EQ("3.142", format_number(3.1415, FloatStyle::Fixed, 3));
 342
 343   // Padding should work properly with both positive and negative numbers.
 344   EXPECT_EQ("   3.14", format_number(3.1415, FloatStyle::Fixed, 2, 7));
 345   EXPECT_EQ("  3.142", format_number(3.1415, FloatStyle::Fixed, 3, 7));
 346   EXPECT_EQ("  -3.14", format_number(-3.1415, FloatStyle::Fixed, 2, 7));
 347   EXPECT_EQ(" -3.142", format_number(-3.1415, FloatStyle::Fixed, 3, 7));
 348 }
 349 }