unittests/Support/raw_ostream_test.cpp

   1 //===- llvm/unittest/Support/raw_ostream_test.cpp - raw_ostream 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/ADT/SmallString.h"
  10 #include "llvm/Support/FileSystem.h"
  11 #include "llvm/Support/Format.h"
  12 #include "llvm/Support/raw_ostream.h"
  13 #include "gtest/gtest.h"
  14
  15 using namespace llvm;
  16
  17 namespace {
  18
  19 template<typename T> std::string printToString(const T &Value) {
  20   std::string res;
  21   llvm::raw_string_ostream(res) << Value;
  22   return res;
  23 }
  24
  25 /// printToString - Print the given value to a stream which only has \arg
  26 /// BytesLeftInBuffer bytes left in the buffer. This is useful for testing edge
  27 /// cases in the buffer handling logic.
  28 template<typename T> std::string printToString(const T &Value,
  29                                                unsigned BytesLeftInBuffer) {
  30   // FIXME: This is relying on internal knowledge of how raw_ostream works to
  31   // get the buffer position right.
  32   SmallString<256> SVec;
  33   assert(BytesLeftInBuffer < 256 && "Invalid buffer count!");
  34   llvm::raw_svector_ostream OS(SVec);
  35   unsigned StartIndex = 256 - BytesLeftInBuffer;
  36   for (unsigned i = 0; i != StartIndex; ++i)
  37     OS << '?';
  38   OS << Value;
  39   return OS.str().substr(StartIndex);
  40 }
  41
  42 template<typename T> std::string printToStringUnbuffered(const T &Value) {
  43   std::string res;
  44   llvm::raw_string_ostream OS(res);
  45   OS.SetUnbuffered();
  46   OS << Value;
  47   return res;
  48 }
  49
  50 TEST(raw_ostreamTest, Types_Buffered) {
  51   // Char
  52   EXPECT_EQ("c", printToString('c'));
  53
  54   // String
  55   EXPECT_EQ("hello", printToString("hello"));
  56   EXPECT_EQ("hello", printToString(std::string("hello")));
  57
  58   // Int
  59   EXPECT_EQ("0", printToString(0));
  60   EXPECT_EQ("2425", printToString(2425));
  61   EXPECT_EQ("-2425", printToString(-2425));
  62
  63   // Long long
  64   EXPECT_EQ("0", printToString(0LL));
  65   EXPECT_EQ("257257257235709", printToString(257257257235709LL));
  66   EXPECT_EQ("-257257257235709", printToString(-257257257235709LL));
  67
  68   // Double
  69   EXPECT_EQ("1.100000e+00", printToString(1.1));
  70
  71   // void*
  72   EXPECT_EQ("0x0", printToString((void*) nullptr));
  73   EXPECT_EQ("0xbeef", printToString((void*) 0xbeefLL));
  74   EXPECT_EQ("0xdeadbeef", printToString((void*) 0xdeadbeefLL));
  75
  76   // Min and max.
  77   EXPECT_EQ("18446744073709551615", printToString(UINT64_MAX));
  78   EXPECT_EQ("-9223372036854775808", printToString(INT64_MIN));
  79 }
  80
  81 TEST(raw_ostreamTest, Types_Unbuffered) {
  82   // Char
  83   EXPECT_EQ("c", printToStringUnbuffered('c'));
  84
  85   // String
  86   EXPECT_EQ("hello", printToStringUnbuffered("hello"));
  87   EXPECT_EQ("hello", printToStringUnbuffered(std::string("hello")));
  88
  89   // Int
  90   EXPECT_EQ("0", printToStringUnbuffered(0));
  91   EXPECT_EQ("2425", printToStringUnbuffered(2425));
  92   EXPECT_EQ("-2425", printToStringUnbuffered(-2425));
  93
  94   // Long long
  95   EXPECT_EQ("0", printToStringUnbuffered(0LL));
  96   EXPECT_EQ("257257257235709", printToStringUnbuffered(257257257235709LL));
  97   EXPECT_EQ("-257257257235709", printToStringUnbuffered(-257257257235709LL));
  98
  99   // Double
 100   EXPECT_EQ("1.100000e+00", printToStringUnbuffered(1.1));
 101
 102   // void*
 103   EXPECT_EQ("0x0", printToStringUnbuffered((void*) nullptr));
 104   EXPECT_EQ("0xbeef", printToStringUnbuffered((void*) 0xbeefLL));
 105   EXPECT_EQ("0xdeadbeef", printToStringUnbuffered((void*) 0xdeadbeefLL));
 106
 107   // Min and max.
 108   EXPECT_EQ("18446744073709551615", printToStringUnbuffered(UINT64_MAX));
 109   EXPECT_EQ("-9223372036854775808", printToStringUnbuffered(INT64_MIN));
 110 }
 111
 112 TEST(raw_ostreamTest, BufferEdge) {
 113   EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 1));
 114   EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 2));
 115   EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 3));
 116   EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 4));
 117   EXPECT_EQ("1.20", printToString(format("%.2f", 1.2), 10));
 118 }
 119
 120 TEST(raw_ostreamTest, TinyBuffer) {
 121   std::string Str;
 122   raw_string_ostream OS(Str);
 123   OS.SetBufferSize(1);
 124   OS << "hello";
 125   OS << 1;
 126   OS << 'w' << 'o' << 'r' << 'l' << 'd';
 127   EXPECT_EQ("hello1world", OS.str());
 128 }
 129
 130 TEST(raw_ostreamTest, WriteEscaped) {
 131   std::string Str;
 132
 133   Str = "";
 134   raw_string_ostream(Str).write_escaped("hi");
 135   EXPECT_EQ("hi", Str);
 136
 137   Str = "";
 138   raw_string_ostream(Str).write_escaped("\\\t\n\"");
 139   EXPECT_EQ("\\\\\\t\\n\\\"", Str);
 140
 141   Str = "";
 142   raw_string_ostream(Str).write_escaped("\1\10\200");
 143   EXPECT_EQ("\\001\\010\\200", Str);
 144 }
 145
 146 TEST(raw_ostreamTest, Justify) {
 147   EXPECT_EQ("xyz   ", printToString(left_justify("xyz", 6), 6));
 148   EXPECT_EQ("abc",    printToString(left_justify("abc", 3), 3));
 149   EXPECT_EQ("big",    printToString(left_justify("big", 1), 3));
 150   EXPECT_EQ("   xyz", printToString(right_justify("xyz", 6), 6));
 151   EXPECT_EQ("abc",    printToString(right_justify("abc", 3), 3));
 152   EXPECT_EQ("big",    printToString(right_justify("big", 1), 3));
 153   EXPECT_EQ("   on    ",    printToString(center_justify("on", 9), 9));
 154   EXPECT_EQ("   off    ",    printToString(center_justify("off", 10), 10));
 155   EXPECT_EQ("single ",    printToString(center_justify("single", 7), 7));
 156   EXPECT_EQ("none",    printToString(center_justify("none", 1), 4));
 157   EXPECT_EQ("none",    printToString(center_justify("none", 1), 1));
 158 }
 159
 160 TEST(raw_ostreamTest, FormatHex) {
 161   EXPECT_EQ("0x1234",     printToString(format_hex(0x1234, 6), 6));
 162   EXPECT_EQ("0x001234",   printToString(format_hex(0x1234, 8), 8));
 163   EXPECT_EQ("0x00001234", printToString(format_hex(0x1234, 10), 10));
 164   EXPECT_EQ("0x1234",     printToString(format_hex(0x1234, 4), 6));
 165   EXPECT_EQ("0xff",       printToString(format_hex(255, 4), 4));
 166   EXPECT_EQ("0xFF",       printToString(format_hex(255, 4, true), 4));
 167   EXPECT_EQ("0x1",        printToString(format_hex(1, 3), 3));
 168   EXPECT_EQ("0x12",       printToString(format_hex(0x12, 3), 4));
 169   EXPECT_EQ("0x123",      printToString(format_hex(0x123, 3), 5));
 170   EXPECT_EQ("FF",         printToString(format_hex_no_prefix(0xFF, 2, true), 4));
 171   EXPECT_EQ("ABCD",       printToString(format_hex_no_prefix(0xABCD, 2, true), 4));
 172   EXPECT_EQ("0xffffffffffffffff",
 173                           printToString(format_hex(UINT64_MAX, 18), 18));
 174   EXPECT_EQ("0x8000000000000000",
 175                           printToString(format_hex((INT64_MIN), 18), 18));
 176 }
 177
 178 TEST(raw_ostreamTest, FormatDecimal) {
 179   EXPECT_EQ("   0",        printToString(format_decimal(0, 4), 4));
 180   EXPECT_EQ("  -1",        printToString(format_decimal(-1, 4), 4));
 181   EXPECT_EQ("    -1",      printToString(format_decimal(-1, 6), 6));
 182   EXPECT_EQ("1234567890",  printToString(format_decimal(1234567890, 10), 10));
 183   EXPECT_EQ("  9223372036854775807",
 184                           printToString(format_decimal(INT64_MAX, 21), 21));
 185   EXPECT_EQ(" -9223372036854775808",
 186                           printToString(format_decimal(INT64_MIN, 21), 21));
 187 }
 188
 189 static std::string formatted_bytes_str(ArrayRef<uint8_t> Bytes,
 190                                        llvm::Optional<uint64_t> Offset = None,
 191                                        uint32_t NumPerLine = 16,
 192                                        uint8_t ByteGroupSize = 4) {
 193   std::string S;
 194   raw_string_ostream Str(S);
 195   Str << format_bytes(Bytes, Offset, NumPerLine, ByteGroupSize);
 196   Str.flush();
 197   return S;
 198 }
 199
 200 static std::string format_bytes_with_ascii_str(ArrayRef<uint8_t> Bytes,
 201                                                Optional<uint64_t> Offset = None,
 202                                                uint32_t NumPerLine = 16,
 203                                                uint8_t ByteGroupSize = 4) {
 204   std::string S;
 205   raw_string_ostream Str(S);
 206   Str << format_bytes_with_ascii(Bytes, Offset, NumPerLine, ByteGroupSize);
 207   Str.flush();
 208   return S;
 209 }
 210
 211 TEST(raw_ostreamTest, FormattedHexBytes) {
 212   std::vector<uint8_t> Buf = {'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i',
 213                               'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r',
 214                               's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0',
 215                               '1', '2', '3', '4', '5', '6', '7', '8', '9'};
 216   ArrayRef<uint8_t> B(Buf);
 217
 218   // Test invalid input.
 219   EXPECT_EQ("", formatted_bytes_str(ArrayRef<uint8_t>()));
 220   EXPECT_EQ("", format_bytes_with_ascii_str(ArrayRef<uint8_t>()));
 221   //----------------------------------------------------------------------
 222   // Test hex byte output with the default 4 byte groups
 223   //----------------------------------------------------------------------
 224   EXPECT_EQ("61", formatted_bytes_str(B.take_front()));
 225   EXPECT_EQ("61626364 65", formatted_bytes_str(B.take_front(5)));
 226   // Test that 16 bytes get written to a line correctly.
 227   EXPECT_EQ("61626364 65666768 696a6b6c 6d6e6f70",
 228             formatted_bytes_str(B.take_front(16)));
 229   // Test raw bytes with default 16 bytes per line wrapping.
 230   EXPECT_EQ("61626364 65666768 696a6b6c 6d6e6f70\n71",
 231             formatted_bytes_str(B.take_front(17)));
 232   // Test raw bytes with 1 bytes per line wrapping.
 233   EXPECT_EQ("61\n62\n63\n64\n65\n66",
 234             formatted_bytes_str(B.take_front(6), None, 1));
 235   // Test raw bytes with 7 bytes per line wrapping.
 236   EXPECT_EQ("61626364 656667\n68696a6b 6c6d6e\n6f7071",
 237             formatted_bytes_str(B.take_front(17), None, 7));
 238   // Test raw bytes with 8 bytes per line wrapping.
 239   EXPECT_EQ("61626364 65666768\n696a6b6c 6d6e6f70\n71",
 240             formatted_bytes_str(B.take_front(17), None, 8));
 241   //----------------------------------------------------------------------
 242   // Test hex byte output with the 1 byte groups
 243   //----------------------------------------------------------------------
 244   EXPECT_EQ("61 62 63 64 65",
 245             formatted_bytes_str(B.take_front(5), None, 16, 1));
 246   // Test that 16 bytes get written to a line correctly.
 247   EXPECT_EQ("61 62 63 64 65 66 67 68 69 6a 6b 6c 6d 6e 6f 70",
 248             formatted_bytes_str(B.take_front(16), None, 16, 1));
 249   // Test raw bytes with default 16 bytes per line wrapping.
 250   EXPECT_EQ("61 62 63 64 65 66 67 68 69 6a 6b 6c 6d 6e 6f 70\n71",
 251             formatted_bytes_str(B.take_front(17), None, 16, 1));
 252   // Test raw bytes with 7 bytes per line wrapping.
 253   EXPECT_EQ("61 62 63 64 65 66 67\n68 69 6a 6b 6c 6d 6e\n6f 70 71",
 254             formatted_bytes_str(B.take_front(17), None, 7, 1));
 255   // Test raw bytes with 8 bytes per line wrapping.
 256   EXPECT_EQ("61 62 63 64 65 66 67 68\n69 6a 6b 6c 6d 6e 6f 70\n71",
 257             formatted_bytes_str(B.take_front(17), None, 8, 1));
 258
 259   //----------------------------------------------------------------------
 260   // Test hex byte output with the 2 byte groups
 261   //----------------------------------------------------------------------
 262   EXPECT_EQ("6162 6364 65", formatted_bytes_str(B.take_front(5), None, 16, 2));
 263   // Test that 16 bytes get written to a line correctly.
 264   EXPECT_EQ("6162 6364 6566 6768 696a 6b6c 6d6e 6f70",
 265             formatted_bytes_str(B.take_front(16), None, 16, 2));
 266   // Test raw bytes with default 16 bytes per line wrapping.
 267   EXPECT_EQ("6162 6364 6566 6768 696a 6b6c 6d6e 6f70\n71",
 268             formatted_bytes_str(B.take_front(17), None, 16, 2));
 269   // Test raw bytes with 7 bytes per line wrapping.
 270   EXPECT_EQ("6162 6364 6566 67\n6869 6a6b 6c6d 6e\n6f70 71",
 271             formatted_bytes_str(B.take_front(17), None, 7, 2));
 272   // Test raw bytes with 8 bytes per line wrapping.
 273   EXPECT_EQ("6162 6364 6566 6768\n696a 6b6c 6d6e 6f70\n71",
 274             formatted_bytes_str(B.take_front(17), None, 8, 2));
 275
 276   //----------------------------------------------------------------------
 277   // Test hex bytes with offset with the default 4 byte groups.
 278   //----------------------------------------------------------------------
 279   EXPECT_EQ("0000: 61", formatted_bytes_str(B.take_front(), 0x0));
 280   EXPECT_EQ("1000: 61", formatted_bytes_str(B.take_front(), 0x1000));
 281   EXPECT_EQ("1000: 61\n1001: 62",
 282             formatted_bytes_str(B.take_front(2), 0x1000, 1));
 283   //----------------------------------------------------------------------
 284   // Test hex bytes with ASCII with the default 4 byte groups.
 285   //----------------------------------------------------------------------
 286   EXPECT_EQ("61626364 65666768 696a6b6c 6d6e6f70  |abcdefghijklmnop|",
 287             format_bytes_with_ascii_str(B.take_front(16)));
 288   EXPECT_EQ("61626364 65666768  |abcdefgh|\n"
 289             "696a6b6c 6d6e6f70  |ijklmnop|",
 290             format_bytes_with_ascii_str(B.take_front(16), None, 8));
 291   EXPECT_EQ("61626364 65666768  |abcdefgh|\n696a6b6c           |ijkl|",
 292             format_bytes_with_ascii_str(B.take_front(12), None, 8));
 293   std::vector<uint8_t> Unprintable = {'a', '\x1e', 'b', '\x1f'};
 294   // Make sure the ASCII is still lined up correctly when fewer bytes than 16
 295   // bytes per line are available. The ASCII should still be aligned as if 16
 296   // bytes of hex might be displayed.
 297   EXPECT_EQ("611e621f                             |a.b.|",
 298             format_bytes_with_ascii_str(Unprintable));
 299   //----------------------------------------------------------------------
 300   // Test hex bytes with ASCII with offsets with the default 4 byte groups.
 301   //----------------------------------------------------------------------
 302   EXPECT_EQ("0000: 61626364 65666768 "
 303             "696a6b6c 6d6e6f70  |abcdefghijklmnop|",
 304             format_bytes_with_ascii_str(B.take_front(16), 0));
 305   EXPECT_EQ("0000: 61626364 65666768  |abcdefgh|\n"
 306             "0008: 696a6b6c 6d6e6f70  |ijklmnop|",
 307             format_bytes_with_ascii_str(B.take_front(16), 0, 8));
 308   EXPECT_EQ("0000: 61626364 656667  |abcdefg|\n"
 309             "0007: 68696a6b 6c      |hijkl|",
 310             format_bytes_with_ascii_str(B.take_front(12), 0, 7));
 311
 312   //----------------------------------------------------------------------
 313   // Test hex bytes with ASCII with offsets with the default 2 byte groups.
 314   //----------------------------------------------------------------------
 315   EXPECT_EQ("0000: 6162 6364 6566 6768 "
 316             "696a 6b6c 6d6e 6f70  |abcdefghijklmnop|",
 317             format_bytes_with_ascii_str(B.take_front(16), 0, 16, 2));
 318   EXPECT_EQ("0000: 6162 6364 6566 6768  |abcdefgh|\n"
 319             "0008: 696a 6b6c 6d6e 6f70  |ijklmnop|",
 320             format_bytes_with_ascii_str(B.take_front(16), 0, 8, 2));
 321   EXPECT_EQ("0000: 6162 6364 6566 67  |abcdefg|\n"
 322             "0007: 6869 6a6b 6c       |hijkl|",
 323             format_bytes_with_ascii_str(B.take_front(12), 0, 7, 2));
 324
 325   //----------------------------------------------------------------------
 326   // Test hex bytes with ASCII with offsets with the default 1 byte groups.
 327   //----------------------------------------------------------------------
 328   EXPECT_EQ("0000: 61 62 63 64 65 66 67 68 "
 329             "69 6a 6b 6c 6d 6e 6f 70  |abcdefghijklmnop|",
 330             format_bytes_with_ascii_str(B.take_front(16), 0, 16, 1));
 331   EXPECT_EQ("0000: 61 62 63 64 65 66 67 68  |abcdefgh|\n"
 332             "0008: 69 6a 6b 6c 6d 6e 6f 70  |ijklmnop|",
 333             format_bytes_with_ascii_str(B.take_front(16), 0, 8, 1));
 334   EXPECT_EQ("0000: 61 62 63 64 65 66 67  |abcdefg|\n"
 335             "0007: 68 69 6a 6b 6c        |hijkl|",
 336             format_bytes_with_ascii_str(B.take_front(12), 0, 7, 1));
 337 }
 338
 339 TEST(raw_fd_ostreamTest, multiple_raw_fd_ostream_to_stdout) {
 340   std::error_code EC;
 341
 342   { raw_fd_ostream("-", EC, sys::fs::OpenFlags::OF_None); }
 343   { raw_fd_ostream("-", EC, sys::fs::OpenFlags::OF_None); }
 344 }
 345 }