Skip to content

Commit 6aa03e6

Browse files
zetafunctioncopybara-github
zetafunction
authored and
copybara-github
committed
Print std::basic_string_view<Char> as a string literal
This is a followup to a previous change switching std::u8string, std::u16string, and std::u32string to print as string literals instead of an array of characters. Also update the PrintCharsAsStringTo<Char>() helper to handle cases where the pointer to the string data is null; unlike std::basic_string<Char>, std::basic_string_view<Char>'s data() is allowed to return nullptr. The new PrintTo overloads complicate the PrintTo(internal::StringView) overload, which needs to be disabled if internal::StringView is an alias for std::string_view to avoid multiple definitions with the same overload. Simply omitting the unconditional PrintTo(std::string_view) overload is a worse option though, as this results in std::string_view not printing nicely if internal::StringView is not an alias for std::string_view. PiperOrigin-RevId: 762020327 Change-Id: I92f5bdbacba89e97bbcc0fef3ca9261ea5a788d3
1 parent 16d4f8e commit 6aa03e6

File tree

3 files changed

+83
-28
lines changed

3 files changed

+83
-28
lines changed

‎googletest/include/gtest/gtest-printers.h‎

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@
111111
#include <ostream> // NOLINT
112112
#include <sstream>
113113
#include <string>
114+
#include <string_view>
114115
#include <tuple>
115116
#include <type_traits>
116117
#include <typeinfo>
@@ -248,8 +249,8 @@ struct StreamPrinter {
248249
// ADL (possibly involving implicit conversions).
249250
// (Use SFINAE via return type, because it seems GCC < 12 doesn't handle name
250251
// lookup properly when we do it in the template parameter list.)
251-
static auto PrintValue(const T& value,
252-
::std::ostream* os) -> decltype((void)(*os << value)) {
252+
static auto PrintValue(const T& value, ::std::ostream* os)
253+
-> decltype((void)(*os << value)) {
253254
// Call streaming operator found by ADL, possibly with implicit conversions
254255
// of the arguments.
255256
*os << value;
@@ -702,44 +703,63 @@ void PrintRawArrayTo(const T a[], size_t count, ::std::ostream* os) {
702703
}
703704
}
704705

705-
// Overloads for ::std::string.
706-
GTEST_API_ void PrintStringTo(const ::std::string& s, ::std::ostream* os);
706+
// Overloads for ::std::string and ::std::string_view
707+
GTEST_API_ void PrintStringTo(::std::string_view s, ::std::ostream* os);
707708
inline void PrintTo(const ::std::string& s, ::std::ostream* os) {
708709
PrintStringTo(s, os);
709710
}
711+
inline void PrintTo(::std::string_view s, ::std::ostream* os) {
712+
PrintStringTo(s, os);
713+
}
710714

711-
// Overloads for ::std::u8string
715+
// Overloads for ::std::u8string and ::std::u8string_view
712716
#ifdef __cpp_lib_char8_t
713-
GTEST_API_ void PrintU8StringTo(const ::std::u8string& s, ::std::ostream* os);
717+
GTEST_API_ void PrintU8StringTo(::std::u8string_view s, ::std::ostream* os);
714718
inline void PrintTo(const ::std::u8string& s, ::std::ostream* os) {
715719
PrintU8StringTo(s, os);
716720
}
721+
inline void PrintTo(::std::u8string_view s, ::std::ostream* os) {
722+
PrintU8StringTo(s, os);
723+
}
717724
#endif
718725

719-
// Overloads for ::std::u16string
720-
GTEST_API_ void PrintU16StringTo(const ::std::u16string& s, ::std::ostream* os);
726+
// Overloads for ::std::u16string and ::std::u16string_view
727+
GTEST_API_ void PrintU16StringTo(::std::u16string_view s, ::std::ostream* os);
721728
inline void PrintTo(const ::std::u16string& s, ::std::ostream* os) {
722729
PrintU16StringTo(s, os);
723730
}
731+
inline void PrintTo(::std::u16string_view s, ::std::ostream* os) {
732+
PrintU16StringTo(s, os);
733+
}
724734

725-
// Overloads for ::std::u32string
726-
GTEST_API_ void PrintU32StringTo(const ::std::u32string& s, ::std::ostream* os);
735+
// Overloads for ::std::u32string and ::std::u32string_view
736+
GTEST_API_ void PrintU32StringTo(::std::u32string_view s, ::std::ostream* os);
727737
inline void PrintTo(const ::std::u32string& s, ::std::ostream* os) {
728738
PrintU32StringTo(s, os);
729739
}
740+
inline void PrintTo(::std::u32string_view s, ::std::ostream* os) {
741+
PrintU32StringTo(s, os);
742+
}
730743

731-
// Overloads for ::std::wstring.
744+
// Overloads for ::std::wstring and ::std::wstring_view
732745
#if GTEST_HAS_STD_WSTRING
733-
GTEST_API_ void PrintWideStringTo(const ::std::wstring& s, ::std::ostream* os);
746+
GTEST_API_ void PrintWideStringTo(::std::wstring_view s, ::std::ostream* os);
734747
inline void PrintTo(const ::std::wstring& s, ::std::ostream* os) {
735748
PrintWideStringTo(s, os);
736749
}
750+
inline void PrintTo(::std::wstring_view s, ::std::ostream* os) {
751+
PrintWideStringTo(s, os);
752+
}
737753
#endif // GTEST_HAS_STD_WSTRING
738754

739755
#if GTEST_INTERNAL_HAS_STRING_VIEW
740-
// Overload for internal::StringView.
756+
// Overload for internal::StringView. Needed for build configurations where
757+
// internal::StringView is an alias for absl::string_view, but absl::string_view
758+
// is a distinct type from std::string_view.
759+
template <int&... ExplicitArgumentBarrier, typename T = internal::StringView,
760+
std::enable_if_t<!std::is_same_v<T, ::std::string_view>, int> = 0>
741761
inline void PrintTo(internal::StringView sp, ::std::ostream* os) {
742-
PrintTo(::std::string(sp), os);
762+
PrintStringTo(sp, os);
743763
}
744764
#endif // GTEST_INTERNAL_HAS_STRING_VIEW
745765

‎googletest/src/gtest-printers.cc‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
#include <iomanip>
5151
#include <ios>
5252
#include <ostream> // NOLINT
53-
#include <string>
53+
#include <string_view>
5454
#include <type_traits>
5555

5656
#include "gtest/internal/gtest-port.h"
@@ -333,14 +333,14 @@ void PrintTo(__int128_t v, ::std::ostream* os) {
333333

334334
// Prints the given array of characters to the ostream. CharType must be either
335335
// char, char8_t, char16_t, char32_t, or wchar_t.
336-
// The array starts at begin, the length is len, it may include '\0' characters
337-
// and may not be NUL-terminated.
336+
// The array starts at begin (which may be nullptr) and contains len characters.
337+
// The array may include '\0' characters and may not be NUL-terminated.
338338
template <typename CharType>
339339
GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_ GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_
340340
GTEST_ATTRIBUTE_NO_SANITIZE_HWADDRESS_
341341
GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_ static CharFormat
342342
PrintCharsAsStringTo(const CharType* begin, size_t len, ostream* os) {
343-
const char* const quote_prefix = GetCharWidthPrefix(*begin);
343+
const char* const quote_prefix = GetCharWidthPrefix(CharType());
344344
*os << quote_prefix << "\"";
345345
bool is_previous_hex = false;
346346
CharFormat print_format = kAsIs;
@@ -522,7 +522,7 @@ void ConditionalPrintAsText(const char* str, size_t length, ostream* os) {
522522

523523
} // anonymous namespace
524524

525-
void PrintStringTo(const ::std::string& s, ostream* os) {
525+
void PrintStringTo(::std::string_view s, ostream* os) {
526526
if (PrintCharsAsStringTo(s.data(), s.size(), os) == kHexEscape) {
527527
if (GTEST_FLAG_GET(print_utf8)) {
528528
ConditionalPrintAsText(s.data(), s.size(), os);
@@ -531,21 +531,21 @@ void PrintStringTo(const ::std::string& s, ostream* os) {
531531
}
532532

533533
#ifdef __cpp_lib_char8_t
534-
void PrintU8StringTo(const ::std::u8string& s, ostream* os) {
534+
void PrintU8StringTo(::std::u8string_view s, ostream* os) {
535535
PrintCharsAsStringTo(s.data(), s.size(), os);
536536
}
537537
#endif
538538

539-
void PrintU16StringTo(const ::std::u16string& s, ostream* os) {
539+
void PrintU16StringTo(::std::u16string_view s, ostream* os) {
540540
PrintCharsAsStringTo(s.data(), s.size(), os);
541541
}
542542

543-
void PrintU32StringTo(const ::std::u32string& s, ostream* os) {
543+
void PrintU32StringTo(::std::u32string_view s, ostream* os) {
544544
PrintCharsAsStringTo(s.data(), s.size(), os);
545545
}
546546

547547
#if GTEST_HAS_STD_WSTRING
548-
void PrintWideStringTo(const ::std::wstring& s, ostream* os) {
548+
void PrintWideStringTo(::std::wstring_view s, ostream* os) {
549549
PrintCharsAsStringTo(s.data(), s.size(), os);
550550
}
551551
#endif // GTEST_HAS_STD_WSTRING

‎googletest/test/googletest-printers-test.cc‎

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
#include <set>
4949
#include <sstream>
5050
#include <string>
51+
#include <string_view>
5152
#include <tuple>
5253
#include <unordered_map>
5354
#include <unordered_set>
@@ -65,7 +66,7 @@
6566

6667
#if GTEST_INTERNAL_HAS_STD_SPAN
6768
#include <span> // NOLINT
68-
#endif // GTEST_INTERNAL_HAS_STD_SPAN
69+
#endif // GTEST_INTERNAL_HAS_STD_SPAN
6970

7071
#if GTEST_INTERNAL_HAS_COMPARE_LIB
7172
#include <compare> // NOLINT
@@ -799,7 +800,7 @@ struct Foo {
799800
TEST(PrintPointerTest, MemberVariablePointer) {
800801
EXPECT_TRUE(HasPrefix(Print(&Foo::value),
801802
Print(sizeof(&Foo::value)) + "-byte object "));
802-
int Foo::*p = NULL; // NOLINT
803+
int Foo::* p = NULL; // NOLINT
803804
EXPECT_TRUE(HasPrefix(Print(p), Print(sizeof(p)) + "-byte object "));
804805
}
805806

@@ -926,7 +927,7 @@ TEST(PrintArrayTest, BigArray) {
926927
PrintArrayHelper(a));
927928
}
928929

929-
// Tests printing ::string and ::std::string.
930+
// Tests printing ::std::string and ::string_view.
930931

931932
// ::std::string.
932933
TEST(PrintStringTest, StringInStdNamespace) {
@@ -936,6 +937,13 @@ TEST(PrintStringTest, StringInStdNamespace) {
936937
Print(str));
937938
}
938939

940+
TEST(PrintStringTest, StringViewInStdNamespace) {
941+
const char s[] = "'\"?\\\a\b\f\n\0\r\t\v\x7F\xFF a";
942+
const ::std::string_view str(s, sizeof(s));
943+
EXPECT_EQ("\"'\\\"?\\\\\\a\\b\\f\\n\\0\\r\\t\\v\\x7F\\xFF a\\0\"",
944+
Print(str));
945+
}
946+
939947
TEST(PrintStringTest, StringAmbiguousHex) {
940948
// "\x6BANANA" is ambiguous, it can be interpreted as starting with either of:
941949
// '\x6', '\x6B', or '\x6BA'.
@@ -953,7 +961,7 @@ TEST(PrintStringTest, StringAmbiguousHex) {
953961
EXPECT_EQ("\"!\\x5-!\"", Print(::std::string("!\x5-!")));
954962
}
955963

956-
// Tests printing ::std::wstring.
964+
// Tests printing ::std::wstring and ::std::wstring_view.
957965
#if GTEST_HAS_STD_WSTRING
958966
// ::std::wstring.
959967
TEST(PrintWideStringTest, StringInStdNamespace) {
@@ -965,6 +973,15 @@ TEST(PrintWideStringTest, StringInStdNamespace) {
965973
Print(str));
966974
}
967975

976+
TEST(PrintWideStringTest, StringViewInStdNamespace) {
977+
const wchar_t s[] = L"'\"?\\\a\b\f\n\0\r\t\v\xD3\x576\x8D3\xC74D a";
978+
const ::std::wstring_view str(s, sizeof(s) / sizeof(wchar_t));
979+
EXPECT_EQ(
980+
"L\"'\\\"?\\\\\\a\\b\\f\\n\\0\\r\\t\\v"
981+
"\\xD3\\x576\\x8D3\\xC74D a\\0\"",
982+
Print(str));
983+
}
984+
968985
TEST(PrintWideStringTest, StringAmbiguousHex) {
969986
// same for wide strings.
970987
EXPECT_EQ("L\"0\\x12\" L\"3\"", Print(::std::wstring(L"0\x12"
@@ -983,6 +1000,12 @@ TEST(PrintStringTest, U8String) {
9831000
EXPECT_EQ(str, str); // Verify EXPECT_EQ compiles with this type.
9841001
EXPECT_EQ("u8\"Hello, \\xE4\\xB8\\x96\\xE7\\x95\\x8C\"", Print(str));
9851002
}
1003+
1004+
TEST(PrintStringTest, U8StringView) {
1005+
std::u8string_view str = u8"Hello, 世界";
1006+
EXPECT_EQ(str, str); // Verify EXPECT_EQ compiles with this type.
1007+
EXPECT_EQ("u8\"Hello, \\xE4\\xB8\\x96\\xE7\\x95\\x8C\"", Print(str));
1008+
}
9861009
#endif
9871010

9881011
TEST(PrintStringTest, U16String) {
@@ -991,12 +1014,24 @@ TEST(PrintStringTest, U16String) {
9911014
EXPECT_EQ("u\"Hello, \\x4E16\\x754C\"", Print(str));
9921015
}
9931016

1017+
TEST(PrintStringTest, U16StringView) {
1018+
std::u16string_view str = u"Hello, 世界";
1019+
EXPECT_EQ(str, str); // Verify EXPECT_EQ compiles with this type.
1020+
EXPECT_EQ("u\"Hello, \\x4E16\\x754C\"", Print(str));
1021+
}
1022+
9941023
TEST(PrintStringTest, U32String) {
9951024
std::u32string str = U"Hello, 🗺️";
9961025
EXPECT_EQ(str, str); // Verify EXPECT_EQ compiles with this type
9971026
EXPECT_EQ("U\"Hello, \\x1F5FA\\xFE0F\"", Print(str));
9981027
}
9991028

1029+
TEST(PrintStringTest, U32StringView) {
1030+
std::u32string_view str = U"Hello, 🗺️";
1031+
EXPECT_EQ(str, str); // Verify EXPECT_EQ compiles with this type
1032+
EXPECT_EQ("U\"Hello, \\x1F5FA\\xFE0F\"", Print(str));
1033+
}
1034+
10001035
// Tests printing types that support generic streaming (i.e. streaming
10011036
// to std::basic_ostream<Char, CharTraits> for any valid Char and
10021037
// CharTraits types).
@@ -1456,7 +1491,7 @@ TEST(PrintReferenceTest, HandlesMemberFunctionPointer) {
14561491
// Tests that the universal printer prints a member variable pointer
14571492
// passed by reference.
14581493
TEST(PrintReferenceTest, HandlesMemberVariablePointer) {
1459-
int Foo::*p = &Foo::value; // NOLINT
1494+
int Foo::* p = &Foo::value; // NOLINT
14601495
EXPECT_TRUE(HasPrefix(PrintByRef(p), "@" + PrintPointer(&p) + " " +
14611496
Print(sizeof(p)) + "-byte object "));
14621497
}

0 commit comments

Comments
 (0)
⚡