michael@0: // Copyright 2007, Google Inc.
michael@0: // All rights reserved.
michael@0: //
michael@0: // Redistribution and use in source and binary forms, with or without
michael@0: // modification, are permitted provided that the following conditions are
michael@0: // met:
michael@0: //
michael@0: //     * Redistributions of source code must retain the above copyright
michael@0: // notice, this list of conditions and the following disclaimer.
michael@0: //     * Redistributions in binary form must reproduce the above
michael@0: // copyright notice, this list of conditions and the following disclaimer
michael@0: // in the documentation and/or other materials provided with the
michael@0: // distribution.
michael@0: //     * Neither the name of Google Inc. nor the names of its
michael@0: // contributors may be used to endorse or promote products derived from
michael@0: // this software without specific prior written permission.
michael@0: //
michael@0: // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0: // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0: // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0: // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
michael@0: // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
michael@0: // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
michael@0: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
michael@0: // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
michael@0: // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
michael@0: // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
michael@0: // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0: //
michael@0: // Author: wan@google.com (Zhanyong Wan)
michael@0: 
michael@0: // Google Test - The Google C++ Testing Framework
michael@0: //
michael@0: // This file implements a universal value printer that can print a
michael@0: // value of any type T:
michael@0: //
michael@0: //   void ::testing::internal::UniversalPrinter<T>::Print(value, ostream_ptr);
michael@0: //
michael@0: // It uses the << operator when possible, and prints the bytes in the
michael@0: // object otherwise.  A user can override its behavior for a class
michael@0: // type Foo by defining either operator<<(::std::ostream&, const Foo&)
michael@0: // or void PrintTo(const Foo&, ::std::ostream*) in the namespace that
michael@0: // defines Foo.
michael@0: 
michael@0: #include "gtest/gtest-printers.h"
michael@0: #include <ctype.h>
michael@0: #include <stdio.h>
michael@0: #include <ostream>  // NOLINT
michael@0: #include <string>
michael@0: #include "gtest/internal/gtest-port.h"
michael@0: 
michael@0: namespace testing {
michael@0: 
michael@0: namespace {
michael@0: 
michael@0: using ::std::ostream;
michael@0: 
michael@0: // Prints a segment of bytes in the given object.
michael@0: void PrintByteSegmentInObjectTo(const unsigned char* obj_bytes, size_t start,
michael@0:                                 size_t count, ostream* os) {
michael@0:   char text[5] = "";
michael@0:   for (size_t i = 0; i != count; i++) {
michael@0:     const size_t j = start + i;
michael@0:     if (i != 0) {
michael@0:       // Organizes the bytes into groups of 2 for easy parsing by
michael@0:       // human.
michael@0:       if ((j % 2) == 0)
michael@0:         *os << ' ';
michael@0:       else
michael@0:         *os << '-';
michael@0:     }
michael@0:     GTEST_SNPRINTF_(text, sizeof(text), "%02X", obj_bytes[j]);
michael@0:     *os << text;
michael@0:   }
michael@0: }
michael@0: 
michael@0: // Prints the bytes in the given value to the given ostream.
michael@0: void PrintBytesInObjectToImpl(const unsigned char* obj_bytes, size_t count,
michael@0:                               ostream* os) {
michael@0:   // Tells the user how big the object is.
michael@0:   *os << count << "-byte object <";
michael@0: 
michael@0:   const size_t kThreshold = 132;
michael@0:   const size_t kChunkSize = 64;
michael@0:   // If the object size is bigger than kThreshold, we'll have to omit
michael@0:   // some details by printing only the first and the last kChunkSize
michael@0:   // bytes.
michael@0:   // TODO(wan): let the user control the threshold using a flag.
michael@0:   if (count < kThreshold) {
michael@0:     PrintByteSegmentInObjectTo(obj_bytes, 0, count, os);
michael@0:   } else {
michael@0:     PrintByteSegmentInObjectTo(obj_bytes, 0, kChunkSize, os);
michael@0:     *os << " ... ";
michael@0:     // Rounds up to 2-byte boundary.
michael@0:     const size_t resume_pos = (count - kChunkSize + 1)/2*2;
michael@0:     PrintByteSegmentInObjectTo(obj_bytes, resume_pos, count - resume_pos, os);
michael@0:   }
michael@0:   *os << ">";
michael@0: }
michael@0: 
michael@0: }  // namespace
michael@0: 
michael@0: namespace internal2 {
michael@0: 
michael@0: // Delegates to PrintBytesInObjectToImpl() to print the bytes in the
michael@0: // given object.  The delegation simplifies the implementation, which
michael@0: // uses the << operator and thus is easier done outside of the
michael@0: // ::testing::internal namespace, which contains a << operator that
michael@0: // sometimes conflicts with the one in STL.
michael@0: void PrintBytesInObjectTo(const unsigned char* obj_bytes, size_t count,
michael@0:                           ostream* os) {
michael@0:   PrintBytesInObjectToImpl(obj_bytes, count, os);
michael@0: }
michael@0: 
michael@0: }  // namespace internal2
michael@0: 
michael@0: namespace internal {
michael@0: 
michael@0: // Depending on the value of a char (or wchar_t), we print it in one
michael@0: // of three formats:
michael@0: //   - as is if it's a printable ASCII (e.g. 'a', '2', ' '),
michael@0: //   - as a hexidecimal escape sequence (e.g. '\x7F'), or
michael@0: //   - as a special escape sequence (e.g. '\r', '\n').
michael@0: enum CharFormat {
michael@0:   kAsIs,
michael@0:   kHexEscape,
michael@0:   kSpecialEscape
michael@0: };
michael@0: 
michael@0: // Returns true if c is a printable ASCII character.  We test the
michael@0: // value of c directly instead of calling isprint(), which is buggy on
michael@0: // Windows Mobile.
michael@0: inline bool IsPrintableAscii(wchar_t c) {
michael@0:   return 0x20 <= c && c <= 0x7E;
michael@0: }
michael@0: 
michael@0: // Prints a wide or narrow char c as a character literal without the
michael@0: // quotes, escaping it when necessary; returns how c was formatted.
michael@0: // The template argument UnsignedChar is the unsigned version of Char,
michael@0: // which is the type of c.
michael@0: template <typename UnsignedChar, typename Char>
michael@0: static CharFormat PrintAsCharLiteralTo(Char c, ostream* os) {
michael@0:   switch (static_cast<wchar_t>(c)) {
michael@0:     case L'\0':
michael@0:       *os << "\\0";
michael@0:       break;
michael@0:     case L'\'':
michael@0:       *os << "\\'";
michael@0:       break;
michael@0:     case L'\\':
michael@0:       *os << "\\\\";
michael@0:       break;
michael@0:     case L'\a':
michael@0:       *os << "\\a";
michael@0:       break;
michael@0:     case L'\b':
michael@0:       *os << "\\b";
michael@0:       break;
michael@0:     case L'\f':
michael@0:       *os << "\\f";
michael@0:       break;
michael@0:     case L'\n':
michael@0:       *os << "\\n";
michael@0:       break;
michael@0:     case L'\r':
michael@0:       *os << "\\r";
michael@0:       break;
michael@0:     case L'\t':
michael@0:       *os << "\\t";
michael@0:       break;
michael@0:     case L'\v':
michael@0:       *os << "\\v";
michael@0:       break;
michael@0:     default:
michael@0:       if (IsPrintableAscii(c)) {
michael@0:         *os << static_cast<char>(c);
michael@0:         return kAsIs;
michael@0:       } else {
michael@0:         *os << String::Format("\\x%X", static_cast<UnsignedChar>(c));
michael@0:         return kHexEscape;
michael@0:       }
michael@0:   }
michael@0:   return kSpecialEscape;
michael@0: }
michael@0: 
michael@0: // Prints a wchar_t c as if it's part of a string literal, escaping it when
michael@0: // necessary; returns how c was formatted.
michael@0: static CharFormat PrintAsStringLiteralTo(wchar_t c, ostream* os) {
michael@0:   switch (c) {
michael@0:     case L'\'':
michael@0:       *os << "'";
michael@0:       return kAsIs;
michael@0:     case L'"':
michael@0:       *os << "\\\"";
michael@0:       return kSpecialEscape;
michael@0:     default:
michael@0:       return PrintAsCharLiteralTo<wchar_t>(c, os);
michael@0:   }
michael@0: }
michael@0: 
michael@0: // Prints a char c as if it's part of a string literal, escaping it when
michael@0: // necessary; returns how c was formatted.
michael@0: static CharFormat PrintAsStringLiteralTo(char c, ostream* os) {
michael@0:   return PrintAsStringLiteralTo(
michael@0:       static_cast<wchar_t>(static_cast<unsigned char>(c)), os);
michael@0: }
michael@0: 
michael@0: // Prints a wide or narrow character c and its code.  '\0' is printed
michael@0: // as "'\\0'", other unprintable characters are also properly escaped
michael@0: // using the standard C++ escape sequence.  The template argument
michael@0: // UnsignedChar is the unsigned version of Char, which is the type of c.
michael@0: template <typename UnsignedChar, typename Char>
michael@0: void PrintCharAndCodeTo(Char c, ostream* os) {
michael@0:   // First, print c as a literal in the most readable form we can find.
michael@0:   *os << ((sizeof(c) > 1) ? "L'" : "'");
michael@0:   const CharFormat format = PrintAsCharLiteralTo<UnsignedChar>(c, os);
michael@0:   *os << "'";
michael@0: 
michael@0:   // To aid user debugging, we also print c's code in decimal, unless
michael@0:   // it's 0 (in which case c was printed as '\\0', making the code
michael@0:   // obvious).
michael@0:   if (c == 0)
michael@0:     return;
michael@0:   *os << " (" << String::Format("%d", c).c_str();
michael@0: 
michael@0:   // For more convenience, we print c's code again in hexidecimal,
michael@0:   // unless c was already printed in the form '\x##' or the code is in
michael@0:   // [1, 9].
michael@0:   if (format == kHexEscape || (1 <= c && c <= 9)) {
michael@0:     // Do nothing.
michael@0:   } else {
michael@0:     *os << String::Format(", 0x%X",
michael@0:                           static_cast<UnsignedChar>(c)).c_str();
michael@0:   }
michael@0:   *os << ")";
michael@0: }
michael@0: 
michael@0: void PrintTo(unsigned char c, ::std::ostream* os) {
michael@0:   PrintCharAndCodeTo<unsigned char>(c, os);
michael@0: }
michael@0: void PrintTo(signed char c, ::std::ostream* os) {
michael@0:   PrintCharAndCodeTo<unsigned char>(c, os);
michael@0: }
michael@0: 
michael@0: // Prints a wchar_t as a symbol if it is printable or as its internal
michael@0: // code otherwise and also as its code.  L'\0' is printed as "L'\\0'".
michael@0: void PrintTo(wchar_t wc, ostream* os) {
michael@0:   PrintCharAndCodeTo<wchar_t>(wc, os);
michael@0: }
michael@0: 
michael@0: // Prints the given array of characters to the ostream.  CharType must be either
michael@0: // char or wchar_t.
michael@0: // The array starts at begin, the length is len, it may include '\0' characters
michael@0: // and may not be NUL-terminated.
michael@0: template <typename CharType>
michael@0: static void PrintCharsAsStringTo(
michael@0:     const CharType* begin, size_t len, ostream* os) {
michael@0:   const char* const kQuoteBegin = sizeof(CharType) == 1 ? "\"" : "L\"";
michael@0:   *os << kQuoteBegin;
michael@0:   bool is_previous_hex = false;
michael@0:   for (size_t index = 0; index < len; ++index) {
michael@0:     const CharType cur = begin[index];
michael@0:     if (is_previous_hex && IsXDigit(cur)) {
michael@0:       // Previous character is of '\x..' form and this character can be
michael@0:       // interpreted as another hexadecimal digit in its number. Break string to
michael@0:       // disambiguate.
michael@0:       *os << "\" " << kQuoteBegin;
michael@0:     }
michael@0:     is_previous_hex = PrintAsStringLiteralTo(cur, os) == kHexEscape;
michael@0:   }
michael@0:   *os << "\"";
michael@0: }
michael@0: 
michael@0: // Prints a (const) char/wchar_t array of 'len' elements, starting at address
michael@0: // 'begin'.  CharType must be either char or wchar_t.
michael@0: template <typename CharType>
michael@0: static void UniversalPrintCharArray(
michael@0:     const CharType* begin, size_t len, ostream* os) {
michael@0:   // The code
michael@0:   //   const char kFoo[] = "foo";
michael@0:   // generates an array of 4, not 3, elements, with the last one being '\0'.
michael@0:   //
michael@0:   // Therefore when printing a char array, we don't print the last element if
michael@0:   // it's '\0', such that the output matches the string literal as it's
michael@0:   // written in the source code.
michael@0:   if (len > 0 && begin[len - 1] == '\0') {
michael@0:     PrintCharsAsStringTo(begin, len - 1, os);
michael@0:     return;
michael@0:   }
michael@0: 
michael@0:   // If, however, the last element in the array is not '\0', e.g.
michael@0:   //    const char kFoo[] = { 'f', 'o', 'o' };
michael@0:   // we must print the entire array.  We also print a message to indicate
michael@0:   // that the array is not NUL-terminated.
michael@0:   PrintCharsAsStringTo(begin, len, os);
michael@0:   *os << " (no terminating NUL)";
michael@0: }
michael@0: 
michael@0: // Prints a (const) char array of 'len' elements, starting at address 'begin'.
michael@0: void UniversalPrintArray(const char* begin, size_t len, ostream* os) {
michael@0:   UniversalPrintCharArray(begin, len, os);
michael@0: }
michael@0: 
michael@0: // Prints a (const) wchar_t array of 'len' elements, starting at address
michael@0: // 'begin'.
michael@0: void UniversalPrintArray(const wchar_t* begin, size_t len, ostream* os) {
michael@0:   UniversalPrintCharArray(begin, len, os);
michael@0: }
michael@0: 
michael@0: // Prints the given C string to the ostream.
michael@0: void PrintTo(const char* s, ostream* os) {
michael@0:   if (s == NULL) {
michael@0:     *os << "NULL";
michael@0:   } else {
michael@0:     *os << ImplicitCast_<const void*>(s) << " pointing to ";
michael@0:     PrintCharsAsStringTo(s, strlen(s), os);
michael@0:   }
michael@0: }
michael@0: 
michael@0: // MSVC compiler can be configured to define whar_t as a typedef
michael@0: // of unsigned short. Defining an overload for const wchar_t* in that case
michael@0: // would cause pointers to unsigned shorts be printed as wide strings,
michael@0: // possibly accessing more memory than intended and causing invalid
michael@0: // memory accesses. MSVC defines _NATIVE_WCHAR_T_DEFINED symbol when
michael@0: // wchar_t is implemented as a native type.
michael@0: #if !defined(_MSC_VER) || defined(_NATIVE_WCHAR_T_DEFINED)
michael@0: // Prints the given wide C string to the ostream.
michael@0: void PrintTo(const wchar_t* s, ostream* os) {
michael@0:   if (s == NULL) {
michael@0:     *os << "NULL";
michael@0:   } else {
michael@0:     *os << ImplicitCast_<const void*>(s) << " pointing to ";
michael@0:     PrintCharsAsStringTo(s, wcslen(s), os);
michael@0:   }
michael@0: }
michael@0: #endif  // wchar_t is native
michael@0: 
michael@0: // Prints a ::string object.
michael@0: #if GTEST_HAS_GLOBAL_STRING
michael@0: void PrintStringTo(const ::string& s, ostream* os) {
michael@0:   PrintCharsAsStringTo(s.data(), s.size(), os);
michael@0: }
michael@0: #endif  // GTEST_HAS_GLOBAL_STRING
michael@0: 
michael@0: void PrintStringTo(const ::std::string& s, ostream* os) {
michael@0:   PrintCharsAsStringTo(s.data(), s.size(), os);
michael@0: }
michael@0: 
michael@0: // Prints a ::wstring object.
michael@0: #if GTEST_HAS_GLOBAL_WSTRING
michael@0: void PrintWideStringTo(const ::wstring& s, ostream* os) {
michael@0:   PrintCharsAsStringTo(s.data(), s.size(), os);
michael@0: }
michael@0: #endif  // GTEST_HAS_GLOBAL_WSTRING
michael@0: 
michael@0: #if GTEST_HAS_STD_WSTRING
michael@0: void PrintWideStringTo(const ::std::wstring& s, ostream* os) {
michael@0:   PrintCharsAsStringTo(s.data(), s.size(), os);
michael@0: }
michael@0: #endif  // GTEST_HAS_STD_WSTRING
michael@0: 
michael@0: }  // namespace internal
michael@0: 
michael@0: }  // namespace testing