Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 1 | // Copyright 2019 The Pigweed Authors |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); you may not |
Wyatt Hepler | 1a96094 | 2019-11-26 14:13:38 -0800 | [diff] [blame] | 4 | // use this file except in compliance with the License. You may obtain a copy of |
| 5 | // the License at |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 6 | // |
| 7 | // https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 11 | // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
Wyatt Hepler | 1a96094 | 2019-11-26 14:13:38 -0800 | [diff] [blame] | 12 | // License for the specific language governing permissions and limitations under |
| 13 | // the License. |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 14 | |
Wyatt Hepler | 6d1a6c6 | 2020-06-22 15:40:45 -0700 | [diff] [blame] | 15 | #include "pw_string/string_builder.h" |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 16 | |
| 17 | #include <cinttypes> |
| 18 | #include <cmath> |
| 19 | #include <cstdint> |
| 20 | #include <cstring> |
Wyatt Hepler | 6d1a6c6 | 2020-06-22 15:40:45 -0700 | [diff] [blame] | 21 | #include <span> |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 22 | #include <string_view> |
| 23 | |
| 24 | #include "gtest/gtest.h" |
| 25 | #include "pw_string/format.h" |
| 26 | |
Wyatt Hepler | 6d1a6c6 | 2020-06-22 15:40:45 -0700 | [diff] [blame] | 27 | namespace this_pw_test { |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 28 | |
| 29 | struct CustomType { |
| 30 | uint32_t a; |
| 31 | uint32_t b; |
| 32 | |
| 33 | static constexpr const char* kToString = "This is a CustomType"; |
| 34 | |
| 35 | CustomType() = default; |
| 36 | |
| 37 | // Non-copyable to verify StringBuffer's << operator doesn't copy it. |
| 38 | CustomType(const CustomType&) = delete; |
| 39 | CustomType& operator=(const CustomType&) = delete; |
| 40 | }; |
| 41 | |
Wyatt Hepler | 6d1a6c6 | 2020-06-22 15:40:45 -0700 | [diff] [blame] | 42 | } // namespace this_pw_test |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 43 | |
| 44 | namespace pw { |
| 45 | |
Wyatt Hepler | 6d1a6c6 | 2020-06-22 15:40:45 -0700 | [diff] [blame] | 46 | template <> |
| 47 | StatusWithSize ToString<this_pw_test::CustomType>( |
| 48 | const this_pw_test::CustomType&, std::span<char> buffer) { |
| 49 | return string::Format(buffer, this_pw_test::CustomType::kToString); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 50 | } |
| 51 | |
Wyatt Hepler | 6d1a6c6 | 2020-06-22 15:40:45 -0700 | [diff] [blame] | 52 | } // namespace pw |
| 53 | |
| 54 | namespace pw { |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 55 | namespace { |
| 56 | |
Wyatt Hepler | 6d1a6c6 | 2020-06-22 15:40:45 -0700 | [diff] [blame] | 57 | using this_pw_test::CustomType; |
| 58 | |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 59 | TEST(StringBuilder, EmptyBuffer_SizeAndMaxSizeAreCorrect) { |
Wyatt Hepler | 6d1a6c6 | 2020-06-22 15:40:45 -0700 | [diff] [blame] | 60 | StringBuilder sb(std::span<char>{}); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 61 | |
| 62 | EXPECT_TRUE(sb.empty()); |
| 63 | EXPECT_EQ(0u, sb.size()); |
| 64 | EXPECT_EQ(0u, sb.max_size()); |
| 65 | } |
| 66 | |
| 67 | using namespace std::literals::string_view_literals; |
| 68 | |
| 69 | constexpr std::string_view kNoTouch = "DO NOT TOUCH\0VALUE SHOULD NOT CHANGE"sv; |
| 70 | |
| 71 | TEST(StringBuilder, EmptyBuffer_StreamOutput_WritesNothing) { |
| 72 | char buffer[kNoTouch.size()]; |
| 73 | std::memcpy(buffer, kNoTouch.data(), sizeof(buffer)); |
| 74 | |
Wyatt Hepler | 6d1a6c6 | 2020-06-22 15:40:45 -0700 | [diff] [blame] | 75 | StringBuilder sb(std::span(buffer, 0)); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 76 | |
| 77 | sb << CustomType() << " is " << 12345; |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 78 | EXPECT_EQ(Status::ResourceExhausted(), sb.status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 79 | EXPECT_EQ(kNoTouch, std::string_view(buffer, sizeof(buffer))); |
| 80 | } |
| 81 | |
| 82 | TEST(StringBuilder, EmptyBuffer_Append_WritesNothing) { |
| 83 | char buffer[kNoTouch.size()]; |
| 84 | std::memcpy(buffer, kNoTouch.data(), sizeof(buffer)); |
| 85 | |
Wyatt Hepler | 6d1a6c6 | 2020-06-22 15:40:45 -0700 | [diff] [blame] | 86 | StringBuilder sb(std::span(buffer, 0)); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 87 | |
| 88 | EXPECT_FALSE(sb.append("Hello").ok()); |
| 89 | EXPECT_EQ(kNoTouch, std::string_view(buffer, sizeof(buffer))); |
| 90 | } |
| 91 | |
| 92 | TEST(StringBuilder, EmptyBuffer_Resize_WritesNothing) { |
| 93 | char buffer[kNoTouch.size()]; |
| 94 | std::memcpy(buffer, kNoTouch.data(), sizeof(buffer)); |
| 95 | |
Wyatt Hepler | 6d1a6c6 | 2020-06-22 15:40:45 -0700 | [diff] [blame] | 96 | StringBuilder sb(std::span(buffer, 0)); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 97 | |
| 98 | sb.resize(0); |
| 99 | EXPECT_TRUE(sb.ok()); |
| 100 | EXPECT_EQ(kNoTouch, std::string_view(buffer, sizeof(buffer))); |
| 101 | } |
| 102 | |
| 103 | TEST(StringBuilder, EmptyBuffer_AppendEmpty_ResourceExhausted) { |
Wyatt Hepler | 6d1a6c6 | 2020-06-22 15:40:45 -0700 | [diff] [blame] | 104 | StringBuilder sb(std::span<char>{}); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 105 | EXPECT_EQ(OkStatus(), sb.last_status()); |
| 106 | EXPECT_EQ(OkStatus(), sb.status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 107 | |
| 108 | sb << ""; |
| 109 | |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 110 | EXPECT_EQ(Status::ResourceExhausted(), sb.last_status()); |
| 111 | EXPECT_EQ(Status::ResourceExhausted(), sb.status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 112 | } |
| 113 | |
| 114 | TEST(StringBuilder, Status_StartsOk) { |
| 115 | StringBuffer<16> sb; |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 116 | EXPECT_EQ(OkStatus(), sb.status()); |
| 117 | EXPECT_EQ(OkStatus(), sb.last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 118 | } |
| 119 | |
| 120 | TEST(StringBuilder, Status_StatusAndLastStatusUpdate) { |
| 121 | StringBuffer<16> sb; |
| 122 | sb << "Well, if only there were enough room in here for this string"; |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 123 | EXPECT_EQ(Status::ResourceExhausted(), sb.status()); |
| 124 | EXPECT_EQ(Status::ResourceExhausted(), sb.last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 125 | |
| 126 | sb.resize(1029); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 127 | EXPECT_EQ(Status::OutOfRange(), sb.status()); |
| 128 | EXPECT_EQ(Status::OutOfRange(), sb.last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 129 | |
| 130 | sb << ""; |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 131 | EXPECT_EQ(Status::OutOfRange(), sb.status()); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 132 | EXPECT_EQ(OkStatus(), sb.last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 133 | } |
| 134 | |
| 135 | TEST(StringBuilder, Status_ClearStatus_SetsStatuesToOk) { |
| 136 | StringBuffer<2> sb = MakeString<2>("Won't fit!!!!!"); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 137 | EXPECT_EQ(Status::ResourceExhausted(), sb.status()); |
| 138 | EXPECT_EQ(Status::ResourceExhausted(), sb.last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 139 | |
| 140 | sb.clear_status(); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 141 | EXPECT_EQ(OkStatus(), sb.status()); |
| 142 | EXPECT_EQ(OkStatus(), sb.last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 143 | } |
| 144 | |
| 145 | TEST(StringBuilder, StreamOutput_OutputSelf) { |
| 146 | auto sb = MakeString<32>("echo!"); |
| 147 | sb << sb; |
| 148 | |
| 149 | EXPECT_STREQ("echo!echo!", sb.data()); |
| 150 | EXPECT_EQ(10u, sb.size()); |
| 151 | } |
| 152 | |
| 153 | TEST(StringBuilder, PushBack) { |
| 154 | StringBuffer<12> sb; |
| 155 | sb.push_back('?'); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 156 | EXPECT_EQ(OkStatus(), sb.last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 157 | EXPECT_EQ(1u, sb.size()); |
| 158 | EXPECT_STREQ("?", sb.data()); |
| 159 | } |
| 160 | |
| 161 | TEST(StringBuilder, PushBack_Full) { |
| 162 | StringBuffer<1> sb; |
| 163 | sb.push_back('!'); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 164 | EXPECT_EQ(Status::ResourceExhausted(), sb.last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 165 | EXPECT_EQ(0u, sb.size()); |
| 166 | } |
| 167 | |
| 168 | TEST(StringBuilder, PopBack) { |
| 169 | auto sb = MakeString<12>("Welcome!"); |
| 170 | sb.pop_back(); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 171 | EXPECT_EQ(OkStatus(), sb.last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 172 | EXPECT_EQ(7u, sb.size()); |
| 173 | EXPECT_STREQ("Welcome", sb.data()); |
| 174 | } |
| 175 | |
| 176 | TEST(StringBuilder, PopBack_Empty) { |
| 177 | StringBuffer<12> sb; |
| 178 | sb.pop_back(); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 179 | EXPECT_EQ(Status::OutOfRange(), sb.last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 180 | EXPECT_EQ(0u, sb.size()); |
| 181 | } |
| 182 | |
| 183 | TEST(StringBuilder, Append_NonTerminatedString) { |
| 184 | static char bad_string[256]; |
| 185 | std::memset(bad_string, '?', sizeof(bad_string)); |
| 186 | |
| 187 | StringBuffer<6> sb; |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 188 | EXPECT_EQ(Status::ResourceExhausted(), sb.append(bad_string).last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 189 | EXPECT_STREQ("?????", sb.data()); |
| 190 | } |
| 191 | |
| 192 | TEST(StringBuilder, Append_Chars) { |
| 193 | StringBuffer<8> sb; |
| 194 | |
| 195 | EXPECT_TRUE(sb.append(7, '?').ok()); |
| 196 | EXPECT_STREQ("???????", sb.data()); |
| 197 | } |
| 198 | |
| 199 | TEST(StringBuilder, Append_Chars_Full) { |
| 200 | StringBuffer<8> sb; |
| 201 | |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 202 | EXPECT_EQ(Status::ResourceExhausted(), sb.append(8, '?').last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 203 | EXPECT_STREQ("???????", sb.data()); |
| 204 | } |
| 205 | |
Wyatt Hepler | e555900 | 2021-11-12 13:58:05 -0800 | [diff] [blame] | 206 | TEST(StringBuilder, Append_Chars_ToEmpty) { |
| 207 | StringBuilder sb(std::span<char>{}); |
| 208 | |
| 209 | EXPECT_EQ(Status::ResourceExhausted(), sb.append(1, '?').last_status()); |
| 210 | } |
| 211 | |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 212 | TEST(StringBuilder, Append_PartialCString) { |
| 213 | StringBuffer<12> sb; |
| 214 | EXPECT_TRUE(sb.append("123456", 4).ok()); |
| 215 | EXPECT_EQ(4u, sb.size()); |
| 216 | EXPECT_STREQ("1234", sb.data()); |
| 217 | } |
| 218 | |
| 219 | TEST(StringBuilder, Append_CString) { |
| 220 | auto sb = MakeString("hello"); |
| 221 | EXPECT_TRUE(sb.append(" goodbye").ok()); |
| 222 | EXPECT_STREQ("hello goodbye", sb.data()); |
| 223 | EXPECT_EQ(13u, sb.size()); |
| 224 | } |
| 225 | |
| 226 | TEST(StringBuilder, Append_CString_Full) { |
| 227 | auto sb = MakeString<6>("hello"); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 228 | EXPECT_EQ(Status::ResourceExhausted(), sb.append("890123", 1).last_status()); |
| 229 | EXPECT_EQ(Status::ResourceExhausted(), sb.status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 230 | EXPECT_EQ(sb.max_size(), sb.size()); |
| 231 | EXPECT_STREQ("hello", sb.data()); |
| 232 | } |
| 233 | |
| 234 | TEST(StringBuilder, Append_StringView) { |
| 235 | auto sb = MakeString<32>("hello"); |
| 236 | EXPECT_TRUE(sb.append("???"sv).ok()); |
| 237 | EXPECT_EQ("hello???"sv, sb); |
| 238 | } |
| 239 | |
| 240 | TEST(StringBuilder, Append_StringView_Substring) { |
| 241 | auto sb = MakeString<32>("I like "); |
| 242 | EXPECT_TRUE(sb.append("your shoes!!!"sv, 5, 5).ok()); |
| 243 | EXPECT_EQ("I like shoes"sv, sb); |
| 244 | } |
| 245 | |
| 246 | TEST(StringBuilder, Append_StringView_RemainingSubstring) { |
| 247 | auto sb = MakeString<32>("I like "); |
| 248 | EXPECT_TRUE(sb.append("your shoes!!!"sv, 5).ok()); |
| 249 | EXPECT_EQ("I like shoes!!!"sv, sb); |
| 250 | } |
| 251 | |
| 252 | TEST(StringBuilder, Resize_Smaller) { |
| 253 | auto sb = MakeString<12>("Four"); |
| 254 | sb.resize(2); |
| 255 | EXPECT_TRUE(sb.ok()); |
| 256 | EXPECT_EQ(2u, sb.size()); |
| 257 | EXPECT_STREQ("Fo", sb.data()); |
| 258 | } |
| 259 | |
| 260 | TEST(StringBuilder, Resize_Clear) { |
| 261 | auto sb = MakeString<12>("Four"); |
| 262 | sb.resize(0); |
| 263 | EXPECT_TRUE(sb.ok()); |
| 264 | EXPECT_EQ(0u, sb.size()); |
| 265 | EXPECT_STREQ("", sb.data()); |
| 266 | } |
| 267 | |
| 268 | TEST(StringBuilder, Resize_Larger_Fails) { |
| 269 | auto sb = MakeString<12>("Four"); |
| 270 | EXPECT_EQ(4u, sb.size()); |
| 271 | sb.resize(10); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 272 | EXPECT_EQ(sb.status(), Status::OutOfRange()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 273 | EXPECT_EQ(4u, sb.size()); |
| 274 | } |
| 275 | |
| 276 | TEST(StringBuilder, Resize_LargerThanCapacity_Fails) { |
| 277 | auto sb = MakeString<12>("Four"); |
| 278 | sb.resize(1234); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 279 | EXPECT_EQ(sb.status(), Status::OutOfRange()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 280 | EXPECT_EQ(4u, sb.size()); |
| 281 | EXPECT_STREQ("Four", sb.data()); |
| 282 | } |
| 283 | |
| 284 | TEST(StringBuilder, Format_Normal) { |
Armando Montanez | 0693c38 | 2020-08-05 14:56:44 -0700 | [diff] [blame] | 285 | std::byte buffer[64]; |
| 286 | StringBuilder sb(buffer); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 287 | EXPECT_TRUE(sb.Format("0x%x", 0xabc).ok()); |
| 288 | EXPECT_STREQ("0xabc", sb.data()); |
| 289 | |
| 290 | sb << "def"; |
| 291 | |
| 292 | EXPECT_TRUE(sb.Format("GHI").ok()); |
| 293 | EXPECT_STREQ("0xabcdefGHI", sb.data()); |
| 294 | } |
| 295 | |
| 296 | TEST(StringBuilder, Format_ExhaustBuffer) { |
| 297 | StringBuffer<6> sb; |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 298 | EXPECT_EQ(Status::ResourceExhausted(), sb.Format("012345").status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 299 | |
| 300 | EXPECT_STREQ("01234", sb.data()); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 301 | EXPECT_EQ(Status::ResourceExhausted(), sb.status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 302 | } |
| 303 | |
| 304 | TEST(StringBuilder, StreamOutput_MultipleTypes) { |
| 305 | constexpr const char* kExpected = "This is -1true example\n of this"; |
| 306 | constexpr const char* kExample = "example"; |
| 307 | |
| 308 | StringBuffer<64> sb; |
| 309 | sb << "This is " << -1 << true << ' ' << kExample << '\n' << " of this"; |
| 310 | |
| 311 | EXPECT_STREQ(kExpected, sb.data()); |
| 312 | EXPECT_EQ(std::strlen(kExpected), sb.size()); |
| 313 | } |
| 314 | |
| 315 | TEST(StringBuilder, StreamOutput_FullBufferIgnoresExtraStrings) { |
| 316 | StringBuffer<6> sb; |
| 317 | EXPECT_EQ(5u, sb.max_size()); // max_size() excludes the null terminator |
| 318 | |
| 319 | sb << 1 - 1; |
| 320 | EXPECT_TRUE(sb.ok()); |
| 321 | EXPECT_STREQ("0", sb.data()); |
| 322 | |
| 323 | sb << true << "Now it's way " << static_cast<unsigned char>(2) << " long"; |
| 324 | EXPECT_FALSE(sb.ok()); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 325 | EXPECT_EQ(Status::ResourceExhausted(), sb.status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 326 | EXPECT_STREQ("0true", sb.data()); |
| 327 | } |
| 328 | |
| 329 | TEST(StringBuilder, StreamOutput_ExhaustBuffer_InOneString) { |
| 330 | StringBuffer<9> sb; |
| 331 | EXPECT_EQ(8u, sb.max_size()); |
| 332 | |
| 333 | sb << "0123456789"; // write 10 chars |
| 334 | EXPECT_FALSE(sb.ok()); |
| 335 | EXPECT_STREQ("01234567", sb.data()); // only can fit 8 |
| 336 | EXPECT_EQ(8u, sb.size()); |
| 337 | |
| 338 | sb << "no" |
| 339 | << " more " |
| 340 | << "room" << '?'; |
| 341 | EXPECT_STREQ("01234567", sb.data()); |
| 342 | } |
| 343 | |
| 344 | TEST(StringBuilder, StreamOutput_ExhaustBuffer_InTwoStrings) { |
| 345 | StringBuffer<4> sb; |
| 346 | |
| 347 | sb << "01"; // fill 3/4 of buffer |
| 348 | EXPECT_EQ(2u, sb.size()); |
| 349 | sb << "234"; |
| 350 | EXPECT_STREQ("012", sb.data()); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 351 | EXPECT_EQ(Status::ResourceExhausted(), sb.status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 352 | EXPECT_EQ(3u, sb.size()); |
| 353 | } |
| 354 | |
| 355 | TEST(StringBuilder, StreamOutput_NonTerminatedString) { |
| 356 | static char bad_string[256]; |
| 357 | std::memset(bad_string, '?', sizeof(bad_string)); |
| 358 | |
| 359 | StringBuffer<6> sb; |
| 360 | sb << "hey" << bad_string; |
| 361 | |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 362 | EXPECT_EQ(Status::ResourceExhausted(), sb.status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 363 | EXPECT_STREQ("hey??", sb.data()); |
| 364 | } |
| 365 | |
| 366 | TEST(StringBuilder, SteamOutput_StringView) { |
| 367 | StringBuffer<6> buffer; |
| 368 | constexpr std::string_view hello("hello"); |
| 369 | |
| 370 | buffer << hello; |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 371 | EXPECT_EQ(OkStatus(), buffer.status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 372 | EXPECT_STREQ("hello", buffer.data()); |
| 373 | } |
| 374 | |
| 375 | TEST(StringBuilder, StreamOutput_EmptyStringView) { |
| 376 | StringBuffer<4> buffer; |
| 377 | buffer << "hi" << std::string_view() << "!"; |
| 378 | EXPECT_TRUE(buffer.ok()); |
| 379 | EXPECT_STREQ("hi!", buffer.data()); |
| 380 | } |
| 381 | |
Armando Montanez | 30c5d38 | 2021-11-29 12:26:09 -0800 | [diff] [blame] | 382 | TEST(StringBuilder, StreamOutput_ByteArray) { |
Armando Montanez | 1cbc49a | 2021-11-19 18:30:27 -0800 | [diff] [blame] | 383 | StringBuffer<7> buffer; |
| 384 | std::array<std::byte, 3> data{ |
| 385 | {std::byte(0xc8), std::byte(0x02), std::byte(0x41)}}; |
| 386 | buffer << data; |
| 387 | EXPECT_EQ(buffer.status(), OkStatus()); |
| 388 | EXPECT_STREQ("c80241", buffer.data()); |
| 389 | } |
| 390 | |
Armando Montanez | 30c5d38 | 2021-11-29 12:26:09 -0800 | [diff] [blame] | 391 | TEST(StringBuilder, StreamOutput_ByteSpan) { |
| 392 | StringBuffer<11> buffer; |
| 393 | std::array<std::byte, 5> data{{std::byte(0), |
| 394 | std::byte(0xc8), |
| 395 | std::byte(0x02), |
| 396 | std::byte(0x41), |
| 397 | std::byte(0xe0)}}; |
| 398 | buffer << std::as_bytes(std::span(data)); |
| 399 | EXPECT_EQ(buffer.status(), OkStatus()); |
| 400 | EXPECT_STREQ("00c80241e0", buffer.data()); |
| 401 | } |
| 402 | |
Armando Montanez | 1cbc49a | 2021-11-19 18:30:27 -0800 | [diff] [blame] | 403 | TEST(StringBuilder, StreamOutput_ByteSpanOutOfSpace) { |
| 404 | StringBuffer<4> buffer; |
| 405 | std::array<uint8_t, 3> data{{0xc8, 0x02, 0x41}}; |
Armando Montanez | 30c5d38 | 2021-11-29 12:26:09 -0800 | [diff] [blame] | 406 | buffer << std::as_bytes(std::span(data)); |
Armando Montanez | 1cbc49a | 2021-11-19 18:30:27 -0800 | [diff] [blame] | 407 | EXPECT_EQ(buffer.status(), Status::ResourceExhausted()); |
| 408 | EXPECT_STREQ("", buffer.data()); |
| 409 | } |
| 410 | |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 411 | TEST(StringBuffer, Assign) { |
| 412 | StringBuffer<10> one; |
| 413 | StringBuffer<10> two; |
| 414 | |
| 415 | one << "What"; |
| 416 | ASSERT_STREQ("What", one.data()); |
| 417 | two = one; |
| 418 | EXPECT_STREQ("What", two.data()); |
| 419 | EXPECT_NE(one.data(), two.data()); |
| 420 | one << " the"; |
| 421 | two << " heck"; |
| 422 | |
| 423 | EXPECT_STREQ("What the", one.data()); |
| 424 | EXPECT_STREQ("What heck", two.data()); |
| 425 | |
| 426 | two << "0123456789"; |
| 427 | ASSERT_STREQ("What heck", two.data()); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 428 | ASSERT_EQ(Status::ResourceExhausted(), two.status()); |
| 429 | ASSERT_EQ(Status::ResourceExhausted(), two.last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 430 | |
| 431 | one = two; |
| 432 | EXPECT_STREQ("What heck", one.data()); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 433 | EXPECT_EQ(Status::ResourceExhausted(), one.status()); |
| 434 | EXPECT_EQ(Status::ResourceExhausted(), one.last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 435 | |
| 436 | StringBuffer<12> three; |
| 437 | three = two; |
| 438 | EXPECT_STREQ(three.data(), two.data()); |
| 439 | EXPECT_EQ(three.size(), two.size()); |
| 440 | } |
| 441 | |
| 442 | TEST(StringBuffer, CopyConstructFromSameSize) { |
| 443 | StringBuffer<10> one; |
| 444 | |
| 445 | one << "What"; |
| 446 | ASSERT_STREQ("What", one.data()); |
| 447 | StringBuffer<10> two(one); |
| 448 | EXPECT_STREQ("What", two.data()); |
| 449 | EXPECT_NE(one.data(), two.data()); |
| 450 | one << " the"; |
| 451 | two << " heck"; |
| 452 | |
| 453 | EXPECT_STREQ("What the", one.data()); |
| 454 | EXPECT_STREQ("What heck", two.data()); |
| 455 | |
| 456 | two << "0123456789"; |
| 457 | two << ""; |
| 458 | ASSERT_STREQ("What heck", two.data()); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 459 | ASSERT_EQ(Status::ResourceExhausted(), two.status()); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 460 | ASSERT_EQ(OkStatus(), two.last_status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 461 | } |
| 462 | |
| 463 | TEST(StringBuffer, CopyConstructFromSmaller) { |
| 464 | StringBuffer<10> one = MakeString<10>("You are the chosen one."); |
| 465 | StringBuffer<12> two(one); |
| 466 | |
| 467 | EXPECT_STREQ("You are t", two.data()); |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 468 | EXPECT_EQ(Status::ResourceExhausted(), two.status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 469 | } |
| 470 | |
Wyatt Hepler | 6d1a6c6 | 2020-06-22 15:40:45 -0700 | [diff] [blame] | 471 | TEST(StringBuilder, Object) { |
| 472 | StringBuffer<64> sb; |
| 473 | sb << CustomType(); |
| 474 | |
| 475 | EXPECT_STREQ(CustomType::kToString, sb.data()); |
| 476 | EXPECT_EQ(std::strlen(CustomType::kToString), sb.size()); |
| 477 | } |
| 478 | |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 479 | TEST(MakeString, Object) { |
| 480 | CustomType custom; |
| 481 | const auto sb = MakeString<64>(custom); |
| 482 | |
| 483 | EXPECT_STREQ(CustomType::kToString, sb.data()); |
| 484 | EXPECT_EQ(std::strlen(CustomType::kToString), sb.size()); |
| 485 | } |
| 486 | |
| 487 | TEST(MakeString, IntegerTypes) { |
| 488 | EXPECT_STREQ("0123-4567", |
| 489 | MakeString(0ll, |
| 490 | 1u, |
| 491 | 2l, |
| 492 | 3, |
| 493 | -4, |
| 494 | static_cast<unsigned short>(5), |
| 495 | static_cast<short>(6), |
| 496 | static_cast<unsigned char>(7)) |
| 497 | .data()); |
| 498 | } |
| 499 | |
| 500 | TEST(MakeString, Char) { |
| 501 | EXPECT_STREQ("a b c", MakeString('a', ' ', 'b', ' ', 'c').data()); |
| 502 | } |
| 503 | |
| 504 | TEST(MakeString, Float) { EXPECT_STREQ("-inf", MakeString(-INFINITY).data()); } |
| 505 | |
| 506 | TEST(MakeString, Pointer_Null) { |
| 507 | EXPECT_STREQ("(null)", MakeString(nullptr).data()); |
| 508 | EXPECT_STREQ("(null)", MakeString(static_cast<void*>(nullptr)).data()); |
| 509 | } |
| 510 | |
| 511 | TEST(MakeString, Pointer_NonNull) { |
| 512 | EXPECT_STREQ("1", MakeString(reinterpret_cast<void*>(0x1)).data()); |
| 513 | EXPECT_STREQ("123", MakeString(reinterpret_cast<int*>(0x123)).data()); |
| 514 | } |
| 515 | |
| 516 | TEST(MakeString, Pointer_CustomType) { |
| 517 | char expected[32] = {}; |
| 518 | |
| 519 | CustomType custom; |
| 520 | std::snprintf(expected, |
| 521 | sizeof(expected), |
| 522 | "%" PRIxPTR, |
| 523 | reinterpret_cast<uintptr_t>(&custom)); |
| 524 | |
| 525 | EXPECT_STREQ(expected, MakeString(&custom).data()); |
| 526 | } |
| 527 | |
| 528 | TEST(MakeString, Bool) { |
| 529 | EXPECT_STREQ("true", MakeString(true).data()); |
| 530 | EXPECT_STREQ("false", MakeString(false).data()); |
| 531 | } |
| 532 | |
| 533 | TEST(MakeString, MutableString) { |
| 534 | char chars[] = {'C', 'o', 'o', 'l', '\0'}; |
| 535 | EXPECT_STREQ("Cool?", MakeString(chars, "?").data()); |
| 536 | } |
| 537 | |
| 538 | TEST(MakeString, Empty_IsEmpty) { EXPECT_TRUE(MakeString().empty()); } |
| 539 | |
| 540 | constexpr char kLongestString[] = "18446744073709551615"; // largest uint64_t |
| 541 | |
| 542 | TEST(MakeString, DefaultSizeString_FitsWholeString) { |
| 543 | EXPECT_STREQ( |
| 544 | kLongestString, |
| 545 | MakeString(184, "467", u'\x04', "40", '7', '3', '7', "0", "", 955ul, 1615) |
| 546 | .data()); |
| 547 | } |
| 548 | |
| 549 | TEST(MakeString, LargerThanDefaultSize_Truncates) { |
| 550 | auto sb = MakeString("1844674407", 3709551615, 123456); |
| 551 | |
Wyatt Hepler | d78f7c6 | 2020-09-28 14:27:32 -0700 | [diff] [blame] | 552 | EXPECT_EQ(Status::ResourceExhausted(), sb.status()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 553 | EXPECT_STREQ(kLongestString, sb.data()); |
| 554 | } |
| 555 | |
| 556 | TEST(MakeString, StringLiteral_ResizesToFitWholeLiteral) { |
| 557 | EXPECT_STREQ("", MakeString().data()); |
| 558 | |
Prashanth Swaminathan | 89dd053 | 2021-03-04 19:56:47 -0800 | [diff] [blame] | 559 | [[maybe_unused]] auto normal = MakeString(""); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 560 | static_assert(normal.max_size() == decltype(MakeString(1))::max_size()); |
Prashanth Swaminathan | 659a5c5 | 2021-02-05 21:11:47 -0800 | [diff] [blame] | 561 | EXPECT_EQ(normal.max_size(), decltype(MakeString(1))::max_size()); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 562 | |
Prashanth Swaminathan | 89dd053 | 2021-03-04 19:56:47 -0800 | [diff] [blame] | 563 | [[maybe_unused]] auto resized = |
| 564 | MakeString("This string is reeeeeeeeeaaaaallly long!!!!!"); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 565 | static_assert(resized.max_size() > decltype(MakeString(1))::max_size()); |
| 566 | static_assert(resized.max_size() == |
| 567 | sizeof("This string is reeeeeeeeeaaaaallly long!!!!!") - 1); |
Prashanth Swaminathan | 659a5c5 | 2021-02-05 21:11:47 -0800 | [diff] [blame] | 568 | EXPECT_GT(resized.max_size(), decltype(MakeString(1))::max_size()); |
| 569 | EXPECT_EQ(resized.max_size(), |
| 570 | sizeof("This string is reeeeeeeeeaaaaallly long!!!!!") - 1); |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 571 | } |
| 572 | |
| 573 | TEST(MakeString, StringLiteral_UsesLongerFixedSize) { |
| 574 | auto fixed_size = MakeString<64>(""); |
| 575 | static_assert(fixed_size.max_size() == 63u); |
| 576 | EXPECT_EQ(fixed_size.max_size(), 63u); |
| 577 | EXPECT_STREQ("", fixed_size.data()); |
| 578 | } |
| 579 | |
| 580 | TEST(MakeString, StringLiteral_TruncatesShorterFixedSize) { |
| 581 | EXPECT_STREQ("Goo", MakeString<4>("Google").data()); |
| 582 | EXPECT_STREQ("Google", MakeString<7>("Google").data()); |
| 583 | EXPECT_EQ(MakeString().max_size(), MakeString("Google").max_size()); |
| 584 | EXPECT_STREQ("Google", MakeString("Google").data()); |
| 585 | } |
| 586 | |
| 587 | TEST(MakeString, DefaultSize_FitsMaxAndMinInts) { |
| 588 | EXPECT_STREQ("-9223372036854775808", |
| 589 | MakeString(std::numeric_limits<int64_t>::min()).data()); |
| 590 | EXPECT_STREQ("18446744073709551615", |
| 591 | MakeString(std::numeric_limits<uint64_t>::max()).data()); |
| 592 | } |
| 593 | |
| 594 | TEST(MakeString, OutputToTemporaryStringBuffer) { |
| 595 | EXPECT_STREQ("hello", (MakeString<6>("hello ") << "world").data()); |
| 596 | EXPECT_STREQ("hello world", (MakeString("hello ") << "world").data()); |
| 597 | } |
| 598 | |
| 599 | // Test MakeString's default size calculations. |
| 600 | template <typename... Args> |
| 601 | constexpr size_t DefaultStringBufferSize(Args&&...) { |
| 602 | return string_internal::DefaultStringBufferSize<Args...>(); |
| 603 | } |
| 604 | |
| 605 | // Default sizes are rounded up to 24 bytes. |
| 606 | static_assert(DefaultStringBufferSize("") == 24); |
| 607 | static_assert(DefaultStringBufferSize("123") == 24); |
| 608 | static_assert(DefaultStringBufferSize("123", "456", "78901234567890") == 24); |
| 609 | static_assert(DefaultStringBufferSize("1234567890", "1234567890", "123") == 24); |
| 610 | static_assert(DefaultStringBufferSize(1234, 5678, 9012) == 24); |
| 611 | |
| 612 | // The buffer is sized to fix strings needing more than 24 bytes. |
| 613 | static_assert(DefaultStringBufferSize("1234567890", "1234567890", "1234") == |
| 614 | 25); |
| 615 | static_assert(DefaultStringBufferSize("1234567890", "1234567890", "12345") == |
| 616 | 26); |
| 617 | static_assert(DefaultStringBufferSize("1234567890", "1234567890", "12345678") == |
| 618 | 29); |
| 619 | |
| 620 | // Four bytes are allocated for each non-string argument. |
| 621 | static_assert(DefaultStringBufferSize(1234, 5678, 9012, 3456, 7890, 1234) == |
| 622 | 25); |
| 623 | static_assert(DefaultStringBufferSize('a', nullptr, 'b', 4, 5, 6, 7, 8) == 33); |
| 624 | |
Wyatt Hepler | 0435efe | 2021-03-01 14:00:36 -0800 | [diff] [blame] | 625 | struct SomeCustomType {}; |
| 626 | |
| 627 | StringBuilder& operator<<(StringBuilder& sb, const SomeCustomType&) { |
| 628 | return sb << "SomeCustomType was here!"; |
| 629 | } |
| 630 | |
| 631 | TEST(StringBuilder, ShiftOperatorOverload_SameNamsepace) { |
| 632 | pw::StringBuffer<48> buffer; |
| 633 | buffer << SomeCustomType{}; |
| 634 | |
| 635 | EXPECT_STREQ("SomeCustomType was here!", buffer.c_str()); |
| 636 | } |
| 637 | |
Wyatt Hepler | ce9b952 | 2019-11-11 10:45:48 -0800 | [diff] [blame] | 638 | } // namespace |
| 639 | } // namespace pw |
Wyatt Hepler | 0435efe | 2021-03-01 14:00:36 -0800 | [diff] [blame] | 640 | |
| 641 | namespace some_other_ns { |
| 642 | |
| 643 | struct MyCustomType { |
| 644 | int item; |
| 645 | }; |
| 646 | |
| 647 | pw::StringBuilder& operator<<(pw::StringBuilder& sb, |
| 648 | const MyCustomType& value) { |
| 649 | return sb << "MyCustomType(" << value.item << ')'; |
| 650 | } |
| 651 | |
| 652 | } // namespace some_other_ns |
| 653 | |
| 654 | namespace pw_test_namespace { |
| 655 | |
| 656 | TEST(StringBuilder, ShiftOperatorOverload_DifferentNamsepace) { |
| 657 | pw::StringBuffer<48> buffer; |
| 658 | buffer << "This is " << some_other_ns::MyCustomType{1138}; |
| 659 | |
| 660 | EXPECT_STREQ("This is MyCustomType(1138)", buffer.data()); |
| 661 | } |
| 662 | |
| 663 | } // namespace pw_test_namespace |