blob: bbe44c38128fe5ccd8a58f39b07dfa7f17cac7a0 [file] [log] [blame]
shiqiane35fdd92008-12-10 05:08:54 +00001// Copyright 2007, Google Inc.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8// * Redistributions of source code must retain the above copyright
9// notice, this list of conditions and the following disclaimer.
10// * Redistributions in binary form must reproduce the above
11// copyright notice, this list of conditions and the following disclaimer
12// in the documentation and/or other materials provided with the
13// distribution.
14// * Neither the name of Google Inc. nor the names of its
15// contributors may be used to endorse or promote products derived from
16// this software without specific prior written permission.
17//
18// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29//
30// Author: wan@google.com (Zhanyong Wan)
31
32// Google Mock - a framework for writing C++ mock classes.
33//
34// This file implements a universal value printer that can print a
35// value of any type T:
36//
37// void ::testing::internal::UniversalPrinter<T>::Print(value, ostream_ptr);
38//
zhanyong.wan7e571ef2009-03-31 18:26:29 +000039// A user can teach this function how to print a class type T by
40// defining either operator<<() or PrintTo() in the namespace that
41// defines T. More specifically, the FIRST defined function in the
42// following list will be used (assuming T is defined in namespace
43// foo):
44//
45// 1. foo::PrintTo(const T&, ostream*)
46// 2. operator<<(ostream&, const T&) defined in either foo or the
47// global namespace.
48//
49// If none of the above is defined, it will print the debug string of
50// the value if it is a protocol buffer, or print the raw bytes in the
51// value otherwise.
zhanyong.wan4a5330d2009-02-19 00:36:44 +000052//
53// To aid debugging: when T is a reference type, the address of the
54// value is also printed; when T is a (const) char pointer, both the
55// pointer value and the NUL-terminated string it points to are
shiqiane35fdd92008-12-10 05:08:54 +000056// printed.
57//
zhanyong.wance198ff2009-02-12 01:34:27 +000058// We also provide some convenient wrappers:
shiqiane35fdd92008-12-10 05:08:54 +000059//
zhanyong.wan4a5330d2009-02-19 00:36:44 +000060// // Prints a value as the given type to a string.
61// string ::testing::internal::UniversalPrinter<T>::PrintToString(value);
62//
63// // Prints a value tersely: for a reference type, the referenced
64// // value (but not the address) is printed; for a (const) char
65// // pointer, the NUL-terminated string (but not the pointer) is
66// // printed.
67// void ::testing::internal::UniversalTersePrint(const T& value, ostream*);
68//
69// // Prints the fields of a tuple tersely to a string vector, one
70// // element for each field.
71// std::vector<string> UniversalTersePrintTupleFieldsToStrings(
72// const Tuple& value);
shiqiane35fdd92008-12-10 05:08:54 +000073
74#ifndef GMOCK_INCLUDE_GMOCK_GMOCK_PRINTERS_H_
75#define GMOCK_INCLUDE_GMOCK_GMOCK_PRINTERS_H_
76
77#include <ostream> // NOLINT
zhanyong.wan4a5330d2009-02-19 00:36:44 +000078#include <sstream>
shiqiane35fdd92008-12-10 05:08:54 +000079#include <string>
80#include <utility>
zhanyong.wan4a5330d2009-02-19 00:36:44 +000081#include <vector>
shiqiane35fdd92008-12-10 05:08:54 +000082
83#include <gmock/internal/gmock-internal-utils.h>
84#include <gmock/internal/gmock-port.h>
85#include <gtest/gtest.h>
86
shiqiane35fdd92008-12-10 05:08:54 +000087namespace testing {
88
89// Definitions in the 'internal' and 'internal2' name spaces are
90// subject to change without notice. DO NOT USE THEM IN USER CODE!
91namespace internal2 {
92
93// Prints the given number of bytes in the given object to the given
94// ostream.
95void PrintBytesInObjectTo(const unsigned char* obj_bytes,
96 size_t count,
97 ::std::ostream* os);
98
99// TypeWithoutFormatter<T, kIsProto>::PrintValue(value, os) is called
100// by the universal printer to print a value of type T when neither
101// operator<< nor PrintTo() is defined for type T. When T is
102// ProtocolMessage, proto2::Message, or a subclass of those, kIsProto
103// will be true and the short debug string of the protocol message
104// value will be printed; otherwise kIsProto will be false and the
105// bytes in the value will be printed.
106template <typename T, bool kIsProto>
107class TypeWithoutFormatter {
108 public:
109 static void PrintValue(const T& value, ::std::ostream* os) {
110 PrintBytesInObjectTo(reinterpret_cast<const unsigned char*>(&value),
111 sizeof(value), os);
112 }
113};
114template <typename T>
115class TypeWithoutFormatter<T, true> {
116 public:
117 static void PrintValue(const T& value, ::std::ostream* os) {
118 // Both ProtocolMessage and proto2::Message have the
119 // ShortDebugString() method, so the same implementation works for
120 // both.
121 ::std::operator<<(*os, "<" + value.ShortDebugString() + ">");
122 }
123};
124
125// Prints the given value to the given ostream. If the value is a
126// protocol message, its short debug string is printed; otherwise the
127// bytes in the value are printed. This is what
128// UniversalPrinter<T>::Print() does when it knows nothing about type
129// T and T has no << operator.
130//
131// A user can override this behavior for a class type Foo by defining
132// a << operator in the namespace where Foo is defined.
133//
134// We put this operator in namespace 'internal2' instead of 'internal'
135// to simplify the implementation, as much code in 'internal' needs to
136// use << in STL, which would conflict with our own << were it defined
137// in 'internal'.
zhanyong.wan2f0849f2009-02-11 18:06:37 +0000138//
139// Note that this operator<< takes a generic std::basic_ostream<Char,
140// CharTraits> type instead of the more restricted std::ostream. If
141// we define it to take an std::ostream instead, we'll get an
142// "ambiguous overloads" compiler error when trying to print a type
143// Foo that supports streaming to std::basic_ostream<Char,
144// CharTraits>, as the compiler cannot tell whether
145// operator<<(std::ostream&, const T&) or
146// operator<<(std::basic_stream<Char, CharTraits>, const Foo&) is more
147// specific.
148template <typename Char, typename CharTraits, typename T>
149::std::basic_ostream<Char, CharTraits>& operator<<(
150 ::std::basic_ostream<Char, CharTraits>& os, const T& x) {
shiqiane35fdd92008-12-10 05:08:54 +0000151 TypeWithoutFormatter<T, ::testing::internal::IsAProtocolMessage<T>::value>::
152 PrintValue(x, &os);
153 return os;
154}
155
156} // namespace internal2
zhanyong.wan7e571ef2009-03-31 18:26:29 +0000157} // namespace testing
shiqiane35fdd92008-12-10 05:08:54 +0000158
zhanyong.wan7e571ef2009-03-31 18:26:29 +0000159// This namespace MUST NOT BE NESTED IN ::testing, or the name look-up
160// magic needed for implementing UniversalPrinter won't work.
161namespace testing_internal {
162
163// Used to print a value that is not an STL-style container when the
164// user doesn't define PrintTo() for it.
165template <typename T>
166void DefaultPrintNonContainerTo(const T& value, ::std::ostream* os) {
167 // With the following statement, during unqualified name lookup,
168 // testing::internal2::operator<< appears as if it was declared in
169 // the nearest enclosing namespace that contains both
170 // ::testing_internal and ::testing::internal2, i.e. the global
171 // namespace. For more details, refer to the C++ Standard section
172 // 7.3.4-1 [namespace.udir]. This allows us to fall back onto
173 // testing::internal2::operator<< in case T doesn't come with a <<
174 // operator.
175 //
176 // We cannot write 'using ::testing::internal2::operator<<;', which
177 // gcc 3.3 fails to compile due to a compiler bug.
178 using namespace ::testing::internal2; // NOLINT
179
180 // Assuming T is defined in namespace foo, in the next statement,
181 // the compiler will consider all of:
182 //
183 // 1. foo::operator<< (thanks to Koenig look-up),
184 // 2. ::operator<< (as the current namespace is enclosed in ::),
185 // 3. testing::internal2::operator<< (thanks to the using statement above).
186 //
187 // The operator<< whose type matches T best will be picked.
188 //
189 // We deliberately allow #2 to be a candidate, as sometimes it's
190 // impossible to define #1 (e.g. when foo is ::std, defining
191 // anything in it is undefined behavior unless you are a compiler
192 // vendor.).
193 *os << value;
194}
195
196} // namespace testing_internal
197
198namespace testing {
shiqiane35fdd92008-12-10 05:08:54 +0000199namespace internal {
200
201// UniversalPrinter<T>::Print(value, ostream_ptr) prints the given
202// value to the given ostream. The caller must ensure that
203// 'ostream_ptr' is not NULL, or the behavior is undefined.
204//
205// We define UniversalPrinter as a class template (as opposed to a
206// function template), as we need to partially specialize it for
207// reference types, which cannot be done with function templates.
208template <typename T>
209class UniversalPrinter;
210
211// Used to print an STL-style container when the user doesn't define
212// a PrintTo() for it.
213template <typename C>
214void DefaultPrintTo(IsContainer, const C& container, ::std::ostream* os) {
215 const size_t kMaxCount = 32; // The maximum number of elements to print.
216 *os << '{';
217 size_t count = 0;
218 for (typename C::const_iterator it = container.begin();
219 it != container.end(); ++it, ++count) {
220 if (count > 0) {
221 *os << ',';
222 if (count == kMaxCount) { // Enough has been printed.
223 *os << " ...";
224 break;
225 }
226 }
227 *os << ' ';
228 PrintTo(*it, os);
229 }
230
231 if (count > 0) {
232 *os << ' ';
233 }
234 *os << '}';
235}
236
237// Used to print a value when the user doesn't define PrintTo() for it.
238template <typename T>
239void DefaultPrintTo(IsNotContainer, const T& value, ::std::ostream* os) {
zhanyong.wan7e571ef2009-03-31 18:26:29 +0000240 ::testing_internal::DefaultPrintNonContainerTo(value, os);
shiqiane35fdd92008-12-10 05:08:54 +0000241}
242
243// Prints the given value using the << operator if it has one;
244// otherwise prints the bytes in it. This is what
245// UniversalPrinter<T>::Print() does when PrintTo() is not specialized
246// or overloaded for type T.
247//
248// A user can override this behavior for a class type Foo by defining
249// an overload of PrintTo() in the namespace where Foo is defined. We
250// give the user this option as sometimes defining a << operator for
251// Foo is not desirable (e.g. the coding style may prevent doing it,
252// or there is already a << operator but it doesn't do what the user
253// wants).
254template <typename T>
255void PrintTo(const T& value, ::std::ostream* os) {
256 // DefaultPrintTo() is overloaded. The type of its first argument
257 // determines which version will be picked. If T is an STL-style
258 // container, the version for container will be called. Otherwise
259 // the generic version will be called.
260 //
261 // Note that we check for container types here, prior to we check
262 // for protocol message types in our operator<<. The rationale is:
263 //
264 // For protocol messages, we want to give people a chance to
265 // override Google Mock's format by defining a PrintTo() or
zhanyong.wan18490652009-05-11 18:54:08 +0000266 // operator<<. For STL containers, other formats can be
267 // incompatible with Google Mock's format for the container
268 // elements; therefore we check for container types here to ensure
269 // that our format is used.
shiqiane35fdd92008-12-10 05:08:54 +0000270 DefaultPrintTo(IsContainerTest<T>(0), value, os);
271}
272
273// The following list of PrintTo() overloads tells
274// UniversalPrinter<T>::Print() how to print standard types (built-in
275// types, strings, plain arrays, and pointers).
276
277// Overloads for various char types.
278void PrintCharTo(char c, int char_code, ::std::ostream* os);
279inline void PrintTo(unsigned char c, ::std::ostream* os) {
280 PrintCharTo(c, c, os);
281}
282inline void PrintTo(signed char c, ::std::ostream* os) {
283 PrintCharTo(c, c, os);
284}
285inline void PrintTo(char c, ::std::ostream* os) {
286 // When printing a plain char, we always treat it as unsigned. This
287 // way, the output won't be affected by whether the compiler thinks
288 // char is signed or not.
289 PrintTo(static_cast<unsigned char>(c), os);
290}
291
292// Overloads for other simple built-in types.
293inline void PrintTo(bool x, ::std::ostream* os) {
294 *os << (x ? "true" : "false");
295}
296
297// Overload for wchar_t type.
298// Prints a wchar_t as a symbol if it is printable or as its internal
299// code otherwise and also as its decimal code (except for L'\0').
300// The L'\0' char is printed as "L'\\0'". The decimal code is printed
301// as signed integer when wchar_t is implemented by the compiler
302// as a signed type and is printed as an unsigned integer when wchar_t
303// is implemented as an unsigned type.
304void PrintTo(wchar_t wc, ::std::ostream* os);
305
306// Overloads for C strings.
307void PrintTo(const char* s, ::std::ostream* os);
308inline void PrintTo(char* s, ::std::ostream* os) {
309 PrintTo(implicit_cast<const char*>(s), os);
310}
311
312// MSVC compiler can be configured to define whar_t as a typedef
313// of unsigned short. Defining an overload for const wchar_t* in that case
314// would cause pointers to unsigned shorts be printed as wide strings,
315// possibly accessing more memory than intended and causing invalid
316// memory accesses. MSVC defines _NATIVE_WCHAR_T_DEFINED symbol when
317// wchar_t is implemented as a native type.
318#if !defined(_MSC_VER) || defined(_NATIVE_WCHAR_T_DEFINED)
319// Overloads for wide C strings
320void PrintTo(const wchar_t* s, ::std::ostream* os);
321inline void PrintTo(wchar_t* s, ::std::ostream* os) {
322 PrintTo(implicit_cast<const wchar_t*>(s), os);
323}
324#endif
325
326// Overload for pointers that are neither char pointers nor member
327// pointers. (A member variable pointer or member function pointer
328// doesn't really points to a location in the address space. Their
329// representation is implementation-defined. Therefore they will be
330// printed as raw bytes.)
331template <typename T>
332void PrintTo(T* p, ::std::ostream* os) {
333 if (p == NULL) {
334 *os << "NULL";
335 } else {
336 // We cannot use implicit_cast or static_cast here, as they don't
337 // work when p is a function pointer.
338 *os << reinterpret_cast<const void*>(p);
339 }
340}
341
342// Overload for C arrays. Multi-dimensional arrays are printed
343// properly.
344
345// Prints the given number of elements in an array, without printing
346// the curly braces.
347template <typename T>
348void PrintRawArrayTo(const T a[], size_t count, ::std::ostream* os) {
349 UniversalPrinter<T>::Print(a[0], os);
350 for (size_t i = 1; i != count; i++) {
351 *os << ", ";
352 UniversalPrinter<T>::Print(a[i], os);
353 }
354}
355
356// Overloads for ::string and ::std::string.
357#if GTEST_HAS_GLOBAL_STRING
358void PrintStringTo(const ::string&s, ::std::ostream* os);
359inline void PrintTo(const ::string& s, ::std::ostream* os) {
360 PrintStringTo(s, os);
361}
362#endif // GTEST_HAS_GLOBAL_STRING
363
364#if GTEST_HAS_STD_STRING
365void PrintStringTo(const ::std::string&s, ::std::ostream* os);
366inline void PrintTo(const ::std::string& s, ::std::ostream* os) {
367 PrintStringTo(s, os);
368}
369#endif // GTEST_HAS_STD_STRING
370
371// Overloads for ::wstring and ::std::wstring.
372#if GTEST_HAS_GLOBAL_WSTRING
373void PrintWideStringTo(const ::wstring&s, ::std::ostream* os);
374inline void PrintTo(const ::wstring& s, ::std::ostream* os) {
375 PrintWideStringTo(s, os);
376}
377#endif // GTEST_HAS_GLOBAL_WSTRING
378
379#if GTEST_HAS_STD_WSTRING
380void PrintWideStringTo(const ::std::wstring&s, ::std::ostream* os);
381inline void PrintTo(const ::std::wstring& s, ::std::ostream* os) {
382 PrintWideStringTo(s, os);
383}
384#endif // GTEST_HAS_STD_WSTRING
385
386// Overload for ::std::tr1::tuple. Needed for printing function
387// arguments, which are packed as tuples.
388
zhanyong.wan4a5330d2009-02-19 00:36:44 +0000389typedef ::std::vector<string> Strings;
390
391// This helper template allows PrintTo() for tuples and
392// UniversalTersePrintTupleFieldsToStrings() to be defined by
shiqiane35fdd92008-12-10 05:08:54 +0000393// induction on the number of tuple fields. The idea is that
394// TuplePrefixPrinter<N>::PrintPrefixTo(t, os) prints the first N
395// fields in tuple t, and can be defined in terms of
396// TuplePrefixPrinter<N - 1>.
zhanyong.wan4a5330d2009-02-19 00:36:44 +0000397
398// The inductive case.
shiqiane35fdd92008-12-10 05:08:54 +0000399template <size_t N>
400struct TuplePrefixPrinter {
zhanyong.wan4a5330d2009-02-19 00:36:44 +0000401 // Prints the first N fields of a tuple.
shiqiane35fdd92008-12-10 05:08:54 +0000402 template <typename Tuple>
403 static void PrintPrefixTo(const Tuple& t, ::std::ostream* os) {
404 TuplePrefixPrinter<N - 1>::PrintPrefixTo(t, os);
405 *os << ", ";
406 UniversalPrinter<typename ::std::tr1::tuple_element<N - 1, Tuple>::type>
407 ::Print(::std::tr1::get<N - 1>(t), os);
408 }
zhanyong.wan4a5330d2009-02-19 00:36:44 +0000409
410 // Tersely prints the first N fields of a tuple to a string vector,
411 // one element for each field.
412 template <typename Tuple>
413 static void TersePrintPrefixToStrings(const Tuple& t, Strings* strings) {
414 TuplePrefixPrinter<N - 1>::TersePrintPrefixToStrings(t, strings);
415 ::std::stringstream ss;
416 UniversalTersePrint(::std::tr1::get<N - 1>(t), &ss);
417 strings->push_back(ss.str());
418 }
shiqiane35fdd92008-12-10 05:08:54 +0000419};
zhanyong.wan4a5330d2009-02-19 00:36:44 +0000420
421// Base cases.
shiqiane35fdd92008-12-10 05:08:54 +0000422template <>
423struct TuplePrefixPrinter<0> {
424 template <typename Tuple>
425 static void PrintPrefixTo(const Tuple&, ::std::ostream*) {}
zhanyong.wan4a5330d2009-02-19 00:36:44 +0000426
427 template <typename Tuple>
428 static void TersePrintPrefixToStrings(const Tuple&, Strings*) {}
shiqiane35fdd92008-12-10 05:08:54 +0000429};
430template <>
zhanyong.wan4a5330d2009-02-19 00:36:44 +0000431template <typename Tuple>
432void TuplePrefixPrinter<1>::PrintPrefixTo(const Tuple& t, ::std::ostream* os) {
433 UniversalPrinter<typename ::std::tr1::tuple_element<0, Tuple>::type>::
434 Print(::std::tr1::get<0>(t), os);
435}
shiqiane35fdd92008-12-10 05:08:54 +0000436
shiqianc97f2f52008-12-11 17:22:59 +0000437// Helper function for printing a tuple. T must be instantiated with
438// a tuple type.
439template <typename T>
440void PrintTupleTo(const T& t, ::std::ostream* os) {
441 *os << "(";
442 TuplePrefixPrinter< ::std::tr1::tuple_size<T>::value>::
443 PrintPrefixTo(t, os);
444 *os << ")";
445}
446
447// Overloaded PrintTo() for tuples of various arities. We support
448// tuples of up-to 10 fields. The following implementation works
449// regardless of whether tr1::tuple is implemented using the
450// non-standard variadic template feature or not.
451
452inline void PrintTo(const ::std::tr1::tuple<>& t, ::std::ostream* os) {
453 PrintTupleTo(t, os);
454}
455
456template <typename T1>
457void PrintTo(const ::std::tr1::tuple<T1>& t, ::std::ostream* os) {
458 PrintTupleTo(t, os);
459}
460
461template <typename T1, typename T2>
462void PrintTo(const ::std::tr1::tuple<T1, T2>& t, ::std::ostream* os) {
463 PrintTupleTo(t, os);
464}
465
466template <typename T1, typename T2, typename T3>
467void PrintTo(const ::std::tr1::tuple<T1, T2, T3>& t, ::std::ostream* os) {
468 PrintTupleTo(t, os);
469}
470
471template <typename T1, typename T2, typename T3, typename T4>
472void PrintTo(const ::std::tr1::tuple<T1, T2, T3, T4>& t, ::std::ostream* os) {
473 PrintTupleTo(t, os);
474}
475
476template <typename T1, typename T2, typename T3, typename T4, typename T5>
477void PrintTo(const ::std::tr1::tuple<T1, T2, T3, T4, T5>& t,
478 ::std::ostream* os) {
479 PrintTupleTo(t, os);
480}
481
482template <typename T1, typename T2, typename T3, typename T4, typename T5,
483 typename T6>
484void PrintTo(const ::std::tr1::tuple<T1, T2, T3, T4, T5, T6>& t,
485 ::std::ostream* os) {
486 PrintTupleTo(t, os);
487}
488
489template <typename T1, typename T2, typename T3, typename T4, typename T5,
490 typename T6, typename T7>
491void PrintTo(const ::std::tr1::tuple<T1, T2, T3, T4, T5, T6, T7>& t,
492 ::std::ostream* os) {
493 PrintTupleTo(t, os);
494}
495
496template <typename T1, typename T2, typename T3, typename T4, typename T5,
497 typename T6, typename T7, typename T8>
498void PrintTo(const ::std::tr1::tuple<T1, T2, T3, T4, T5, T6, T7, T8>& t,
499 ::std::ostream* os) {
500 PrintTupleTo(t, os);
501}
502
503template <typename T1, typename T2, typename T3, typename T4, typename T5,
504 typename T6, typename T7, typename T8, typename T9>
505void PrintTo(const ::std::tr1::tuple<T1, T2, T3, T4, T5, T6, T7, T8, T9>& t,
506 ::std::ostream* os) {
507 PrintTupleTo(t, os);
508}
509
shiqiane35fdd92008-12-10 05:08:54 +0000510template <typename T1, typename T2, typename T3, typename T4, typename T5,
511 typename T6, typename T7, typename T8, typename T9, typename T10>
512void PrintTo(
513 const ::std::tr1::tuple<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>& t,
514 ::std::ostream* os) {
shiqianc97f2f52008-12-11 17:22:59 +0000515 PrintTupleTo(t, os);
shiqiane35fdd92008-12-10 05:08:54 +0000516}
517
518// Overload for std::pair.
519template <typename T1, typename T2>
520void PrintTo(const ::std::pair<T1, T2>& value, ::std::ostream* os) {
521 *os << '(';
522 UniversalPrinter<T1>::Print(value.first, os);
523 *os << ", ";
524 UniversalPrinter<T2>::Print(value.second, os);
525 *os << ')';
526}
527
528// Implements printing a non-reference type T by letting the compiler
529// pick the right overload of PrintTo() for T.
530template <typename T>
531class UniversalPrinter {
532 public:
533 // MSVC warns about adding const to a function type, so we want to
534 // disable the warning.
535#ifdef _MSC_VER
536#pragma warning(push) // Saves the current warning state.
537#pragma warning(disable:4180) // Temporarily disables warning 4180.
538#endif // _MSC_VER
539
540 // Note: we deliberately don't call this PrintTo(), as that name
541 // conflicts with ::testing::internal::PrintTo in the body of the
542 // function.
543 static void Print(const T& value, ::std::ostream* os) {
544 // By default, ::testing::internal::PrintTo() is used for printing
545 // the value.
546 //
547 // Thanks to Koenig look-up, if T is a class and has its own
548 // PrintTo() function defined in its namespace, that function will
549 // be visible here. Since it is more specific than the generic ones
550 // in ::testing::internal, it will be picked by the compiler in the
551 // following statement - exactly what we want.
552 PrintTo(value, os);
553 }
554
555 // A convenient wrapper for Print() that returns the print-out as a
556 // string.
zhanyong.wan4a5330d2009-02-19 00:36:44 +0000557 static string PrintToString(const T& value) {
shiqiane35fdd92008-12-10 05:08:54 +0000558 ::std::stringstream ss;
559 Print(value, &ss);
560 return ss.str();
561 }
562
563#ifdef _MSC_VER
564#pragma warning(pop) // Restores the warning state.
565#endif // _MSC_VER
566};
567
568// Implements printing an array type T[N].
569template <typename T, size_t N>
570class UniversalPrinter<T[N]> {
571 public:
572 // Prints the given array, omitting some elements when there are too
573 // many.
574 static void Print(const T (&a)[N], ::std::ostream* os) {
575 // Prints a char array as a C string. Note that we compare 'const
576 // T' with 'const char' instead of comparing T with char, in case
577 // that T is already a const type.
578 if (internal::type_equals<const T, const char>::value) {
579 UniversalPrinter<const T*>::Print(a, os);
580 return;
581 }
582
583 if (N == 0) {
584 *os << "{}";
585 } else {
586 *os << "{ ";
587 const size_t kThreshold = 18;
588 const size_t kChunkSize = 8;
589 // If the array has more than kThreshold elements, we'll have to
590 // omit some details by printing only the first and the last
591 // kChunkSize elements.
592 // TODO(wan): let the user control the threshold using a flag.
593 if (N <= kThreshold) {
594 PrintRawArrayTo(a, N, os);
595 } else {
596 PrintRawArrayTo(a, kChunkSize, os);
597 *os << ", ..., ";
598 PrintRawArrayTo(a + N - kChunkSize, kChunkSize, os);
599 }
600 *os << " }";
601 }
602 }
603
604 // A convenient wrapper for Print() that returns the print-out as a
605 // string.
zhanyong.wan4a5330d2009-02-19 00:36:44 +0000606 static string PrintToString(const T (&a)[N]) {
shiqiane35fdd92008-12-10 05:08:54 +0000607 ::std::stringstream ss;
608 Print(a, &ss);
609 return ss.str();
610 }
611};
612
613// Implements printing a reference type T&.
614template <typename T>
615class UniversalPrinter<T&> {
616 public:
617 // MSVC warns about adding const to a function type, so we want to
618 // disable the warning.
619#ifdef _MSC_VER
620#pragma warning(push) // Saves the current warning state.
621#pragma warning(disable:4180) // Temporarily disables warning 4180.
622#endif // _MSC_VER
623
624 static void Print(const T& value, ::std::ostream* os) {
625 // Prints the address of the value. We use reinterpret_cast here
626 // as static_cast doesn't compile when T is a function type.
627 *os << "@" << reinterpret_cast<const void*>(&value) << " ";
628
629 // Then prints the value itself.
630 UniversalPrinter<T>::Print(value, os);
631 }
632
633 // A convenient wrapper for Print() that returns the print-out as a
634 // string.
zhanyong.wan4a5330d2009-02-19 00:36:44 +0000635 static string PrintToString(const T& value) {
shiqiane35fdd92008-12-10 05:08:54 +0000636 ::std::stringstream ss;
637 Print(value, &ss);
638 return ss.str();
639 }
640
641#ifdef _MSC_VER
642#pragma warning(pop) // Restores the warning state.
643#endif // _MSC_VER
644};
645
zhanyong.wan4a5330d2009-02-19 00:36:44 +0000646// Prints a value tersely: for a reference type, the referenced value
647// (but not the address) is printed; for a (const) char pointer, the
648// NUL-terminated string (but not the pointer) is printed.
zhanyong.wance198ff2009-02-12 01:34:27 +0000649template <typename T>
zhanyong.wan4a5330d2009-02-19 00:36:44 +0000650void UniversalTersePrint(const T& value, ::std::ostream* os) {
zhanyong.wance198ff2009-02-12 01:34:27 +0000651 UniversalPrinter<T>::Print(value, os);
652}
zhanyong.wan4a5330d2009-02-19 00:36:44 +0000653inline void UniversalTersePrint(const char* str, ::std::ostream* os) {
654 if (str == NULL) {
655 *os << "NULL";
656 } else {
657 UniversalPrinter<string>::Print(string(str), os);
658 }
659}
660inline void UniversalTersePrint(char* str, ::std::ostream* os) {
661 UniversalTersePrint(static_cast<const char*>(str), os);
662}
663
664// Prints the fields of a tuple tersely to a string vector, one
665// element for each field. See the comment before
666// UniversalTersePrint() for how we define "tersely".
667template <typename Tuple>
668Strings UniversalTersePrintTupleFieldsToStrings(const Tuple& value) {
669 Strings result;
670 TuplePrefixPrinter< ::std::tr1::tuple_size<Tuple>::value>::
671 TersePrintPrefixToStrings(value, &result);
672 return result;
673}
zhanyong.wance198ff2009-02-12 01:34:27 +0000674
shiqiane35fdd92008-12-10 05:08:54 +0000675} // namespace internal
676} // namespace testing
677
678#endif // GMOCK_INCLUDE_GMOCK_GMOCK_PRINTERS_H_