blob: 6e42ac2d11f0a4d79a34e415438b8d9ad5edaddf [file] [log] [blame]
Raphael Isemannb1dfad02018-08-01 06:04:48 +00001//===-- StreamTest.cpp ------------------------------------------*- C++ -*-===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// 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
Raphael Isemannb1dfad02018-08-01 06:04:48 +00006//
7//===----------------------------------------------------------------------===//
8
9#include "lldb/Utility/StreamString.h"
10#include "gtest/gtest.h"
11
12using namespace lldb_private;
13
14namespace {
15struct StreamTest : ::testing::Test {
16 // Note: Stream is an abstract class, so we use StreamString to test it. To
17 // make it easier to change this later, only methods in this class explicitly
18 // refer to the StringStream class.
19 StreamString s;
20 // We return here a std::string because that way gtest can print better
21 // assertion messages.
22 std::string TakeValue() {
23 std::string result = s.GetString().str();
24 s.Clear();
25 return result;
26 }
27};
28}
29
30namespace {
31// A StreamTest where we expect the Stream output to be binary.
32struct BinaryStreamTest : StreamTest {
33 void SetUp() override {
34 s.GetFlags().Set(Stream::eBinary);
35 }
36};
37}
38
Raphael Isemann16d20132019-12-04 10:27:18 +010039TEST_F(StreamTest, AddressPrefix) {
40 s.Address(0x1, 1, "foo");
41 EXPECT_EQ("foo0x01", TakeValue());
42}
43
44TEST_F(StreamTest, AddressEmptyPrefix) {
45 s.Address(0x1, 1, nullptr);
46 EXPECT_EQ("0x01", TakeValue());
47 s.Address(0x1, 1, "");
48 EXPECT_EQ("0x01", TakeValue());
49}
50
51TEST_F(StreamTest, AddressSuffix) {
52 s.Address(0x1, 1, nullptr, "foo");
53 EXPECT_EQ("0x01foo", TakeValue());
54}
55
56TEST_F(StreamTest, AddressNoSuffix) {
57 s.Address(0x1, 1, nullptr, nullptr);
58 EXPECT_EQ("0x01", TakeValue());
59 s.Address(0x1, 1, nullptr, "");
60 EXPECT_EQ("0x01", TakeValue());
61}
62
63TEST_F(StreamTest, AddressPrefixAndSuffix) {
64 s.Address(0x1, 1, "foo", "bar");
65 EXPECT_EQ("foo0x01bar", TakeValue());
66}
67
68TEST_F(StreamTest, AddressSize) {
69 s.Address(0x0, 0);
70 EXPECT_EQ("0x0", TakeValue());
71 s.Address(0x1, 0);
72 EXPECT_EQ("0x1", TakeValue());
73
74 s.Address(0x1, 1);
75 EXPECT_EQ("0x01", TakeValue());
76 s.Address(0xf1, 1);
77 EXPECT_EQ("0xf1", TakeValue());
78 s.Address(0xff, 1);
79 EXPECT_EQ("0xff", TakeValue());
80 s.Address(0x100, 1);
81 EXPECT_EQ("0x100", TakeValue());
82
83 s.Address(0xf00, 4);
84 EXPECT_EQ("0x00000f00", TakeValue());
85 s.Address(0x100, 8);
86 EXPECT_EQ("0x0000000000000100", TakeValue());
87 s.Address(0x100, 10);
88 EXPECT_EQ("0x00000000000000000100", TakeValue());
89 s.Address(0x1234, 10);
90 EXPECT_EQ("0x00000000000000001234", TakeValue());
91}
92
93TEST_F(StreamTest, AddressRange) {
94 s.AddressRange(0x100, 0x101, 2);
95 EXPECT_EQ("[0x0100-0x0101)", TakeValue());
96}
97
98TEST_F(StreamTest, AddressRangeEmptyRange) {
99 s.AddressRange(0x100, 0x100, 2);
100 EXPECT_EQ("[0x0100-0x0100)", TakeValue());
101 s.AddressRange(0x0, 0x0, 2);
102 EXPECT_EQ("[0x0000-0x0000)", TakeValue());
103}
104
105TEST_F(StreamTest, AddressRangeInvalidRange) {
106 s.AddressRange(0x100, 0x0FF, 2);
107 EXPECT_EQ("[0x0100-0x00ff)", TakeValue());
108 s.AddressRange(0x100, 0x0, 2);
109 EXPECT_EQ("[0x0100-0x0000)", TakeValue());
110}
111
112TEST_F(StreamTest, AddressRangeSize) {
113 s.AddressRange(0x100, 0x101, 0);
114 EXPECT_EQ("[0x100-0x101)", TakeValue());
115 s.AddressRange(0x100, 0x101, 2);
116 EXPECT_EQ("[0x0100-0x0101)", TakeValue());
117 s.AddressRange(0x100, 0x101, 4);
118 EXPECT_EQ("[0x00000100-0x00000101)", TakeValue());
119
120 s.AddressRange(0x100, 0x101, 4);
121 EXPECT_EQ("[0x00000100-0x00000101)", TakeValue());
122 s.AddressRange(0x1, 0x101, 4);
123 EXPECT_EQ("[0x00000001-0x00000101)", TakeValue());
124 s.AddressRange(0x101, 0x1, 4);
125 EXPECT_EQ("[0x00000101-0x00000001)", TakeValue());
126
127 s.AddressRange(0x1, 0x101, 1);
128 EXPECT_EQ("[0x01-0x101)", TakeValue());
129}
130
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000131TEST_F(StreamTest, ChangingByteOrder) {
132 s.SetByteOrder(lldb::eByteOrderPDP);
133 EXPECT_EQ(lldb::eByteOrderPDP, s.GetByteOrder());
134}
135
136TEST_F(StreamTest, PutChar) {
137 s.PutChar('a');
Raphael Isemann92b16732018-08-02 16:38:34 +0000138 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000139 EXPECT_EQ("a", TakeValue());
140
141 s.PutChar('1');
Raphael Isemann92b16732018-08-02 16:38:34 +0000142 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000143 EXPECT_EQ("1", TakeValue());
144}
145
146TEST_F(StreamTest, PutCharWhitespace) {
147 s.PutChar(' ');
Raphael Isemann92b16732018-08-02 16:38:34 +0000148 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000149 EXPECT_EQ(" ", TakeValue());
150
151 s.PutChar('\n');
Raphael Isemann92b16732018-08-02 16:38:34 +0000152 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000153 EXPECT_EQ("\n", TakeValue());
154
155 s.PutChar('\r');
Raphael Isemann92b16732018-08-02 16:38:34 +0000156 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000157 EXPECT_EQ("\r", TakeValue());
158
159 s.PutChar('\t');
Raphael Isemann92b16732018-08-02 16:38:34 +0000160 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000161 EXPECT_EQ("\t", TakeValue());
162}
163
164TEST_F(StreamTest, PutCString) {
165 s.PutCString("");
Raphael Isemann92b16732018-08-02 16:38:34 +0000166 EXPECT_EQ(0U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000167 EXPECT_EQ("", TakeValue());
168
169 s.PutCString("foobar");
Raphael Isemann92b16732018-08-02 16:38:34 +0000170 EXPECT_EQ(6U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000171 EXPECT_EQ("foobar", TakeValue());
172
173 s.PutCString(" ");
Raphael Isemann92b16732018-08-02 16:38:34 +0000174 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000175 EXPECT_EQ(" ", TakeValue());
176}
177
178TEST_F(StreamTest, PutCStringWithStringRef) {
179 s.PutCString(llvm::StringRef(""));
Raphael Isemann92b16732018-08-02 16:38:34 +0000180 EXPECT_EQ(0U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000181 EXPECT_EQ("", TakeValue());
182
183 s.PutCString(llvm::StringRef("foobar"));
Raphael Isemann92b16732018-08-02 16:38:34 +0000184 EXPECT_EQ(6U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000185 EXPECT_EQ("foobar", TakeValue());
186
187 s.PutCString(llvm::StringRef(" "));
Raphael Isemann92b16732018-08-02 16:38:34 +0000188 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000189 EXPECT_EQ(" ", TakeValue());
190}
191
192TEST_F(StreamTest, QuotedCString) {
193 s.QuotedCString("foo");
Raphael Isemann92b16732018-08-02 16:38:34 +0000194 EXPECT_EQ(5U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000195 EXPECT_EQ(R"("foo")", TakeValue());
196
197 s.QuotedCString("ba r");
Raphael Isemann92b16732018-08-02 16:38:34 +0000198 EXPECT_EQ(6U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000199 EXPECT_EQ(R"("ba r")", TakeValue());
200
201 s.QuotedCString(" ");
Raphael Isemann92b16732018-08-02 16:38:34 +0000202 EXPECT_EQ(3U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000203 EXPECT_EQ(R"(" ")", TakeValue());
204}
205
206TEST_F(StreamTest, PutCharNull) {
207 s.PutChar('\0');
Raphael Isemann92b16732018-08-02 16:38:34 +0000208 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000209 EXPECT_EQ(std::string("\0", 1), TakeValue());
210
211 s.PutChar('a');
Raphael Isemann92b16732018-08-02 16:38:34 +0000212 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000213 EXPECT_EQ(std::string("a", 1), TakeValue());
214}
215
Pavel Labath7f815a92019-02-12 14:28:55 +0000216TEST_F(StreamTest, PutStringAsRawHex8) {
217 s.PutStringAsRawHex8("");
Raphael Isemann92b16732018-08-02 16:38:34 +0000218 EXPECT_EQ(0U, s.GetWrittenBytes());
Raphael Isemannf4590de2018-08-01 21:07:18 +0000219 EXPECT_EQ("", TakeValue());
220
Pavel Labath7f815a92019-02-12 14:28:55 +0000221 s.PutStringAsRawHex8("foobar");
Raphael Isemann92b16732018-08-02 16:38:34 +0000222 EXPECT_EQ(12U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000223 EXPECT_EQ("666f6f626172", TakeValue());
224
Pavel Labath7f815a92019-02-12 14:28:55 +0000225 s.PutStringAsRawHex8(" ");
Raphael Isemann92b16732018-08-02 16:38:34 +0000226 EXPECT_EQ(2U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000227 EXPECT_EQ("20", TakeValue());
228}
229
230TEST_F(StreamTest, PutHex8) {
231 s.PutHex8((uint8_t)55);
Raphael Isemann92b16732018-08-02 16:38:34 +0000232 EXPECT_EQ(2U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000233 EXPECT_EQ("37", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000234
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000235 s.PutHex8(std::numeric_limits<uint8_t>::max());
Raphael Isemann92b16732018-08-02 16:38:34 +0000236 EXPECT_EQ(2U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000237 EXPECT_EQ("ff", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000238
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000239 s.PutHex8((uint8_t)0);
Raphael Isemann92b16732018-08-02 16:38:34 +0000240 EXPECT_EQ(2U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000241 EXPECT_EQ("00", TakeValue());
242}
243
244TEST_F(StreamTest, PutNHex8) {
245 s.PutNHex8(0, (uint8_t)55);
Raphael Isemann92b16732018-08-02 16:38:34 +0000246 EXPECT_EQ(0U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000247 EXPECT_EQ("", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000248
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000249 s.PutNHex8(1, (uint8_t)55);
Raphael Isemann92b16732018-08-02 16:38:34 +0000250 EXPECT_EQ(2U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000251 EXPECT_EQ("37", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000252
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000253 s.PutNHex8(2, (uint8_t)55);
Raphael Isemann92b16732018-08-02 16:38:34 +0000254 EXPECT_EQ(4U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000255 EXPECT_EQ("3737", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000256
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000257 s.PutNHex8(1, (uint8_t)56);
Raphael Isemann92b16732018-08-02 16:38:34 +0000258 EXPECT_EQ(2U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000259 EXPECT_EQ("38", TakeValue());
260}
261
262TEST_F(StreamTest, PutHex16ByteOrderLittle) {
263 s.PutHex16(0x1234U, lldb::eByteOrderLittle);
Raphael Isemann92b16732018-08-02 16:38:34 +0000264 EXPECT_EQ(4U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000265 EXPECT_EQ("3412", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000266
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000267 s.PutHex16(std::numeric_limits<uint16_t>::max(), lldb::eByteOrderLittle);
Raphael Isemann92b16732018-08-02 16:38:34 +0000268 EXPECT_EQ(4U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000269 EXPECT_EQ("ffff", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000270
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000271 s.PutHex16(0U, lldb::eByteOrderLittle);
Raphael Isemann92b16732018-08-02 16:38:34 +0000272 EXPECT_EQ(4U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000273 EXPECT_EQ("0000", TakeValue());
274}
275
276TEST_F(StreamTest, PutHex16ByteOrderBig) {
277 s.PutHex16(0x1234U, lldb::eByteOrderBig);
Raphael Isemann92b16732018-08-02 16:38:34 +0000278 EXPECT_EQ(4U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000279 EXPECT_EQ("1234", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000280
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000281 s.PutHex16(std::numeric_limits<uint16_t>::max(), lldb::eByteOrderBig);
Raphael Isemann92b16732018-08-02 16:38:34 +0000282 EXPECT_EQ(4U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000283 EXPECT_EQ("ffff", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000284
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000285 s.PutHex16(0U, lldb::eByteOrderBig);
Raphael Isemann92b16732018-08-02 16:38:34 +0000286 EXPECT_EQ(4U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000287 EXPECT_EQ("0000", TakeValue());
288}
289
290TEST_F(StreamTest, PutHex32ByteOrderLittle) {
291 s.PutHex32(0x12345678U, lldb::eByteOrderLittle);
Raphael Isemann92b16732018-08-02 16:38:34 +0000292 EXPECT_EQ(8U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000293 EXPECT_EQ("78563412", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000294
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000295 s.PutHex32(std::numeric_limits<uint32_t>::max(), lldb::eByteOrderLittle);
Raphael Isemann92b16732018-08-02 16:38:34 +0000296 EXPECT_EQ(8U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000297 EXPECT_EQ("ffffffff", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000298
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000299 s.PutHex32(0U, lldb::eByteOrderLittle);
Raphael Isemann92b16732018-08-02 16:38:34 +0000300 EXPECT_EQ(8U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000301 EXPECT_EQ("00000000", TakeValue());
302}
303
304TEST_F(StreamTest, PutHex32ByteOrderBig) {
305 s.PutHex32(0x12345678U, lldb::eByteOrderBig);
Raphael Isemann92b16732018-08-02 16:38:34 +0000306 EXPECT_EQ(8U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000307 EXPECT_EQ("12345678", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000308
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000309 s.PutHex32(std::numeric_limits<uint32_t>::max(), lldb::eByteOrderBig);
Raphael Isemann92b16732018-08-02 16:38:34 +0000310 EXPECT_EQ(8U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000311 EXPECT_EQ("ffffffff", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000312
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000313 s.PutHex32(0U, lldb::eByteOrderBig);
Raphael Isemann92b16732018-08-02 16:38:34 +0000314 EXPECT_EQ(8U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000315 EXPECT_EQ("00000000", TakeValue());
316}
317
318TEST_F(StreamTest, PutHex64ByteOrderLittle) {
319 s.PutHex64(0x1234567890ABCDEFU, lldb::eByteOrderLittle);
Raphael Isemann92b16732018-08-02 16:38:34 +0000320 EXPECT_EQ(16U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000321 EXPECT_EQ("efcdab9078563412", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000322
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000323 s.PutHex64(std::numeric_limits<uint64_t>::max(), lldb::eByteOrderLittle);
Raphael Isemann92b16732018-08-02 16:38:34 +0000324 EXPECT_EQ(16U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000325 EXPECT_EQ("ffffffffffffffff", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000326
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000327 s.PutHex64(0U, lldb::eByteOrderLittle);
Raphael Isemann92b16732018-08-02 16:38:34 +0000328 EXPECT_EQ(16U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000329 EXPECT_EQ("0000000000000000", TakeValue());
330}
331
332TEST_F(StreamTest, PutHex64ByteOrderBig) {
333 s.PutHex64(0x1234567890ABCDEFU, lldb::eByteOrderBig);
Raphael Isemann92b16732018-08-02 16:38:34 +0000334 EXPECT_EQ(16U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000335 EXPECT_EQ("1234567890abcdef", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000336
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000337 s.PutHex64(std::numeric_limits<uint64_t>::max(), lldb::eByteOrderBig);
Raphael Isemann92b16732018-08-02 16:38:34 +0000338 EXPECT_EQ(16U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000339 EXPECT_EQ("ffffffffffffffff", TakeValue());
Raphael Isemann92b16732018-08-02 16:38:34 +0000340
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000341 s.PutHex64(0U, lldb::eByteOrderBig);
Raphael Isemann92b16732018-08-02 16:38:34 +0000342 EXPECT_EQ(16U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000343 EXPECT_EQ("0000000000000000", TakeValue());
344}
345
Raphael Isemann0bb8d832018-08-01 17:12:58 +0000346TEST_F(StreamTest, PutMaxHex64ByteOrderBig) {
347 std::size_t bytes;
348 bytes = s.PutMaxHex64(0x12U, 1, lldb::eByteOrderBig);
349 EXPECT_EQ(2U, bytes);
350 bytes = s.PutMaxHex64(0x1234U, 2, lldb::eByteOrderBig);
351 EXPECT_EQ(4U, bytes);
352 bytes = s.PutMaxHex64(0x12345678U, 4, lldb::eByteOrderBig);
353 EXPECT_EQ(8U, bytes);
354 bytes = s.PutMaxHex64(0x1234567890ABCDEFU, 8, lldb::eByteOrderBig);
355 EXPECT_EQ(16U, bytes);
Raphael Isemann92b16732018-08-02 16:38:34 +0000356 EXPECT_EQ(30U, s.GetWrittenBytes());
Raphael Isemann0bb8d832018-08-01 17:12:58 +0000357 EXPECT_EQ("121234123456781234567890abcdef", TakeValue());
358}
359
360TEST_F(StreamTest, PutMaxHex64ByteOrderLittle) {
361 std::size_t bytes;
362 bytes = s.PutMaxHex64(0x12U, 1, lldb::eByteOrderLittle);
363 EXPECT_EQ(2U, bytes);
364 bytes = s.PutMaxHex64(0x1234U, 2, lldb::eByteOrderLittle);
365 EXPECT_EQ(4U, bytes);
366 bytes = s.PutMaxHex64(0x12345678U, 4, lldb::eByteOrderLittle);
367 EXPECT_EQ(8U, bytes);
368 bytes = s.PutMaxHex64(0x1234567890ABCDEFU, 8, lldb::eByteOrderLittle);
369 EXPECT_EQ(16U, bytes);
Raphael Isemann92b16732018-08-02 16:38:34 +0000370 EXPECT_EQ(30U, s.GetWrittenBytes());
Raphael Isemann0bb8d832018-08-01 17:12:58 +0000371 EXPECT_EQ("12341278563412efcdab9078563412", TakeValue());
372}
373
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000374// Shift operator tests.
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000375
376TEST_F(StreamTest, ShiftOperatorChars) {
377 s << 'a' << 'b';
Raphael Isemann92b16732018-08-02 16:38:34 +0000378 EXPECT_EQ(2U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000379 EXPECT_EQ("ab", TakeValue());
380}
381
382TEST_F(StreamTest, ShiftOperatorStrings) {
383 s << "cstring\n";
Raphael Isemann92b16732018-08-02 16:38:34 +0000384 EXPECT_EQ(8U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000385 s << llvm::StringRef("llvm::StringRef\n");
Raphael Isemann92b16732018-08-02 16:38:34 +0000386 EXPECT_EQ(24U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000387 EXPECT_EQ("cstring\nllvm::StringRef\n", TakeValue());
388}
389
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000390TEST_F(StreamTest, ShiftOperatorPtr) {
391 // This test is a bit tricky because pretty much everything related to
392 // pointer printing seems to lead to UB or IB. So let's make the most basic
393 // test that just checks that we print *something*. This way we at least know
394 // that pointer printing doesn't do really bad things (e.g. crashing, reading
395 // OOB/uninitialized memory which the sanitizers would spot).
396
397 // Shift our own pointer to the output.
398 int i = 3;
399 int *ptr = &i;
400 s << ptr;
401
Raphael Isemann92b16732018-08-02 16:38:34 +0000402 EXPECT_NE(0U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000403 EXPECT_TRUE(!TakeValue().empty());
404}
405
406TEST_F(StreamTest, PutPtr) {
407 // See the ShiftOperatorPtr test for the rationale.
408 int i = 3;
409 int *ptr = &i;
410 s.PutPointer(ptr);
411
Raphael Isemann92b16732018-08-02 16:38:34 +0000412 EXPECT_NE(0U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000413 EXPECT_TRUE(!TakeValue().empty());
414}
415
416// Alias to make it more clear that 'invalid' means for the Stream interface
417// that it should use the host byte order.
418const static auto hostByteOrder = lldb::eByteOrderInvalid;
419
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000420// PutRawBytes/PutBytesAsRawHex tests.
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000421
422TEST_F(StreamTest, PutBytesAsRawHex8ToBigEndian) {
423 uint32_t value = 0x12345678;
424 s.PutBytesAsRawHex8(static_cast<void*>(&value), sizeof(value),
425 hostByteOrder, lldb::eByteOrderBig);
Raphael Isemann92b16732018-08-02 16:38:34 +0000426 EXPECT_EQ(8U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000427 EXPECT_EQ("78563412", TakeValue());
428}
429
430TEST_F(StreamTest, PutRawBytesToBigEndian) {
431 uint32_t value = 0x12345678;
432 s.PutRawBytes(static_cast<void*>(&value), sizeof(value),
433 hostByteOrder, lldb::eByteOrderBig);
Raphael Isemann92b16732018-08-02 16:38:34 +0000434 EXPECT_EQ(4U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000435 EXPECT_EQ("\x78\x56\x34\x12", TakeValue());
436}
437
438TEST_F(StreamTest, PutBytesAsRawHex8ToLittleEndian) {
439 uint32_t value = 0x12345678;
440 s.PutBytesAsRawHex8(static_cast<void*>(&value), sizeof(value),
441 hostByteOrder, lldb::eByteOrderLittle);
Raphael Isemann92b16732018-08-02 16:38:34 +0000442 EXPECT_EQ(8U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000443 EXPECT_EQ("12345678", TakeValue());
444}
445
446TEST_F(StreamTest, PutRawBytesToLittleEndian) {
447 uint32_t value = 0x12345678;
448 s.PutRawBytes(static_cast<void*>(&value), sizeof(value),
449 hostByteOrder, lldb::eByteOrderLittle);
Raphael Isemann92b16732018-08-02 16:38:34 +0000450 EXPECT_EQ(4U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000451 EXPECT_EQ("\x12\x34\x56\x78", TakeValue());
452}
453
454TEST_F(StreamTest, PutBytesAsRawHex8ToMixedEndian) {
455 uint32_t value = 0x12345678;
456 s.PutBytesAsRawHex8(static_cast<void*>(&value), sizeof(value),
457 hostByteOrder, lldb::eByteOrderPDP);
458
459 // FIXME: PDP byte order is not actually implemented but Stream just silently
460 // prints the value in some random byte order...
461#if 0
462 EXPECT_EQ("34127856", TakeValue());
463#endif
464}
465
466TEST_F(StreamTest, PutRawBytesToMixedEndian) {
467 uint32_t value = 0x12345678;
468 s.PutRawBytes(static_cast<void*>(&value), sizeof(value),
469 lldb::eByteOrderInvalid, lldb::eByteOrderPDP);
470
471 // FIXME: PDP byte order is not actually implemented but Stream just silently
472 // prints the value in some random byte order...
473#if 0
474 EXPECT_EQ("\x34\x12\x78\x56", TakeValue());
475#endif
476}
477
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000478// ULEB128 support for binary streams.
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000479
480TEST_F(BinaryStreamTest, PutULEB128OneByte) {
481 auto bytes = s.PutULEB128(0x74ULL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000482 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000483 EXPECT_EQ("\x74", TakeValue());
484 EXPECT_EQ(1U, bytes);
485}
486
487TEST_F(BinaryStreamTest, PutULEB128TwoBytes) {
488 auto bytes = s.PutULEB128(0x1985ULL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000489 EXPECT_EQ(2U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000490 EXPECT_EQ("\x85\x33", TakeValue());
491 EXPECT_EQ(2U, bytes);
492}
493
494TEST_F(BinaryStreamTest, PutULEB128ThreeBytes) {
495 auto bytes = s.PutULEB128(0x5023ULL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000496 EXPECT_EQ(3U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000497 EXPECT_EQ("\xA3\xA0\x1", TakeValue());
498 EXPECT_EQ(3U, bytes);
499}
500
501TEST_F(BinaryStreamTest, PutULEB128FourBytes) {
502 auto bytes = s.PutULEB128(0xA48032ULL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000503 EXPECT_EQ(4U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000504 EXPECT_EQ("\xB2\x80\x92\x5", TakeValue());
505 EXPECT_EQ(4U, bytes);
506}
507
508TEST_F(BinaryStreamTest, PutULEB128FiveBytes) {
509 auto bytes = s.PutULEB128(0x12345678ULL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000510 EXPECT_EQ(5U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000511 EXPECT_EQ("\xF8\xAC\xD1\x91\x1", TakeValue());
512 EXPECT_EQ(5U, bytes);
513}
514
515TEST_F(BinaryStreamTest, PutULEB128SixBytes) {
516 auto bytes = s.PutULEB128(0xABFE3FAFDFULL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000517 EXPECT_EQ(6U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000518 EXPECT_EQ("\xDF\xDF\xFE\xF1\xBF\x15", TakeValue());
519 EXPECT_EQ(6U, bytes);
520}
521
522TEST_F(BinaryStreamTest, PutULEB128SevenBytes) {
523 auto bytes = s.PutULEB128(0xDABFE3FAFDFULL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000524 EXPECT_EQ(7U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000525 EXPECT_EQ("\xDF\xDF\xFE\xF1\xBF\xB5\x3", TakeValue());
526 EXPECT_EQ(7U, bytes);
527}
528
529TEST_F(BinaryStreamTest, PutULEB128EightBytes) {
530 auto bytes = s.PutULEB128(0x7CDABFE3FAFDFULL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000531 EXPECT_EQ(8U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000532 EXPECT_EQ("\xDF\xDF\xFE\xF1\xBF\xB5\xF3\x3", TakeValue());
533 EXPECT_EQ(8U, bytes);
534}
535
536TEST_F(BinaryStreamTest, PutULEB128NineBytes) {
537 auto bytes = s.PutULEB128(0x327CDABFE3FAFDFULL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000538 EXPECT_EQ(9U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000539 EXPECT_EQ("\xDF\xDF\xFE\xF1\xBF\xB5\xF3\x93\x3", TakeValue());
540 EXPECT_EQ(9U, bytes);
541}
542
543TEST_F(BinaryStreamTest, PutULEB128MaxValue) {
544 auto bytes = s.PutULEB128(std::numeric_limits<uint64_t>::max());
Raphael Isemann92b16732018-08-02 16:38:34 +0000545 EXPECT_EQ(10U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000546 EXPECT_EQ("\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\x1", TakeValue());
547 EXPECT_EQ(10U, bytes);
548}
549
550TEST_F(BinaryStreamTest, PutULEB128Zero) {
551 auto bytes = s.PutULEB128(0x0U);
Raphael Isemann92b16732018-08-02 16:38:34 +0000552 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000553 EXPECT_EQ(std::string("\0", 1), TakeValue());
554 EXPECT_EQ(1U, bytes);
555}
556
557TEST_F(BinaryStreamTest, PutULEB128One) {
558 auto bytes = s.PutULEB128(0x1U);
Raphael Isemann92b16732018-08-02 16:38:34 +0000559 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000560 EXPECT_EQ("\x1", TakeValue());
561 EXPECT_EQ(1U, bytes);
562}
563
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000564// SLEB128 support for binary streams.
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000565
566TEST_F(BinaryStreamTest, PutSLEB128OneByte) {
567 auto bytes = s.PutSLEB128(0x74LL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000568 EXPECT_EQ(2U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000569 EXPECT_EQ(std::string("\xF4\0", 2), TakeValue());
570 EXPECT_EQ(2U, bytes);
571}
572
573TEST_F(BinaryStreamTest, PutSLEB128TwoBytes) {
574 auto bytes = s.PutSLEB128(0x1985LL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000575 EXPECT_EQ(2U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000576 EXPECT_EQ("\x85\x33", TakeValue());
577 EXPECT_EQ(2U, bytes);
578}
579
580TEST_F(BinaryStreamTest, PutSLEB128ThreeBytes) {
581 auto bytes = s.PutSLEB128(0x5023LL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000582 EXPECT_EQ(3U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000583 EXPECT_EQ("\xA3\xA0\x1", TakeValue());
584 EXPECT_EQ(3U, bytes);
585}
586
587TEST_F(BinaryStreamTest, PutSLEB128FourBytes) {
588 auto bytes = s.PutSLEB128(0xA48032LL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000589 EXPECT_EQ(4U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000590 EXPECT_EQ("\xB2\x80\x92\x5", TakeValue());
591 EXPECT_EQ(4U, bytes);
592}
593
594TEST_F(BinaryStreamTest, PutSLEB128FiveBytes) {
595 auto bytes = s.PutSLEB128(0x12345678LL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000596 EXPECT_EQ(5U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000597 EXPECT_EQ("\xF8\xAC\xD1\x91\x1", TakeValue());
598 EXPECT_EQ(5U, bytes);
599}
600
601TEST_F(BinaryStreamTest, PutSLEB128SixBytes) {
602 auto bytes = s.PutSLEB128(0xABFE3FAFDFLL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000603 EXPECT_EQ(6U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000604 EXPECT_EQ("\xDF\xDF\xFE\xF1\xBF\x15", TakeValue());
605 EXPECT_EQ(6U, bytes);
606}
607
608TEST_F(BinaryStreamTest, PutSLEB128SevenBytes) {
609 auto bytes = s.PutSLEB128(0xDABFE3FAFDFLL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000610 EXPECT_EQ(7U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000611 EXPECT_EQ("\xDF\xDF\xFE\xF1\xBF\xB5\x3", TakeValue());
612 EXPECT_EQ(7U, bytes);
613}
614
615TEST_F(BinaryStreamTest, PutSLEB128EightBytes) {
616 auto bytes = s.PutSLEB128(0x7CDABFE3FAFDFLL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000617 EXPECT_EQ(8U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000618 EXPECT_EQ("\xDF\xDF\xFE\xF1\xBF\xB5\xF3\x3", TakeValue());
619 EXPECT_EQ(8U, bytes);
620}
621
622TEST_F(BinaryStreamTest, PutSLEB128NineBytes) {
623 auto bytes = s.PutSLEB128(0x327CDABFE3FAFDFLL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000624 EXPECT_EQ(9U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000625 EXPECT_EQ("\xDF\xDF\xFE\xF1\xBF\xB5\xF3\x93\x3", TakeValue());
626 EXPECT_EQ(9U, bytes);
627}
628
629TEST_F(BinaryStreamTest, PutSLEB128MaxValue) {
630 auto bytes = s.PutSLEB128(std::numeric_limits<int64_t>::max());
Raphael Isemann92b16732018-08-02 16:38:34 +0000631 EXPECT_EQ(10U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000632 EXPECT_EQ(std::string("\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\0", 10), TakeValue());
633 EXPECT_EQ(10U, bytes);
634}
635
636TEST_F(BinaryStreamTest, PutSLEB128Zero) {
637 auto bytes = s.PutSLEB128(0x0);
Raphael Isemann92b16732018-08-02 16:38:34 +0000638 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000639 EXPECT_EQ(std::string("\0", 1), TakeValue());
640 EXPECT_EQ(1U, bytes);
641}
642
643TEST_F(BinaryStreamTest, PutSLEB128One) {
644 auto bytes = s.PutSLEB128(0x1);
Raphael Isemann92b16732018-08-02 16:38:34 +0000645 EXPECT_EQ(1U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000646 EXPECT_EQ(std::string("\x1", 1), TakeValue());
647 EXPECT_EQ(1U, bytes);
648}
649
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000650// SLEB128/ULEB128 support for non-binary streams.
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000651
652// The logic for this is very simple, so it should be enough to test some basic
653// use cases.
654
655TEST_F(StreamTest, PutULEB128) {
656 auto bytes = s.PutULEB128(0x74ULL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000657 EXPECT_EQ(4U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000658 EXPECT_EQ("0x74", TakeValue());
659 EXPECT_EQ(4U, bytes);
660}
661
662TEST_F(StreamTest, PutSLEB128) {
663 auto bytes = s.PutSLEB128(0x1985LL);
Raphael Isemann92b16732018-08-02 16:38:34 +0000664 EXPECT_EQ(6U, s.GetWrittenBytes());
Raphael Isemannb1dfad02018-08-01 06:04:48 +0000665 EXPECT_EQ("0x6533", TakeValue());
666 EXPECT_EQ(6U, bytes);
667}