test: Bundle GTest/GMock 1.8.1 sources and provide a find script
[quassel.git] / 3rdparty / googletest-1.8.1 / googletest / src / gtest.cc
1 // Copyright 2005, 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 //
31 // The Google C++ Testing and Mocking Framework (Google Test)
32
33 #include "gtest/gtest.h"
34 #include "gtest/internal/custom/gtest.h"
35 #include "gtest/gtest-spi.h"
36
37 #include <ctype.h>
38 #include <math.h>
39 #include <stdarg.h>
40 #include <stdio.h>
41 #include <stdlib.h>
42 #include <time.h>
43 #include <wchar.h>
44 #include <wctype.h>
45
46 #include <algorithm>
47 #include <iomanip>
48 #include <limits>
49 #include <list>
50 #include <map>
51 #include <ostream>  // NOLINT
52 #include <sstream>
53 #include <vector>
54
55 #if GTEST_OS_LINUX
56
57 // FIXME: Use autoconf to detect availability of
58 // gettimeofday().
59 # define GTEST_HAS_GETTIMEOFDAY_ 1
60
61 # include <fcntl.h>  // NOLINT
62 # include <limits.h>  // NOLINT
63 # include <sched.h>  // NOLINT
64 // Declares vsnprintf().  This header is not available on Windows.
65 # include <strings.h>  // NOLINT
66 # include <sys/mman.h>  // NOLINT
67 # include <sys/time.h>  // NOLINT
68 # include <unistd.h>  // NOLINT
69 # include <string>
70
71 #elif GTEST_OS_SYMBIAN
72 # define GTEST_HAS_GETTIMEOFDAY_ 1
73 # include <sys/time.h>  // NOLINT
74
75 #elif GTEST_OS_ZOS
76 # define GTEST_HAS_GETTIMEOFDAY_ 1
77 # include <sys/time.h>  // NOLINT
78
79 // On z/OS we additionally need strings.h for strcasecmp.
80 # include <strings.h>  // NOLINT
81
82 #elif GTEST_OS_WINDOWS_MOBILE  // We are on Windows CE.
83
84 # include <windows.h>  // NOLINT
85 # undef min
86
87 #elif GTEST_OS_WINDOWS  // We are on Windows proper.
88
89 # include <io.h>  // NOLINT
90 # include <sys/timeb.h>  // NOLINT
91 # include <sys/types.h>  // NOLINT
92 # include <sys/stat.h>  // NOLINT
93
94 # if GTEST_OS_WINDOWS_MINGW
95 // MinGW has gettimeofday() but not _ftime64().
96 // FIXME: Use autoconf to detect availability of
97 //   gettimeofday().
98 // FIXME: There are other ways to get the time on
99 //   Windows, like GetTickCount() or GetSystemTimeAsFileTime().  MinGW
100 //   supports these.  consider using them instead.
101 #  define GTEST_HAS_GETTIMEOFDAY_ 1
102 #  include <sys/time.h>  // NOLINT
103 # endif  // GTEST_OS_WINDOWS_MINGW
104
105 // cpplint thinks that the header is already included, so we want to
106 // silence it.
107 # include <windows.h>  // NOLINT
108 # undef min
109
110 #else
111
112 // Assume other platforms have gettimeofday().
113 // FIXME: Use autoconf to detect availability of
114 //   gettimeofday().
115 # define GTEST_HAS_GETTIMEOFDAY_ 1
116
117 // cpplint thinks that the header is already included, so we want to
118 // silence it.
119 # include <sys/time.h>  // NOLINT
120 # include <unistd.h>  // NOLINT
121
122 #endif  // GTEST_OS_LINUX
123
124 #if GTEST_HAS_EXCEPTIONS
125 # include <stdexcept>
126 #endif
127
128 #if GTEST_CAN_STREAM_RESULTS_
129 # include <arpa/inet.h>  // NOLINT
130 # include <netdb.h>  // NOLINT
131 # include <sys/socket.h>  // NOLINT
132 # include <sys/types.h>  // NOLINT
133 #endif
134
135 #include "src/gtest-internal-inl.h"
136
137 #if GTEST_OS_WINDOWS
138 # define vsnprintf _vsnprintf
139 #endif  // GTEST_OS_WINDOWS
140
141 #if GTEST_OS_MAC
142 #ifndef GTEST_OS_IOS
143 #include <crt_externs.h>
144 #endif
145 #endif
146
147 #if GTEST_HAS_ABSL
148 #include "absl/debugging/failure_signal_handler.h"
149 #include "absl/debugging/stacktrace.h"
150 #include "absl/debugging/symbolize.h"
151 #include "absl/strings/str_cat.h"
152 #endif  // GTEST_HAS_ABSL
153
154 namespace testing {
155
156 using internal::CountIf;
157 using internal::ForEach;
158 using internal::GetElementOr;
159 using internal::Shuffle;
160
161 // Constants.
162
163 // A test whose test case name or test name matches this filter is
164 // disabled and not run.
165 static const char kDisableTestFilter[] = "DISABLED_*:*/DISABLED_*";
166
167 // A test case whose name matches this filter is considered a death
168 // test case and will be run before test cases whose name doesn't
169 // match this filter.
170 static const char kDeathTestCaseFilter[] = "*DeathTest:*DeathTest/*";
171
172 // A test filter that matches everything.
173 static const char kUniversalFilter[] = "*";
174
175 // The default output format.
176 static const char kDefaultOutputFormat[] = "xml";
177 // The default output file.
178 static const char kDefaultOutputFile[] = "test_detail";
179
180 // The environment variable name for the test shard index.
181 static const char kTestShardIndex[] = "GTEST_SHARD_INDEX";
182 // The environment variable name for the total number of test shards.
183 static const char kTestTotalShards[] = "GTEST_TOTAL_SHARDS";
184 // The environment variable name for the test shard status file.
185 static const char kTestShardStatusFile[] = "GTEST_SHARD_STATUS_FILE";
186
187 namespace internal {
188
189 // The text used in failure messages to indicate the start of the
190 // stack trace.
191 const char kStackTraceMarker[] = "\nStack trace:\n";
192
193 // g_help_flag is true iff the --help flag or an equivalent form is
194 // specified on the command line.
195 bool g_help_flag = false;
196
197 // Utilty function to Open File for Writing
198 static FILE* OpenFileForWriting(const std::string& output_file) {
199   FILE* fileout = NULL;
200   FilePath output_file_path(output_file);
201   FilePath output_dir(output_file_path.RemoveFileName());
202
203   if (output_dir.CreateDirectoriesRecursively()) {
204     fileout = posix::FOpen(output_file.c_str(), "w");
205   }
206   if (fileout == NULL) {
207     GTEST_LOG_(FATAL) << "Unable to open file \"" << output_file << "\"";
208   }
209   return fileout;
210 }
211
212 }  // namespace internal
213
214 // Bazel passes in the argument to '--test_filter' via the TESTBRIDGE_TEST_ONLY
215 // environment variable.
216 static const char* GetDefaultFilter() {
217   const char* const testbridge_test_only =
218       internal::posix::GetEnv("TESTBRIDGE_TEST_ONLY");
219   if (testbridge_test_only != NULL) {
220     return testbridge_test_only;
221   }
222   return kUniversalFilter;
223 }
224
225 GTEST_DEFINE_bool_(
226     also_run_disabled_tests,
227     internal::BoolFromGTestEnv("also_run_disabled_tests", false),
228     "Run disabled tests too, in addition to the tests normally being run.");
229
230 GTEST_DEFINE_bool_(
231     break_on_failure,
232     internal::BoolFromGTestEnv("break_on_failure", false),
233     "True iff a failed assertion should be a debugger break-point.");
234
235 GTEST_DEFINE_bool_(
236     catch_exceptions,
237     internal::BoolFromGTestEnv("catch_exceptions", true),
238     "True iff " GTEST_NAME_
239     " should catch exceptions and treat them as test failures.");
240
241 GTEST_DEFINE_string_(
242     color,
243     internal::StringFromGTestEnv("color", "auto"),
244     "Whether to use colors in the output.  Valid values: yes, no, "
245     "and auto.  'auto' means to use colors if the output is "
246     "being sent to a terminal and the TERM environment variable "
247     "is set to a terminal type that supports colors.");
248
249 GTEST_DEFINE_string_(
250     filter,
251     internal::StringFromGTestEnv("filter", GetDefaultFilter()),
252     "A colon-separated list of glob (not regex) patterns "
253     "for filtering the tests to run, optionally followed by a "
254     "'-' and a : separated list of negative patterns (tests to "
255     "exclude).  A test is run if it matches one of the positive "
256     "patterns and does not match any of the negative patterns.");
257
258 GTEST_DEFINE_bool_(
259     install_failure_signal_handler,
260     internal::BoolFromGTestEnv("install_failure_signal_handler", false),
261     "If true and supported on the current platform, " GTEST_NAME_ " should "
262     "install a signal handler that dumps debugging information when fatal "
263     "signals are raised.");
264
265 GTEST_DEFINE_bool_(list_tests, false,
266                    "List all tests without running them.");
267
268 // The net priority order after flag processing is thus:
269 //   --gtest_output command line flag
270 //   GTEST_OUTPUT environment variable
271 //   XML_OUTPUT_FILE environment variable
272 //   ''
273 GTEST_DEFINE_string_(
274     output,
275     internal::StringFromGTestEnv("output",
276       internal::OutputFlagAlsoCheckEnvVar().c_str()),
277     "A format (defaults to \"xml\" but can be specified to be \"json\"), "
278     "optionally followed by a colon and an output file name or directory. "
279     "A directory is indicated by a trailing pathname separator. "
280     "Examples: \"xml:filename.xml\", \"xml::directoryname/\". "
281     "If a directory is specified, output files will be created "
282     "within that directory, with file-names based on the test "
283     "executable's name and, if necessary, made unique by adding "
284     "digits.");
285
286 GTEST_DEFINE_bool_(
287     print_time,
288     internal::BoolFromGTestEnv("print_time", true),
289     "True iff " GTEST_NAME_
290     " should display elapsed time in text output.");
291
292 GTEST_DEFINE_bool_(
293     print_utf8,
294     internal::BoolFromGTestEnv("print_utf8", true),
295     "True iff " GTEST_NAME_
296     " prints UTF8 characters as text.");
297
298 GTEST_DEFINE_int32_(
299     random_seed,
300     internal::Int32FromGTestEnv("random_seed", 0),
301     "Random number seed to use when shuffling test orders.  Must be in range "
302     "[1, 99999], or 0 to use a seed based on the current time.");
303
304 GTEST_DEFINE_int32_(
305     repeat,
306     internal::Int32FromGTestEnv("repeat", 1),
307     "How many times to repeat each test.  Specify a negative number "
308     "for repeating forever.  Useful for shaking out flaky tests.");
309
310 GTEST_DEFINE_bool_(
311     show_internal_stack_frames, false,
312     "True iff " GTEST_NAME_ " should include internal stack frames when "
313     "printing test failure stack traces.");
314
315 GTEST_DEFINE_bool_(
316     shuffle,
317     internal::BoolFromGTestEnv("shuffle", false),
318     "True iff " GTEST_NAME_
319     " should randomize tests' order on every run.");
320
321 GTEST_DEFINE_int32_(
322     stack_trace_depth,
323     internal::Int32FromGTestEnv("stack_trace_depth", kMaxStackTraceDepth),
324     "The maximum number of stack frames to print when an "
325     "assertion fails.  The valid range is 0 through 100, inclusive.");
326
327 GTEST_DEFINE_string_(
328     stream_result_to,
329     internal::StringFromGTestEnv("stream_result_to", ""),
330     "This flag specifies the host name and the port number on which to stream "
331     "test results. Example: \"localhost:555\". The flag is effective only on "
332     "Linux.");
333
334 GTEST_DEFINE_bool_(
335     throw_on_failure,
336     internal::BoolFromGTestEnv("throw_on_failure", false),
337     "When this flag is specified, a failed assertion will throw an exception "
338     "if exceptions are enabled or exit the program with a non-zero code "
339     "otherwise. For use with an external test framework.");
340
341 #if GTEST_USE_OWN_FLAGFILE_FLAG_
342 GTEST_DEFINE_string_(
343     flagfile,
344     internal::StringFromGTestEnv("flagfile", ""),
345     "This flag specifies the flagfile to read command-line flags from.");
346 #endif  // GTEST_USE_OWN_FLAGFILE_FLAG_
347
348 namespace internal {
349
350 // Generates a random number from [0, range), using a Linear
351 // Congruential Generator (LCG).  Crashes if 'range' is 0 or greater
352 // than kMaxRange.
353 UInt32 Random::Generate(UInt32 range) {
354   // These constants are the same as are used in glibc's rand(3).
355   // Use wider types than necessary to prevent unsigned overflow diagnostics.
356   state_ = static_cast<UInt32>(1103515245ULL*state_ + 12345U) % kMaxRange;
357
358   GTEST_CHECK_(range > 0)
359       << "Cannot generate a number in the range [0, 0).";
360   GTEST_CHECK_(range <= kMaxRange)
361       << "Generation of a number in [0, " << range << ") was requested, "
362       << "but this can only generate numbers in [0, " << kMaxRange << ").";
363
364   // Converting via modulus introduces a bit of downward bias, but
365   // it's simple, and a linear congruential generator isn't too good
366   // to begin with.
367   return state_ % range;
368 }
369
370 // GTestIsInitialized() returns true iff the user has initialized
371 // Google Test.  Useful for catching the user mistake of not initializing
372 // Google Test before calling RUN_ALL_TESTS().
373 static bool GTestIsInitialized() { return GetArgvs().size() > 0; }
374
375 // Iterates over a vector of TestCases, keeping a running sum of the
376 // results of calling a given int-returning method on each.
377 // Returns the sum.
378 static int SumOverTestCaseList(const std::vector<TestCase*>& case_list,
379                                int (TestCase::*method)() const) {
380   int sum = 0;
381   for (size_t i = 0; i < case_list.size(); i++) {
382     sum += (case_list[i]->*method)();
383   }
384   return sum;
385 }
386
387 // Returns true iff the test case passed.
388 static bool TestCasePassed(const TestCase* test_case) {
389   return test_case->should_run() && test_case->Passed();
390 }
391
392 // Returns true iff the test case failed.
393 static bool TestCaseFailed(const TestCase* test_case) {
394   return test_case->should_run() && test_case->Failed();
395 }
396
397 // Returns true iff test_case contains at least one test that should
398 // run.
399 static bool ShouldRunTestCase(const TestCase* test_case) {
400   return test_case->should_run();
401 }
402
403 // AssertHelper constructor.
404 AssertHelper::AssertHelper(TestPartResult::Type type,
405                            const char* file,
406                            int line,
407                            const char* message)
408     : data_(new AssertHelperData(type, file, line, message)) {
409 }
410
411 AssertHelper::~AssertHelper() {
412   delete data_;
413 }
414
415 // Message assignment, for assertion streaming support.
416 void AssertHelper::operator=(const Message& message) const {
417   UnitTest::GetInstance()->
418     AddTestPartResult(data_->type, data_->file, data_->line,
419                       AppendUserMessage(data_->message, message),
420                       UnitTest::GetInstance()->impl()
421                       ->CurrentOsStackTraceExceptTop(1)
422                       // Skips the stack frame for this function itself.
423                       );  // NOLINT
424 }
425
426 // Mutex for linked pointers.
427 GTEST_API_ GTEST_DEFINE_STATIC_MUTEX_(g_linked_ptr_mutex);
428
429 // A copy of all command line arguments.  Set by InitGoogleTest().
430 static ::std::vector<std::string> g_argvs;
431
432 ::std::vector<std::string> GetArgvs() {
433 #if defined(GTEST_CUSTOM_GET_ARGVS_)
434   // GTEST_CUSTOM_GET_ARGVS_() may return a container of std::string or
435   // ::string. This code converts it to the appropriate type.
436   const auto& custom = GTEST_CUSTOM_GET_ARGVS_();
437   return ::std::vector<std::string>(custom.begin(), custom.end());
438 #else   // defined(GTEST_CUSTOM_GET_ARGVS_)
439   return g_argvs;
440 #endif  // defined(GTEST_CUSTOM_GET_ARGVS_)
441 }
442
443 // Returns the current application's name, removing directory path if that
444 // is present.
445 FilePath GetCurrentExecutableName() {
446   FilePath result;
447
448 #if GTEST_OS_WINDOWS
449   result.Set(FilePath(GetArgvs()[0]).RemoveExtension("exe"));
450 #else
451   result.Set(FilePath(GetArgvs()[0]));
452 #endif  // GTEST_OS_WINDOWS
453
454   return result.RemoveDirectoryName();
455 }
456
457 // Functions for processing the gtest_output flag.
458
459 // Returns the output format, or "" for normal printed output.
460 std::string UnitTestOptions::GetOutputFormat() {
461   const char* const gtest_output_flag = GTEST_FLAG(output).c_str();
462   const char* const colon = strchr(gtest_output_flag, ':');
463   return (colon == NULL) ?
464       std::string(gtest_output_flag) :
465       std::string(gtest_output_flag, colon - gtest_output_flag);
466 }
467
468 // Returns the name of the requested output file, or the default if none
469 // was explicitly specified.
470 std::string UnitTestOptions::GetAbsolutePathToOutputFile() {
471   const char* const gtest_output_flag = GTEST_FLAG(output).c_str();
472
473   std::string format = GetOutputFormat();
474   if (format.empty())
475     format = std::string(kDefaultOutputFormat);
476
477   const char* const colon = strchr(gtest_output_flag, ':');
478   if (colon == NULL)
479     return internal::FilePath::MakeFileName(
480         internal::FilePath(
481             UnitTest::GetInstance()->original_working_dir()),
482         internal::FilePath(kDefaultOutputFile), 0,
483         format.c_str()).string();
484
485   internal::FilePath output_name(colon + 1);
486   if (!output_name.IsAbsolutePath())
487     // FIXME: on Windows \some\path is not an absolute
488     // path (as its meaning depends on the current drive), yet the
489     // following logic for turning it into an absolute path is wrong.
490     // Fix it.
491     output_name = internal::FilePath::ConcatPaths(
492         internal::FilePath(UnitTest::GetInstance()->original_working_dir()),
493         internal::FilePath(colon + 1));
494
495   if (!output_name.IsDirectory())
496     return output_name.string();
497
498   internal::FilePath result(internal::FilePath::GenerateUniqueFileName(
499       output_name, internal::GetCurrentExecutableName(),
500       GetOutputFormat().c_str()));
501   return result.string();
502 }
503
504 // Returns true iff the wildcard pattern matches the string.  The
505 // first ':' or '\0' character in pattern marks the end of it.
506 //
507 // This recursive algorithm isn't very efficient, but is clear and
508 // works well enough for matching test names, which are short.
509 bool UnitTestOptions::PatternMatchesString(const char *pattern,
510                                            const char *str) {
511   switch (*pattern) {
512     case '\0':
513     case ':':  // Either ':' or '\0' marks the end of the pattern.
514       return *str == '\0';
515     case '?':  // Matches any single character.
516       return *str != '\0' && PatternMatchesString(pattern + 1, str + 1);
517     case '*':  // Matches any string (possibly empty) of characters.
518       return (*str != '\0' && PatternMatchesString(pattern, str + 1)) ||
519           PatternMatchesString(pattern + 1, str);
520     default:  // Non-special character.  Matches itself.
521       return *pattern == *str &&
522           PatternMatchesString(pattern + 1, str + 1);
523   }
524 }
525
526 bool UnitTestOptions::MatchesFilter(
527     const std::string& name, const char* filter) {
528   const char *cur_pattern = filter;
529   for (;;) {
530     if (PatternMatchesString(cur_pattern, name.c_str())) {
531       return true;
532     }
533
534     // Finds the next pattern in the filter.
535     cur_pattern = strchr(cur_pattern, ':');
536
537     // Returns if no more pattern can be found.
538     if (cur_pattern == NULL) {
539       return false;
540     }
541
542     // Skips the pattern separater (the ':' character).
543     cur_pattern++;
544   }
545 }
546
547 // Returns true iff the user-specified filter matches the test case
548 // name and the test name.
549 bool UnitTestOptions::FilterMatchesTest(const std::string &test_case_name,
550                                         const std::string &test_name) {
551   const std::string& full_name = test_case_name + "." + test_name.c_str();
552
553   // Split --gtest_filter at '-', if there is one, to separate into
554   // positive filter and negative filter portions
555   const char* const p = GTEST_FLAG(filter).c_str();
556   const char* const dash = strchr(p, '-');
557   std::string positive;
558   std::string negative;
559   if (dash == NULL) {
560     positive = GTEST_FLAG(filter).c_str();  // Whole string is a positive filter
561     negative = "";
562   } else {
563     positive = std::string(p, dash);   // Everything up to the dash
564     negative = std::string(dash + 1);  // Everything after the dash
565     if (positive.empty()) {
566       // Treat '-test1' as the same as '*-test1'
567       positive = kUniversalFilter;
568     }
569   }
570
571   // A filter is a colon-separated list of patterns.  It matches a
572   // test if any pattern in it matches the test.
573   return (MatchesFilter(full_name, positive.c_str()) &&
574           !MatchesFilter(full_name, negative.c_str()));
575 }
576
577 #if GTEST_HAS_SEH
578 // Returns EXCEPTION_EXECUTE_HANDLER if Google Test should handle the
579 // given SEH exception, or EXCEPTION_CONTINUE_SEARCH otherwise.
580 // This function is useful as an __except condition.
581 int UnitTestOptions::GTestShouldProcessSEH(DWORD exception_code) {
582   // Google Test should handle a SEH exception if:
583   //   1. the user wants it to, AND
584   //   2. this is not a breakpoint exception, AND
585   //   3. this is not a C++ exception (VC++ implements them via SEH,
586   //      apparently).
587   //
588   // SEH exception code for C++ exceptions.
589   // (see http://support.microsoft.com/kb/185294 for more information).
590   const DWORD kCxxExceptionCode = 0xe06d7363;
591
592   bool should_handle = true;
593
594   if (!GTEST_FLAG(catch_exceptions))
595     should_handle = false;
596   else if (exception_code == EXCEPTION_BREAKPOINT)
597     should_handle = false;
598   else if (exception_code == kCxxExceptionCode)
599     should_handle = false;
600
601   return should_handle ? EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH;
602 }
603 #endif  // GTEST_HAS_SEH
604
605 }  // namespace internal
606
607 // The c'tor sets this object as the test part result reporter used by
608 // Google Test.  The 'result' parameter specifies where to report the
609 // results. Intercepts only failures from the current thread.
610 ScopedFakeTestPartResultReporter::ScopedFakeTestPartResultReporter(
611     TestPartResultArray* result)
612     : intercept_mode_(INTERCEPT_ONLY_CURRENT_THREAD),
613       result_(result) {
614   Init();
615 }
616
617 // The c'tor sets this object as the test part result reporter used by
618 // Google Test.  The 'result' parameter specifies where to report the
619 // results.
620 ScopedFakeTestPartResultReporter::ScopedFakeTestPartResultReporter(
621     InterceptMode intercept_mode, TestPartResultArray* result)
622     : intercept_mode_(intercept_mode),
623       result_(result) {
624   Init();
625 }
626
627 void ScopedFakeTestPartResultReporter::Init() {
628   internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
629   if (intercept_mode_ == INTERCEPT_ALL_THREADS) {
630     old_reporter_ = impl->GetGlobalTestPartResultReporter();
631     impl->SetGlobalTestPartResultReporter(this);
632   } else {
633     old_reporter_ = impl->GetTestPartResultReporterForCurrentThread();
634     impl->SetTestPartResultReporterForCurrentThread(this);
635   }
636 }
637
638 // The d'tor restores the test part result reporter used by Google Test
639 // before.
640 ScopedFakeTestPartResultReporter::~ScopedFakeTestPartResultReporter() {
641   internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
642   if (intercept_mode_ == INTERCEPT_ALL_THREADS) {
643     impl->SetGlobalTestPartResultReporter(old_reporter_);
644   } else {
645     impl->SetTestPartResultReporterForCurrentThread(old_reporter_);
646   }
647 }
648
649 // Increments the test part result count and remembers the result.
650 // This method is from the TestPartResultReporterInterface interface.
651 void ScopedFakeTestPartResultReporter::ReportTestPartResult(
652     const TestPartResult& result) {
653   result_->Append(result);
654 }
655
656 namespace internal {
657
658 // Returns the type ID of ::testing::Test.  We should always call this
659 // instead of GetTypeId< ::testing::Test>() to get the type ID of
660 // testing::Test.  This is to work around a suspected linker bug when
661 // using Google Test as a framework on Mac OS X.  The bug causes
662 // GetTypeId< ::testing::Test>() to return different values depending
663 // on whether the call is from the Google Test framework itself or
664 // from user test code.  GetTestTypeId() is guaranteed to always
665 // return the same value, as it always calls GetTypeId<>() from the
666 // gtest.cc, which is within the Google Test framework.
667 TypeId GetTestTypeId() {
668   return GetTypeId<Test>();
669 }
670
671 // The value of GetTestTypeId() as seen from within the Google Test
672 // library.  This is solely for testing GetTestTypeId().
673 extern const TypeId kTestTypeIdInGoogleTest = GetTestTypeId();
674
675 // This predicate-formatter checks that 'results' contains a test part
676 // failure of the given type and that the failure message contains the
677 // given substring.
678 static AssertionResult HasOneFailure(const char* /* results_expr */,
679                                      const char* /* type_expr */,
680                                      const char* /* substr_expr */,
681                                      const TestPartResultArray& results,
682                                      TestPartResult::Type type,
683                                      const std::string& substr) {
684   const std::string expected(type == TestPartResult::kFatalFailure ?
685                         "1 fatal failure" :
686                         "1 non-fatal failure");
687   Message msg;
688   if (results.size() != 1) {
689     msg << "Expected: " << expected << "\n"
690         << "  Actual: " << results.size() << " failures";
691     for (int i = 0; i < results.size(); i++) {
692       msg << "\n" << results.GetTestPartResult(i);
693     }
694     return AssertionFailure() << msg;
695   }
696
697   const TestPartResult& r = results.GetTestPartResult(0);
698   if (r.type() != type) {
699     return AssertionFailure() << "Expected: " << expected << "\n"
700                               << "  Actual:\n"
701                               << r;
702   }
703
704   if (strstr(r.message(), substr.c_str()) == NULL) {
705     return AssertionFailure() << "Expected: " << expected << " containing \""
706                               << substr << "\"\n"
707                               << "  Actual:\n"
708                               << r;
709   }
710
711   return AssertionSuccess();
712 }
713
714 // The constructor of SingleFailureChecker remembers where to look up
715 // test part results, what type of failure we expect, and what
716 // substring the failure message should contain.
717 SingleFailureChecker::SingleFailureChecker(const TestPartResultArray* results,
718                                            TestPartResult::Type type,
719                                            const std::string& substr)
720     : results_(results), type_(type), substr_(substr) {}
721
722 // The destructor of SingleFailureChecker verifies that the given
723 // TestPartResultArray contains exactly one failure that has the given
724 // type and contains the given substring.  If that's not the case, a
725 // non-fatal failure will be generated.
726 SingleFailureChecker::~SingleFailureChecker() {
727   EXPECT_PRED_FORMAT3(HasOneFailure, *results_, type_, substr_);
728 }
729
730 DefaultGlobalTestPartResultReporter::DefaultGlobalTestPartResultReporter(
731     UnitTestImpl* unit_test) : unit_test_(unit_test) {}
732
733 void DefaultGlobalTestPartResultReporter::ReportTestPartResult(
734     const TestPartResult& result) {
735   unit_test_->current_test_result()->AddTestPartResult(result);
736   unit_test_->listeners()->repeater()->OnTestPartResult(result);
737 }
738
739 DefaultPerThreadTestPartResultReporter::DefaultPerThreadTestPartResultReporter(
740     UnitTestImpl* unit_test) : unit_test_(unit_test) {}
741
742 void DefaultPerThreadTestPartResultReporter::ReportTestPartResult(
743     const TestPartResult& result) {
744   unit_test_->GetGlobalTestPartResultReporter()->ReportTestPartResult(result);
745 }
746
747 // Returns the global test part result reporter.
748 TestPartResultReporterInterface*
749 UnitTestImpl::GetGlobalTestPartResultReporter() {
750   internal::MutexLock lock(&global_test_part_result_reporter_mutex_);
751   return global_test_part_result_repoter_;
752 }
753
754 // Sets the global test part result reporter.
755 void UnitTestImpl::SetGlobalTestPartResultReporter(
756     TestPartResultReporterInterface* reporter) {
757   internal::MutexLock lock(&global_test_part_result_reporter_mutex_);
758   global_test_part_result_repoter_ = reporter;
759 }
760
761 // Returns the test part result reporter for the current thread.
762 TestPartResultReporterInterface*
763 UnitTestImpl::GetTestPartResultReporterForCurrentThread() {
764   return per_thread_test_part_result_reporter_.get();
765 }
766
767 // Sets the test part result reporter for the current thread.
768 void UnitTestImpl::SetTestPartResultReporterForCurrentThread(
769     TestPartResultReporterInterface* reporter) {
770   per_thread_test_part_result_reporter_.set(reporter);
771 }
772
773 // Gets the number of successful test cases.
774 int UnitTestImpl::successful_test_case_count() const {
775   return CountIf(test_cases_, TestCasePassed);
776 }
777
778 // Gets the number of failed test cases.
779 int UnitTestImpl::failed_test_case_count() const {
780   return CountIf(test_cases_, TestCaseFailed);
781 }
782
783 // Gets the number of all test cases.
784 int UnitTestImpl::total_test_case_count() const {
785   return static_cast<int>(test_cases_.size());
786 }
787
788 // Gets the number of all test cases that contain at least one test
789 // that should run.
790 int UnitTestImpl::test_case_to_run_count() const {
791   return CountIf(test_cases_, ShouldRunTestCase);
792 }
793
794 // Gets the number of successful tests.
795 int UnitTestImpl::successful_test_count() const {
796   return SumOverTestCaseList(test_cases_, &TestCase::successful_test_count);
797 }
798
799 // Gets the number of failed tests.
800 int UnitTestImpl::failed_test_count() const {
801   return SumOverTestCaseList(test_cases_, &TestCase::failed_test_count);
802 }
803
804 // Gets the number of disabled tests that will be reported in the XML report.
805 int UnitTestImpl::reportable_disabled_test_count() const {
806   return SumOverTestCaseList(test_cases_,
807                              &TestCase::reportable_disabled_test_count);
808 }
809
810 // Gets the number of disabled tests.
811 int UnitTestImpl::disabled_test_count() const {
812   return SumOverTestCaseList(test_cases_, &TestCase::disabled_test_count);
813 }
814
815 // Gets the number of tests to be printed in the XML report.
816 int UnitTestImpl::reportable_test_count() const {
817   return SumOverTestCaseList(test_cases_, &TestCase::reportable_test_count);
818 }
819
820 // Gets the number of all tests.
821 int UnitTestImpl::total_test_count() const {
822   return SumOverTestCaseList(test_cases_, &TestCase::total_test_count);
823 }
824
825 // Gets the number of tests that should run.
826 int UnitTestImpl::test_to_run_count() const {
827   return SumOverTestCaseList(test_cases_, &TestCase::test_to_run_count);
828 }
829
830 // Returns the current OS stack trace as an std::string.
831 //
832 // The maximum number of stack frames to be included is specified by
833 // the gtest_stack_trace_depth flag.  The skip_count parameter
834 // specifies the number of top frames to be skipped, which doesn't
835 // count against the number of frames to be included.
836 //
837 // For example, if Foo() calls Bar(), which in turn calls
838 // CurrentOsStackTraceExceptTop(1), Foo() will be included in the
839 // trace but Bar() and CurrentOsStackTraceExceptTop() won't.
840 std::string UnitTestImpl::CurrentOsStackTraceExceptTop(int skip_count) {
841   return os_stack_trace_getter()->CurrentStackTrace(
842       static_cast<int>(GTEST_FLAG(stack_trace_depth)),
843       skip_count + 1
844       // Skips the user-specified number of frames plus this function
845       // itself.
846       );  // NOLINT
847 }
848
849 // Returns the current time in milliseconds.
850 TimeInMillis GetTimeInMillis() {
851 #if GTEST_OS_WINDOWS_MOBILE || defined(__BORLANDC__)
852   // Difference between 1970-01-01 and 1601-01-01 in milliseconds.
853   // http://analogous.blogspot.com/2005/04/epoch.html
854   const TimeInMillis kJavaEpochToWinFileTimeDelta =
855     static_cast<TimeInMillis>(116444736UL) * 100000UL;
856   const DWORD kTenthMicrosInMilliSecond = 10000;
857
858   SYSTEMTIME now_systime;
859   FILETIME now_filetime;
860   ULARGE_INTEGER now_int64;
861   // FIXME: Shouldn't this just use
862   //   GetSystemTimeAsFileTime()?
863   GetSystemTime(&now_systime);
864   if (SystemTimeToFileTime(&now_systime, &now_filetime)) {
865     now_int64.LowPart = now_filetime.dwLowDateTime;
866     now_int64.HighPart = now_filetime.dwHighDateTime;
867     now_int64.QuadPart = (now_int64.QuadPart / kTenthMicrosInMilliSecond) -
868       kJavaEpochToWinFileTimeDelta;
869     return now_int64.QuadPart;
870   }
871   return 0;
872 #elif GTEST_OS_WINDOWS && !GTEST_HAS_GETTIMEOFDAY_
873   __timeb64 now;
874
875   // MSVC 8 deprecates _ftime64(), so we want to suppress warning 4996
876   // (deprecated function) there.
877   // FIXME: Use GetTickCount()?  Or use
878   //   SystemTimeToFileTime()
879   GTEST_DISABLE_MSC_DEPRECATED_PUSH_()
880   _ftime64(&now);
881   GTEST_DISABLE_MSC_DEPRECATED_POP_()
882
883   return static_cast<TimeInMillis>(now.time) * 1000 + now.millitm;
884 #elif GTEST_HAS_GETTIMEOFDAY_
885   struct timeval now;
886   gettimeofday(&now, NULL);
887   return static_cast<TimeInMillis>(now.tv_sec) * 1000 + now.tv_usec / 1000;
888 #else
889 # error "Don't know how to get the current time on your system."
890 #endif
891 }
892
893 // Utilities
894
895 // class String.
896
897 #if GTEST_OS_WINDOWS_MOBILE
898 // Creates a UTF-16 wide string from the given ANSI string, allocating
899 // memory using new. The caller is responsible for deleting the return
900 // value using delete[]. Returns the wide string, or NULL if the
901 // input is NULL.
902 LPCWSTR String::AnsiToUtf16(const char* ansi) {
903   if (!ansi) return NULL;
904   const int length = strlen(ansi);
905   const int unicode_length =
906       MultiByteToWideChar(CP_ACP, 0, ansi, length,
907                           NULL, 0);
908   WCHAR* unicode = new WCHAR[unicode_length + 1];
909   MultiByteToWideChar(CP_ACP, 0, ansi, length,
910                       unicode, unicode_length);
911   unicode[unicode_length] = 0;
912   return unicode;
913 }
914
915 // Creates an ANSI string from the given wide string, allocating
916 // memory using new. The caller is responsible for deleting the return
917 // value using delete[]. Returns the ANSI string, or NULL if the
918 // input is NULL.
919 const char* String::Utf16ToAnsi(LPCWSTR utf16_str)  {
920   if (!utf16_str) return NULL;
921   const int ansi_length =
922       WideCharToMultiByte(CP_ACP, 0, utf16_str, -1,
923                           NULL, 0, NULL, NULL);
924   char* ansi = new char[ansi_length + 1];
925   WideCharToMultiByte(CP_ACP, 0, utf16_str, -1,
926                       ansi, ansi_length, NULL, NULL);
927   ansi[ansi_length] = 0;
928   return ansi;
929 }
930
931 #endif  // GTEST_OS_WINDOWS_MOBILE
932
933 // Compares two C strings.  Returns true iff they have the same content.
934 //
935 // Unlike strcmp(), this function can handle NULL argument(s).  A NULL
936 // C string is considered different to any non-NULL C string,
937 // including the empty string.
938 bool String::CStringEquals(const char * lhs, const char * rhs) {
939   if ( lhs == NULL ) return rhs == NULL;
940
941   if ( rhs == NULL ) return false;
942
943   return strcmp(lhs, rhs) == 0;
944 }
945
946 #if GTEST_HAS_STD_WSTRING || GTEST_HAS_GLOBAL_WSTRING
947
948 // Converts an array of wide chars to a narrow string using the UTF-8
949 // encoding, and streams the result to the given Message object.
950 static void StreamWideCharsToMessage(const wchar_t* wstr, size_t length,
951                                      Message* msg) {
952   for (size_t i = 0; i != length; ) {  // NOLINT
953     if (wstr[i] != L'\0') {
954       *msg << WideStringToUtf8(wstr + i, static_cast<int>(length - i));
955       while (i != length && wstr[i] != L'\0')
956         i++;
957     } else {
958       *msg << '\0';
959       i++;
960     }
961   }
962 }
963
964 #endif  // GTEST_HAS_STD_WSTRING || GTEST_HAS_GLOBAL_WSTRING
965
966 void SplitString(const ::std::string& str, char delimiter,
967                  ::std::vector< ::std::string>* dest) {
968   ::std::vector< ::std::string> parsed;
969   ::std::string::size_type pos = 0;
970   while (::testing::internal::AlwaysTrue()) {
971     const ::std::string::size_type colon = str.find(delimiter, pos);
972     if (colon == ::std::string::npos) {
973       parsed.push_back(str.substr(pos));
974       break;
975     } else {
976       parsed.push_back(str.substr(pos, colon - pos));
977       pos = colon + 1;
978     }
979   }
980   dest->swap(parsed);
981 }
982
983 }  // namespace internal
984
985 // Constructs an empty Message.
986 // We allocate the stringstream separately because otherwise each use of
987 // ASSERT/EXPECT in a procedure adds over 200 bytes to the procedure's
988 // stack frame leading to huge stack frames in some cases; gcc does not reuse
989 // the stack space.
990 Message::Message() : ss_(new ::std::stringstream) {
991   // By default, we want there to be enough precision when printing
992   // a double to a Message.
993   *ss_ << std::setprecision(std::numeric_limits<double>::digits10 + 2);
994 }
995
996 // These two overloads allow streaming a wide C string to a Message
997 // using the UTF-8 encoding.
998 Message& Message::operator <<(const wchar_t* wide_c_str) {
999   return *this << internal::String::ShowWideCString(wide_c_str);
1000 }
1001 Message& Message::operator <<(wchar_t* wide_c_str) {
1002   return *this << internal::String::ShowWideCString(wide_c_str);
1003 }
1004
1005 #if GTEST_HAS_STD_WSTRING
1006 // Converts the given wide string to a narrow string using the UTF-8
1007 // encoding, and streams the result to this Message object.
1008 Message& Message::operator <<(const ::std::wstring& wstr) {
1009   internal::StreamWideCharsToMessage(wstr.c_str(), wstr.length(), this);
1010   return *this;
1011 }
1012 #endif  // GTEST_HAS_STD_WSTRING
1013
1014 #if GTEST_HAS_GLOBAL_WSTRING
1015 // Converts the given wide string to a narrow string using the UTF-8
1016 // encoding, and streams the result to this Message object.
1017 Message& Message::operator <<(const ::wstring& wstr) {
1018   internal::StreamWideCharsToMessage(wstr.c_str(), wstr.length(), this);
1019   return *this;
1020 }
1021 #endif  // GTEST_HAS_GLOBAL_WSTRING
1022
1023 // Gets the text streamed to this object so far as an std::string.
1024 // Each '\0' character in the buffer is replaced with "\\0".
1025 std::string Message::GetString() const {
1026   return internal::StringStreamToString(ss_.get());
1027 }
1028
1029 // AssertionResult constructors.
1030 // Used in EXPECT_TRUE/FALSE(assertion_result).
1031 AssertionResult::AssertionResult(const AssertionResult& other)
1032     : success_(other.success_),
1033       message_(other.message_.get() != NULL ?
1034                new ::std::string(*other.message_) :
1035                static_cast< ::std::string*>(NULL)) {
1036 }
1037
1038 // Swaps two AssertionResults.
1039 void AssertionResult::swap(AssertionResult& other) {
1040   using std::swap;
1041   swap(success_, other.success_);
1042   swap(message_, other.message_);
1043 }
1044
1045 // Returns the assertion's negation. Used with EXPECT/ASSERT_FALSE.
1046 AssertionResult AssertionResult::operator!() const {
1047   AssertionResult negation(!success_);
1048   if (message_.get() != NULL)
1049     negation << *message_;
1050   return negation;
1051 }
1052
1053 // Makes a successful assertion result.
1054 AssertionResult AssertionSuccess() {
1055   return AssertionResult(true);
1056 }
1057
1058 // Makes a failed assertion result.
1059 AssertionResult AssertionFailure() {
1060   return AssertionResult(false);
1061 }
1062
1063 // Makes a failed assertion result with the given failure message.
1064 // Deprecated; use AssertionFailure() << message.
1065 AssertionResult AssertionFailure(const Message& message) {
1066   return AssertionFailure() << message;
1067 }
1068
1069 namespace internal {
1070
1071 namespace edit_distance {
1072 std::vector<EditType> CalculateOptimalEdits(const std::vector<size_t>& left,
1073                                             const std::vector<size_t>& right) {
1074   std::vector<std::vector<double> > costs(
1075       left.size() + 1, std::vector<double>(right.size() + 1));
1076   std::vector<std::vector<EditType> > best_move(
1077       left.size() + 1, std::vector<EditType>(right.size() + 1));
1078
1079   // Populate for empty right.
1080   for (size_t l_i = 0; l_i < costs.size(); ++l_i) {
1081     costs[l_i][0] = static_cast<double>(l_i);
1082     best_move[l_i][0] = kRemove;
1083   }
1084   // Populate for empty left.
1085   for (size_t r_i = 1; r_i < costs[0].size(); ++r_i) {
1086     costs[0][r_i] = static_cast<double>(r_i);
1087     best_move[0][r_i] = kAdd;
1088   }
1089
1090   for (size_t l_i = 0; l_i < left.size(); ++l_i) {
1091     for (size_t r_i = 0; r_i < right.size(); ++r_i) {
1092       if (left[l_i] == right[r_i]) {
1093         // Found a match. Consume it.
1094         costs[l_i + 1][r_i + 1] = costs[l_i][r_i];
1095         best_move[l_i + 1][r_i + 1] = kMatch;
1096         continue;
1097       }
1098
1099       const double add = costs[l_i + 1][r_i];
1100       const double remove = costs[l_i][r_i + 1];
1101       const double replace = costs[l_i][r_i];
1102       if (add < remove && add < replace) {
1103         costs[l_i + 1][r_i + 1] = add + 1;
1104         best_move[l_i + 1][r_i + 1] = kAdd;
1105       } else if (remove < add && remove < replace) {
1106         costs[l_i + 1][r_i + 1] = remove + 1;
1107         best_move[l_i + 1][r_i + 1] = kRemove;
1108       } else {
1109         // We make replace a little more expensive than add/remove to lower
1110         // their priority.
1111         costs[l_i + 1][r_i + 1] = replace + 1.00001;
1112         best_move[l_i + 1][r_i + 1] = kReplace;
1113       }
1114     }
1115   }
1116
1117   // Reconstruct the best path. We do it in reverse order.
1118   std::vector<EditType> best_path;
1119   for (size_t l_i = left.size(), r_i = right.size(); l_i > 0 || r_i > 0;) {
1120     EditType move = best_move[l_i][r_i];
1121     best_path.push_back(move);
1122     l_i -= move != kAdd;
1123     r_i -= move != kRemove;
1124   }
1125   std::reverse(best_path.begin(), best_path.end());
1126   return best_path;
1127 }
1128
1129 namespace {
1130
1131 // Helper class to convert string into ids with deduplication.
1132 class InternalStrings {
1133  public:
1134   size_t GetId(const std::string& str) {
1135     IdMap::iterator it = ids_.find(str);
1136     if (it != ids_.end()) return it->second;
1137     size_t id = ids_.size();
1138     return ids_[str] = id;
1139   }
1140
1141  private:
1142   typedef std::map<std::string, size_t> IdMap;
1143   IdMap ids_;
1144 };
1145
1146 }  // namespace
1147
1148 std::vector<EditType> CalculateOptimalEdits(
1149     const std::vector<std::string>& left,
1150     const std::vector<std::string>& right) {
1151   std::vector<size_t> left_ids, right_ids;
1152   {
1153     InternalStrings intern_table;
1154     for (size_t i = 0; i < left.size(); ++i) {
1155       left_ids.push_back(intern_table.GetId(left[i]));
1156     }
1157     for (size_t i = 0; i < right.size(); ++i) {
1158       right_ids.push_back(intern_table.GetId(right[i]));
1159     }
1160   }
1161   return CalculateOptimalEdits(left_ids, right_ids);
1162 }
1163
1164 namespace {
1165
1166 // Helper class that holds the state for one hunk and prints it out to the
1167 // stream.
1168 // It reorders adds/removes when possible to group all removes before all
1169 // adds. It also adds the hunk header before printint into the stream.
1170 class Hunk {
1171  public:
1172   Hunk(size_t left_start, size_t right_start)
1173       : left_start_(left_start),
1174         right_start_(right_start),
1175         adds_(),
1176         removes_(),
1177         common_() {}
1178
1179   void PushLine(char edit, const char* line) {
1180     switch (edit) {
1181       case ' ':
1182         ++common_;
1183         FlushEdits();
1184         hunk_.push_back(std::make_pair(' ', line));
1185         break;
1186       case '-':
1187         ++removes_;
1188         hunk_removes_.push_back(std::make_pair('-', line));
1189         break;
1190       case '+':
1191         ++adds_;
1192         hunk_adds_.push_back(std::make_pair('+', line));
1193         break;
1194     }
1195   }
1196
1197   void PrintTo(std::ostream* os) {
1198     PrintHeader(os);
1199     FlushEdits();
1200     for (std::list<std::pair<char, const char*> >::const_iterator it =
1201              hunk_.begin();
1202          it != hunk_.end(); ++it) {
1203       *os << it->first << it->second << "\n";
1204     }
1205   }
1206
1207   bool has_edits() const { return adds_ || removes_; }
1208
1209  private:
1210   void FlushEdits() {
1211     hunk_.splice(hunk_.end(), hunk_removes_);
1212     hunk_.splice(hunk_.end(), hunk_adds_);
1213   }
1214
1215   // Print a unified diff header for one hunk.
1216   // The format is
1217   //   "@@ -<left_start>,<left_length> +<right_start>,<right_length> @@"
1218   // where the left/right parts are omitted if unnecessary.
1219   void PrintHeader(std::ostream* ss) const {
1220     *ss << "@@ ";
1221     if (removes_) {
1222       *ss << "-" << left_start_ << "," << (removes_ + common_);
1223     }
1224     if (removes_ && adds_) {
1225       *ss << " ";
1226     }
1227     if (adds_) {
1228       *ss << "+" << right_start_ << "," << (adds_ + common_);
1229     }
1230     *ss << " @@\n";
1231   }
1232
1233   size_t left_start_, right_start_;
1234   size_t adds_, removes_, common_;
1235   std::list<std::pair<char, const char*> > hunk_, hunk_adds_, hunk_removes_;
1236 };
1237
1238 }  // namespace
1239
1240 // Create a list of diff hunks in Unified diff format.
1241 // Each hunk has a header generated by PrintHeader above plus a body with
1242 // lines prefixed with ' ' for no change, '-' for deletion and '+' for
1243 // addition.
1244 // 'context' represents the desired unchanged prefix/suffix around the diff.
1245 // If two hunks are close enough that their contexts overlap, then they are
1246 // joined into one hunk.
1247 std::string CreateUnifiedDiff(const std::vector<std::string>& left,
1248                               const std::vector<std::string>& right,
1249                               size_t context) {
1250   const std::vector<EditType> edits = CalculateOptimalEdits(left, right);
1251
1252   size_t l_i = 0, r_i = 0, edit_i = 0;
1253   std::stringstream ss;
1254   while (edit_i < edits.size()) {
1255     // Find first edit.
1256     while (edit_i < edits.size() && edits[edit_i] == kMatch) {
1257       ++l_i;
1258       ++r_i;
1259       ++edit_i;
1260     }
1261
1262     // Find the first line to include in the hunk.
1263     const size_t prefix_context = std::min(l_i, context);
1264     Hunk hunk(l_i - prefix_context + 1, r_i - prefix_context + 1);
1265     for (size_t i = prefix_context; i > 0; --i) {
1266       hunk.PushLine(' ', left[l_i - i].c_str());
1267     }
1268
1269     // Iterate the edits until we found enough suffix for the hunk or the input
1270     // is over.
1271     size_t n_suffix = 0;
1272     for (; edit_i < edits.size(); ++edit_i) {
1273       if (n_suffix >= context) {
1274         // Continue only if the next hunk is very close.
1275         std::vector<EditType>::const_iterator it = edits.begin() + edit_i;
1276         while (it != edits.end() && *it == kMatch) ++it;
1277         if (it == edits.end() || (it - edits.begin()) - edit_i >= context) {
1278           // There is no next edit or it is too far away.
1279           break;
1280         }
1281       }
1282
1283       EditType edit = edits[edit_i];
1284       // Reset count when a non match is found.
1285       n_suffix = edit == kMatch ? n_suffix + 1 : 0;
1286
1287       if (edit == kMatch || edit == kRemove || edit == kReplace) {
1288         hunk.PushLine(edit == kMatch ? ' ' : '-', left[l_i].c_str());
1289       }
1290       if (edit == kAdd || edit == kReplace) {
1291         hunk.PushLine('+', right[r_i].c_str());
1292       }
1293
1294       // Advance indices, depending on edit type.
1295       l_i += edit != kAdd;
1296       r_i += edit != kRemove;
1297     }
1298
1299     if (!hunk.has_edits()) {
1300       // We are done. We don't want this hunk.
1301       break;
1302     }
1303
1304     hunk.PrintTo(&ss);
1305   }
1306   return ss.str();
1307 }
1308
1309 }  // namespace edit_distance
1310
1311 namespace {
1312
1313 // The string representation of the values received in EqFailure() are already
1314 // escaped. Split them on escaped '\n' boundaries. Leave all other escaped
1315 // characters the same.
1316 std::vector<std::string> SplitEscapedString(const std::string& str) {
1317   std::vector<std::string> lines;
1318   size_t start = 0, end = str.size();
1319   if (end > 2 && str[0] == '"' && str[end - 1] == '"') {
1320     ++start;
1321     --end;
1322   }
1323   bool escaped = false;
1324   for (size_t i = start; i + 1 < end; ++i) {
1325     if (escaped) {
1326       escaped = false;
1327       if (str[i] == 'n') {
1328         lines.push_back(str.substr(start, i - start - 1));
1329         start = i + 1;
1330       }
1331     } else {
1332       escaped = str[i] == '\\';
1333     }
1334   }
1335   lines.push_back(str.substr(start, end - start));
1336   return lines;
1337 }
1338
1339 }  // namespace
1340
1341 // Constructs and returns the message for an equality assertion
1342 // (e.g. ASSERT_EQ, EXPECT_STREQ, etc) failure.
1343 //
1344 // The first four parameters are the expressions used in the assertion
1345 // and their values, as strings.  For example, for ASSERT_EQ(foo, bar)
1346 // where foo is 5 and bar is 6, we have:
1347 //
1348 //   lhs_expression: "foo"
1349 //   rhs_expression: "bar"
1350 //   lhs_value:      "5"
1351 //   rhs_value:      "6"
1352 //
1353 // The ignoring_case parameter is true iff the assertion is a
1354 // *_STRCASEEQ*.  When it's true, the string "Ignoring case" will
1355 // be inserted into the message.
1356 AssertionResult EqFailure(const char* lhs_expression,
1357                           const char* rhs_expression,
1358                           const std::string& lhs_value,
1359                           const std::string& rhs_value,
1360                           bool ignoring_case) {
1361   Message msg;
1362   msg << "Expected equality of these values:";
1363   msg << "\n  " << lhs_expression;
1364   if (lhs_value != lhs_expression) {
1365     msg << "\n    Which is: " << lhs_value;
1366   }
1367   msg << "\n  " << rhs_expression;
1368   if (rhs_value != rhs_expression) {
1369     msg << "\n    Which is: " << rhs_value;
1370   }
1371
1372   if (ignoring_case) {
1373     msg << "\nIgnoring case";
1374   }
1375
1376   if (!lhs_value.empty() && !rhs_value.empty()) {
1377     const std::vector<std::string> lhs_lines =
1378         SplitEscapedString(lhs_value);
1379     const std::vector<std::string> rhs_lines =
1380         SplitEscapedString(rhs_value);
1381     if (lhs_lines.size() > 1 || rhs_lines.size() > 1) {
1382       msg << "\nWith diff:\n"
1383           << edit_distance::CreateUnifiedDiff(lhs_lines, rhs_lines);
1384     }
1385   }
1386
1387   return AssertionFailure() << msg;
1388 }
1389
1390 // Constructs a failure message for Boolean assertions such as EXPECT_TRUE.
1391 std::string GetBoolAssertionFailureMessage(
1392     const AssertionResult& assertion_result,
1393     const char* expression_text,
1394     const char* actual_predicate_value,
1395     const char* expected_predicate_value) {
1396   const char* actual_message = assertion_result.message();
1397   Message msg;
1398   msg << "Value of: " << expression_text
1399       << "\n  Actual: " << actual_predicate_value;
1400   if (actual_message[0] != '\0')
1401     msg << " (" << actual_message << ")";
1402   msg << "\nExpected: " << expected_predicate_value;
1403   return msg.GetString();
1404 }
1405
1406 // Helper function for implementing ASSERT_NEAR.
1407 AssertionResult DoubleNearPredFormat(const char* expr1,
1408                                      const char* expr2,
1409                                      const char* abs_error_expr,
1410                                      double val1,
1411                                      double val2,
1412                                      double abs_error) {
1413   const double diff = fabs(val1 - val2);
1414   if (diff <= abs_error) return AssertionSuccess();
1415
1416   // FIXME: do not print the value of an expression if it's
1417   // already a literal.
1418   return AssertionFailure()
1419       << "The difference between " << expr1 << " and " << expr2
1420       << " is " << diff << ", which exceeds " << abs_error_expr << ", where\n"
1421       << expr1 << " evaluates to " << val1 << ",\n"
1422       << expr2 << " evaluates to " << val2 << ", and\n"
1423       << abs_error_expr << " evaluates to " << abs_error << ".";
1424 }
1425
1426
1427 // Helper template for implementing FloatLE() and DoubleLE().
1428 template <typename RawType>
1429 AssertionResult FloatingPointLE(const char* expr1,
1430                                 const char* expr2,
1431                                 RawType val1,
1432                                 RawType val2) {
1433   // Returns success if val1 is less than val2,
1434   if (val1 < val2) {
1435     return AssertionSuccess();
1436   }
1437
1438   // or if val1 is almost equal to val2.
1439   const FloatingPoint<RawType> lhs(val1), rhs(val2);
1440   if (lhs.AlmostEquals(rhs)) {
1441     return AssertionSuccess();
1442   }
1443
1444   // Note that the above two checks will both fail if either val1 or
1445   // val2 is NaN, as the IEEE floating-point standard requires that
1446   // any predicate involving a NaN must return false.
1447
1448   ::std::stringstream val1_ss;
1449   val1_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
1450           << val1;
1451
1452   ::std::stringstream val2_ss;
1453   val2_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
1454           << val2;
1455
1456   return AssertionFailure()
1457       << "Expected: (" << expr1 << ") <= (" << expr2 << ")\n"
1458       << "  Actual: " << StringStreamToString(&val1_ss) << " vs "
1459       << StringStreamToString(&val2_ss);
1460 }
1461
1462 }  // namespace internal
1463
1464 // Asserts that val1 is less than, or almost equal to, val2.  Fails
1465 // otherwise.  In particular, it fails if either val1 or val2 is NaN.
1466 AssertionResult FloatLE(const char* expr1, const char* expr2,
1467                         float val1, float val2) {
1468   return internal::FloatingPointLE<float>(expr1, expr2, val1, val2);
1469 }
1470
1471 // Asserts that val1 is less than, or almost equal to, val2.  Fails
1472 // otherwise.  In particular, it fails if either val1 or val2 is NaN.
1473 AssertionResult DoubleLE(const char* expr1, const char* expr2,
1474                          double val1, double val2) {
1475   return internal::FloatingPointLE<double>(expr1, expr2, val1, val2);
1476 }
1477
1478 namespace internal {
1479
1480 // The helper function for {ASSERT|EXPECT}_EQ with int or enum
1481 // arguments.
1482 AssertionResult CmpHelperEQ(const char* lhs_expression,
1483                             const char* rhs_expression,
1484                             BiggestInt lhs,
1485                             BiggestInt rhs) {
1486   if (lhs == rhs) {
1487     return AssertionSuccess();
1488   }
1489
1490   return EqFailure(lhs_expression,
1491                    rhs_expression,
1492                    FormatForComparisonFailureMessage(lhs, rhs),
1493                    FormatForComparisonFailureMessage(rhs, lhs),
1494                    false);
1495 }
1496
1497 // A macro for implementing the helper functions needed to implement
1498 // ASSERT_?? and EXPECT_?? with integer or enum arguments.  It is here
1499 // just to avoid copy-and-paste of similar code.
1500 #define GTEST_IMPL_CMP_HELPER_(op_name, op)\
1501 AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \
1502                                    BiggestInt val1, BiggestInt val2) {\
1503   if (val1 op val2) {\
1504     return AssertionSuccess();\
1505   } else {\
1506     return AssertionFailure() \
1507         << "Expected: (" << expr1 << ") " #op " (" << expr2\
1508         << "), actual: " << FormatForComparisonFailureMessage(val1, val2)\
1509         << " vs " << FormatForComparisonFailureMessage(val2, val1);\
1510   }\
1511 }
1512
1513 // Implements the helper function for {ASSERT|EXPECT}_NE with int or
1514 // enum arguments.
1515 GTEST_IMPL_CMP_HELPER_(NE, !=)
1516 // Implements the helper function for {ASSERT|EXPECT}_LE with int or
1517 // enum arguments.
1518 GTEST_IMPL_CMP_HELPER_(LE, <=)
1519 // Implements the helper function for {ASSERT|EXPECT}_LT with int or
1520 // enum arguments.
1521 GTEST_IMPL_CMP_HELPER_(LT, < )
1522 // Implements the helper function for {ASSERT|EXPECT}_GE with int or
1523 // enum arguments.
1524 GTEST_IMPL_CMP_HELPER_(GE, >=)
1525 // Implements the helper function for {ASSERT|EXPECT}_GT with int or
1526 // enum arguments.
1527 GTEST_IMPL_CMP_HELPER_(GT, > )
1528
1529 #undef GTEST_IMPL_CMP_HELPER_
1530
1531 // The helper function for {ASSERT|EXPECT}_STREQ.
1532 AssertionResult CmpHelperSTREQ(const char* lhs_expression,
1533                                const char* rhs_expression,
1534                                const char* lhs,
1535                                const char* rhs) {
1536   if (String::CStringEquals(lhs, rhs)) {
1537     return AssertionSuccess();
1538   }
1539
1540   return EqFailure(lhs_expression,
1541                    rhs_expression,
1542                    PrintToString(lhs),
1543                    PrintToString(rhs),
1544                    false);
1545 }
1546
1547 // The helper function for {ASSERT|EXPECT}_STRCASEEQ.
1548 AssertionResult CmpHelperSTRCASEEQ(const char* lhs_expression,
1549                                    const char* rhs_expression,
1550                                    const char* lhs,
1551                                    const char* rhs) {
1552   if (String::CaseInsensitiveCStringEquals(lhs, rhs)) {
1553     return AssertionSuccess();
1554   }
1555
1556   return EqFailure(lhs_expression,
1557                    rhs_expression,
1558                    PrintToString(lhs),
1559                    PrintToString(rhs),
1560                    true);
1561 }
1562
1563 // The helper function for {ASSERT|EXPECT}_STRNE.
1564 AssertionResult CmpHelperSTRNE(const char* s1_expression,
1565                                const char* s2_expression,
1566                                const char* s1,
1567                                const char* s2) {
1568   if (!String::CStringEquals(s1, s2)) {
1569     return AssertionSuccess();
1570   } else {
1571     return AssertionFailure() << "Expected: (" << s1_expression << ") != ("
1572                               << s2_expression << "), actual: \""
1573                               << s1 << "\" vs \"" << s2 << "\"";
1574   }
1575 }
1576
1577 // The helper function for {ASSERT|EXPECT}_STRCASENE.
1578 AssertionResult CmpHelperSTRCASENE(const char* s1_expression,
1579                                    const char* s2_expression,
1580                                    const char* s1,
1581                                    const char* s2) {
1582   if (!String::CaseInsensitiveCStringEquals(s1, s2)) {
1583     return AssertionSuccess();
1584   } else {
1585     return AssertionFailure()
1586         << "Expected: (" << s1_expression << ") != ("
1587         << s2_expression << ") (ignoring case), actual: \""
1588         << s1 << "\" vs \"" << s2 << "\"";
1589   }
1590 }
1591
1592 }  // namespace internal
1593
1594 namespace {
1595
1596 // Helper functions for implementing IsSubString() and IsNotSubstring().
1597
1598 // This group of overloaded functions return true iff needle is a
1599 // substring of haystack.  NULL is considered a substring of itself
1600 // only.
1601
1602 bool IsSubstringPred(const char* needle, const char* haystack) {
1603   if (needle == NULL || haystack == NULL)
1604     return needle == haystack;
1605
1606   return strstr(haystack, needle) != NULL;
1607 }
1608
1609 bool IsSubstringPred(const wchar_t* needle, const wchar_t* haystack) {
1610   if (needle == NULL || haystack == NULL)
1611     return needle == haystack;
1612
1613   return wcsstr(haystack, needle) != NULL;
1614 }
1615
1616 // StringType here can be either ::std::string or ::std::wstring.
1617 template <typename StringType>
1618 bool IsSubstringPred(const StringType& needle,
1619                      const StringType& haystack) {
1620   return haystack.find(needle) != StringType::npos;
1621 }
1622
1623 // This function implements either IsSubstring() or IsNotSubstring(),
1624 // depending on the value of the expected_to_be_substring parameter.
1625 // StringType here can be const char*, const wchar_t*, ::std::string,
1626 // or ::std::wstring.
1627 template <typename StringType>
1628 AssertionResult IsSubstringImpl(
1629     bool expected_to_be_substring,
1630     const char* needle_expr, const char* haystack_expr,
1631     const StringType& needle, const StringType& haystack) {
1632   if (IsSubstringPred(needle, haystack) == expected_to_be_substring)
1633     return AssertionSuccess();
1634
1635   const bool is_wide_string = sizeof(needle[0]) > 1;
1636   const char* const begin_string_quote = is_wide_string ? "L\"" : "\"";
1637   return AssertionFailure()
1638       << "Value of: " << needle_expr << "\n"
1639       << "  Actual: " << begin_string_quote << needle << "\"\n"
1640       << "Expected: " << (expected_to_be_substring ? "" : "not ")
1641       << "a substring of " << haystack_expr << "\n"
1642       << "Which is: " << begin_string_quote << haystack << "\"";
1643 }
1644
1645 }  // namespace
1646
1647 // IsSubstring() and IsNotSubstring() check whether needle is a
1648 // substring of haystack (NULL is considered a substring of itself
1649 // only), and return an appropriate error message when they fail.
1650
1651 AssertionResult IsSubstring(
1652     const char* needle_expr, const char* haystack_expr,
1653     const char* needle, const char* haystack) {
1654   return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack);
1655 }
1656
1657 AssertionResult IsSubstring(
1658     const char* needle_expr, const char* haystack_expr,
1659     const wchar_t* needle, const wchar_t* haystack) {
1660   return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack);
1661 }
1662
1663 AssertionResult IsNotSubstring(
1664     const char* needle_expr, const char* haystack_expr,
1665     const char* needle, const char* haystack) {
1666   return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack);
1667 }
1668
1669 AssertionResult IsNotSubstring(
1670     const char* needle_expr, const char* haystack_expr,
1671     const wchar_t* needle, const wchar_t* haystack) {
1672   return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack);
1673 }
1674
1675 AssertionResult IsSubstring(
1676     const char* needle_expr, const char* haystack_expr,
1677     const ::std::string& needle, const ::std::string& haystack) {
1678   return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack);
1679 }
1680
1681 AssertionResult IsNotSubstring(
1682     const char* needle_expr, const char* haystack_expr,
1683     const ::std::string& needle, const ::std::string& haystack) {
1684   return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack);
1685 }
1686
1687 #if GTEST_HAS_STD_WSTRING
1688 AssertionResult IsSubstring(
1689     const char* needle_expr, const char* haystack_expr,
1690     const ::std::wstring& needle, const ::std::wstring& haystack) {
1691   return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack);
1692 }
1693
1694 AssertionResult IsNotSubstring(
1695     const char* needle_expr, const char* haystack_expr,
1696     const ::std::wstring& needle, const ::std::wstring& haystack) {
1697   return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack);
1698 }
1699 #endif  // GTEST_HAS_STD_WSTRING
1700
1701 namespace internal {
1702
1703 #if GTEST_OS_WINDOWS
1704
1705 namespace {
1706
1707 // Helper function for IsHRESULT{SuccessFailure} predicates
1708 AssertionResult HRESULTFailureHelper(const char* expr,
1709                                      const char* expected,
1710                                      long hr) {  // NOLINT
1711 # if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_WINDOWS_TV_TITLE
1712
1713   // Windows CE doesn't support FormatMessage.
1714   const char error_text[] = "";
1715
1716 # else
1717
1718   // Looks up the human-readable system message for the HRESULT code
1719   // and since we're not passing any params to FormatMessage, we don't
1720   // want inserts expanded.
1721   const DWORD kFlags = FORMAT_MESSAGE_FROM_SYSTEM |
1722                        FORMAT_MESSAGE_IGNORE_INSERTS;
1723   const DWORD kBufSize = 4096;
1724   // Gets the system's human readable message string for this HRESULT.
1725   char error_text[kBufSize] = { '\0' };
1726   DWORD message_length = ::FormatMessageA(kFlags,
1727                                           0,  // no source, we're asking system
1728                                           hr,  // the error
1729                                           0,  // no line width restrictions
1730                                           error_text,  // output buffer
1731                                           kBufSize,  // buf size
1732                                           NULL);  // no arguments for inserts
1733   // Trims tailing white space (FormatMessage leaves a trailing CR-LF)
1734   for (; message_length && IsSpace(error_text[message_length - 1]);
1735           --message_length) {
1736     error_text[message_length - 1] = '\0';
1737   }
1738
1739 # endif  // GTEST_OS_WINDOWS_MOBILE
1740
1741   const std::string error_hex("0x" + String::FormatHexInt(hr));
1742   return ::testing::AssertionFailure()
1743       << "Expected: " << expr << " " << expected << ".\n"
1744       << "  Actual: " << error_hex << " " << error_text << "\n";
1745 }
1746
1747 }  // namespace
1748
1749 AssertionResult IsHRESULTSuccess(const char* expr, long hr) {  // NOLINT
1750   if (SUCCEEDED(hr)) {
1751     return AssertionSuccess();
1752   }
1753   return HRESULTFailureHelper(expr, "succeeds", hr);
1754 }
1755
1756 AssertionResult IsHRESULTFailure(const char* expr, long hr) {  // NOLINT
1757   if (FAILED(hr)) {
1758     return AssertionSuccess();
1759   }
1760   return HRESULTFailureHelper(expr, "fails", hr);
1761 }
1762
1763 #endif  // GTEST_OS_WINDOWS
1764
1765 // Utility functions for encoding Unicode text (wide strings) in
1766 // UTF-8.
1767
1768 // A Unicode code-point can have up to 21 bits, and is encoded in UTF-8
1769 // like this:
1770 //
1771 // Code-point length   Encoding
1772 //   0 -  7 bits       0xxxxxxx
1773 //   8 - 11 bits       110xxxxx 10xxxxxx
1774 //  12 - 16 bits       1110xxxx 10xxxxxx 10xxxxxx
1775 //  17 - 21 bits       11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
1776
1777 // The maximum code-point a one-byte UTF-8 sequence can represent.
1778 const UInt32 kMaxCodePoint1 = (static_cast<UInt32>(1) <<  7) - 1;
1779
1780 // The maximum code-point a two-byte UTF-8 sequence can represent.
1781 const UInt32 kMaxCodePoint2 = (static_cast<UInt32>(1) << (5 + 6)) - 1;
1782
1783 // The maximum code-point a three-byte UTF-8 sequence can represent.
1784 const UInt32 kMaxCodePoint3 = (static_cast<UInt32>(1) << (4 + 2*6)) - 1;
1785
1786 // The maximum code-point a four-byte UTF-8 sequence can represent.
1787 const UInt32 kMaxCodePoint4 = (static_cast<UInt32>(1) << (3 + 3*6)) - 1;
1788
1789 // Chops off the n lowest bits from a bit pattern.  Returns the n
1790 // lowest bits.  As a side effect, the original bit pattern will be
1791 // shifted to the right by n bits.
1792 inline UInt32 ChopLowBits(UInt32* bits, int n) {
1793   const UInt32 low_bits = *bits & ((static_cast<UInt32>(1) << n) - 1);
1794   *bits >>= n;
1795   return low_bits;
1796 }
1797
1798 // Converts a Unicode code point to a narrow string in UTF-8 encoding.
1799 // code_point parameter is of type UInt32 because wchar_t may not be
1800 // wide enough to contain a code point.
1801 // If the code_point is not a valid Unicode code point
1802 // (i.e. outside of Unicode range U+0 to U+10FFFF) it will be converted
1803 // to "(Invalid Unicode 0xXXXXXXXX)".
1804 std::string CodePointToUtf8(UInt32 code_point) {
1805   if (code_point > kMaxCodePoint4) {
1806     return "(Invalid Unicode 0x" + String::FormatHexInt(code_point) + ")";
1807   }
1808
1809   char str[5];  // Big enough for the largest valid code point.
1810   if (code_point <= kMaxCodePoint1) {
1811     str[1] = '\0';
1812     str[0] = static_cast<char>(code_point);                          // 0xxxxxxx
1813   } else if (code_point <= kMaxCodePoint2) {
1814     str[2] = '\0';
1815     str[1] = static_cast<char>(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
1816     str[0] = static_cast<char>(0xC0 | code_point);                   // 110xxxxx
1817   } else if (code_point <= kMaxCodePoint3) {
1818     str[3] = '\0';
1819     str[2] = static_cast<char>(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
1820     str[1] = static_cast<char>(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
1821     str[0] = static_cast<char>(0xE0 | code_point);                   // 1110xxxx
1822   } else {  // code_point <= kMaxCodePoint4
1823     str[4] = '\0';
1824     str[3] = static_cast<char>(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
1825     str[2] = static_cast<char>(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
1826     str[1] = static_cast<char>(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
1827     str[0] = static_cast<char>(0xF0 | code_point);                   // 11110xxx
1828   }
1829   return str;
1830 }
1831
1832 // The following two functions only make sense if the system
1833 // uses UTF-16 for wide string encoding. All supported systems
1834 // with 16 bit wchar_t (Windows, Cygwin, Symbian OS) do use UTF-16.
1835
1836 // Determines if the arguments constitute UTF-16 surrogate pair
1837 // and thus should be combined into a single Unicode code point
1838 // using CreateCodePointFromUtf16SurrogatePair.
1839 inline bool IsUtf16SurrogatePair(wchar_t first, wchar_t second) {
1840   return sizeof(wchar_t) == 2 &&
1841       (first & 0xFC00) == 0xD800 && (second & 0xFC00) == 0xDC00;
1842 }
1843
1844 // Creates a Unicode code point from UTF16 surrogate pair.
1845 inline UInt32 CreateCodePointFromUtf16SurrogatePair(wchar_t first,
1846                                                     wchar_t second) {
1847   const UInt32 mask = (1 << 10) - 1;
1848   return (sizeof(wchar_t) == 2) ?
1849       (((first & mask) << 10) | (second & mask)) + 0x10000 :
1850       // This function should not be called when the condition is
1851       // false, but we provide a sensible default in case it is.
1852       static_cast<UInt32>(first);
1853 }
1854
1855 // Converts a wide string to a narrow string in UTF-8 encoding.
1856 // The wide string is assumed to have the following encoding:
1857 //   UTF-16 if sizeof(wchar_t) == 2 (on Windows, Cygwin, Symbian OS)
1858 //   UTF-32 if sizeof(wchar_t) == 4 (on Linux)
1859 // Parameter str points to a null-terminated wide string.
1860 // Parameter num_chars may additionally limit the number
1861 // of wchar_t characters processed. -1 is used when the entire string
1862 // should be processed.
1863 // If the string contains code points that are not valid Unicode code points
1864 // (i.e. outside of Unicode range U+0 to U+10FFFF) they will be output
1865 // as '(Invalid Unicode 0xXXXXXXXX)'. If the string is in UTF16 encoding
1866 // and contains invalid UTF-16 surrogate pairs, values in those pairs
1867 // will be encoded as individual Unicode characters from Basic Normal Plane.
1868 std::string WideStringToUtf8(const wchar_t* str, int num_chars) {
1869   if (num_chars == -1)
1870     num_chars = static_cast<int>(wcslen(str));
1871
1872   ::std::stringstream stream;
1873   for (int i = 0; i < num_chars; ++i) {
1874     UInt32 unicode_code_point;
1875
1876     if (str[i] == L'\0') {
1877       break;
1878     } else if (i + 1 < num_chars && IsUtf16SurrogatePair(str[i], str[i + 1])) {
1879       unicode_code_point = CreateCodePointFromUtf16SurrogatePair(str[i],
1880                                                                  str[i + 1]);
1881       i++;
1882     } else {
1883       unicode_code_point = static_cast<UInt32>(str[i]);
1884     }
1885
1886     stream << CodePointToUtf8(unicode_code_point);
1887   }
1888   return StringStreamToString(&stream);
1889 }
1890
1891 // Converts a wide C string to an std::string using the UTF-8 encoding.
1892 // NULL will be converted to "(null)".
1893 std::string String::ShowWideCString(const wchar_t * wide_c_str) {
1894   if (wide_c_str == NULL)  return "(null)";
1895
1896   return internal::WideStringToUtf8(wide_c_str, -1);
1897 }
1898
1899 // Compares two wide C strings.  Returns true iff they have the same
1900 // content.
1901 //
1902 // Unlike wcscmp(), this function can handle NULL argument(s).  A NULL
1903 // C string is considered different to any non-NULL C string,
1904 // including the empty string.
1905 bool String::WideCStringEquals(const wchar_t * lhs, const wchar_t * rhs) {
1906   if (lhs == NULL) return rhs == NULL;
1907
1908   if (rhs == NULL) return false;
1909
1910   return wcscmp(lhs, rhs) == 0;
1911 }
1912
1913 // Helper function for *_STREQ on wide strings.
1914 AssertionResult CmpHelperSTREQ(const char* lhs_expression,
1915                                const char* rhs_expression,
1916                                const wchar_t* lhs,
1917                                const wchar_t* rhs) {
1918   if (String::WideCStringEquals(lhs, rhs)) {
1919     return AssertionSuccess();
1920   }
1921
1922   return EqFailure(lhs_expression,
1923                    rhs_expression,
1924                    PrintToString(lhs),
1925                    PrintToString(rhs),
1926                    false);
1927 }
1928
1929 // Helper function for *_STRNE on wide strings.
1930 AssertionResult CmpHelperSTRNE(const char* s1_expression,
1931                                const char* s2_expression,
1932                                const wchar_t* s1,
1933                                const wchar_t* s2) {
1934   if (!String::WideCStringEquals(s1, s2)) {
1935     return AssertionSuccess();
1936   }
1937
1938   return AssertionFailure() << "Expected: (" << s1_expression << ") != ("
1939                             << s2_expression << "), actual: "
1940                             << PrintToString(s1)
1941                             << " vs " << PrintToString(s2);
1942 }
1943
1944 // Compares two C strings, ignoring case.  Returns true iff they have
1945 // the same content.
1946 //
1947 // Unlike strcasecmp(), this function can handle NULL argument(s).  A
1948 // NULL C string is considered different to any non-NULL C string,
1949 // including the empty string.
1950 bool String::CaseInsensitiveCStringEquals(const char * lhs, const char * rhs) {
1951   if (lhs == NULL)
1952     return rhs == NULL;
1953   if (rhs == NULL)
1954     return false;
1955   return posix::StrCaseCmp(lhs, rhs) == 0;
1956 }
1957
1958   // Compares two wide C strings, ignoring case.  Returns true iff they
1959   // have the same content.
1960   //
1961   // Unlike wcscasecmp(), this function can handle NULL argument(s).
1962   // A NULL C string is considered different to any non-NULL wide C string,
1963   // including the empty string.
1964   // NB: The implementations on different platforms slightly differ.
1965   // On windows, this method uses _wcsicmp which compares according to LC_CTYPE
1966   // environment variable. On GNU platform this method uses wcscasecmp
1967   // which compares according to LC_CTYPE category of the current locale.
1968   // On MacOS X, it uses towlower, which also uses LC_CTYPE category of the
1969   // current locale.
1970 bool String::CaseInsensitiveWideCStringEquals(const wchar_t* lhs,
1971                                               const wchar_t* rhs) {
1972   if (lhs == NULL) return rhs == NULL;
1973
1974   if (rhs == NULL) return false;
1975
1976 #if GTEST_OS_WINDOWS
1977   return _wcsicmp(lhs, rhs) == 0;
1978 #elif GTEST_OS_LINUX && !GTEST_OS_LINUX_ANDROID
1979   return wcscasecmp(lhs, rhs) == 0;
1980 #else
1981   // Android, Mac OS X and Cygwin don't define wcscasecmp.
1982   // Other unknown OSes may not define it either.
1983   wint_t left, right;
1984   do {
1985     left = towlower(*lhs++);
1986     right = towlower(*rhs++);
1987   } while (left && left == right);
1988   return left == right;
1989 #endif  // OS selector
1990 }
1991
1992 // Returns true iff str ends with the given suffix, ignoring case.
1993 // Any string is considered to end with an empty suffix.
1994 bool String::EndsWithCaseInsensitive(
1995     const std::string& str, const std::string& suffix) {
1996   const size_t str_len = str.length();
1997   const size_t suffix_len = suffix.length();
1998   return (str_len >= suffix_len) &&
1999          CaseInsensitiveCStringEquals(str.c_str() + str_len - suffix_len,
2000                                       suffix.c_str());
2001 }
2002
2003 // Formats an int value as "%02d".
2004 std::string String::FormatIntWidth2(int value) {
2005   std::stringstream ss;
2006   ss << std::setfill('0') << std::setw(2) << value;
2007   return ss.str();
2008 }
2009
2010 // Formats an int value as "%X".
2011 std::string String::FormatHexInt(int value) {
2012   std::stringstream ss;
2013   ss << std::hex << std::uppercase << value;
2014   return ss.str();
2015 }
2016
2017 // Formats a byte as "%02X".
2018 std::string String::FormatByte(unsigned char value) {
2019   std::stringstream ss;
2020   ss << std::setfill('0') << std::setw(2) << std::hex << std::uppercase
2021      << static_cast<unsigned int>(value);
2022   return ss.str();
2023 }
2024
2025 // Converts the buffer in a stringstream to an std::string, converting NUL
2026 // bytes to "\\0" along the way.
2027 std::string StringStreamToString(::std::stringstream* ss) {
2028   const ::std::string& str = ss->str();
2029   const char* const start = str.c_str();
2030   const char* const end = start + str.length();
2031
2032   std::string result;
2033   result.reserve(2 * (end - start));
2034   for (const char* ch = start; ch != end; ++ch) {
2035     if (*ch == '\0') {
2036       result += "\\0";  // Replaces NUL with "\\0";
2037     } else {
2038       result += *ch;
2039     }
2040   }
2041
2042   return result;
2043 }
2044
2045 // Appends the user-supplied message to the Google-Test-generated message.
2046 std::string AppendUserMessage(const std::string& gtest_msg,
2047                               const Message& user_msg) {
2048   // Appends the user message if it's non-empty.
2049   const std::string user_msg_string = user_msg.GetString();
2050   if (user_msg_string.empty()) {
2051     return gtest_msg;
2052   }
2053
2054   return gtest_msg + "\n" + user_msg_string;
2055 }
2056
2057 }  // namespace internal
2058
2059 // class TestResult
2060
2061 // Creates an empty TestResult.
2062 TestResult::TestResult()
2063     : death_test_count_(0),
2064       elapsed_time_(0) {
2065 }
2066
2067 // D'tor.
2068 TestResult::~TestResult() {
2069 }
2070
2071 // Returns the i-th test part result among all the results. i can
2072 // range from 0 to total_part_count() - 1. If i is not in that range,
2073 // aborts the program.
2074 const TestPartResult& TestResult::GetTestPartResult(int i) const {
2075   if (i < 0 || i >= total_part_count())
2076     internal::posix::Abort();
2077   return test_part_results_.at(i);
2078 }
2079
2080 // Returns the i-th test property. i can range from 0 to
2081 // test_property_count() - 1. If i is not in that range, aborts the
2082 // program.
2083 const TestProperty& TestResult::GetTestProperty(int i) const {
2084   if (i < 0 || i >= test_property_count())
2085     internal::posix::Abort();
2086   return test_properties_.at(i);
2087 }
2088
2089 // Clears the test part results.
2090 void TestResult::ClearTestPartResults() {
2091   test_part_results_.clear();
2092 }
2093
2094 // Adds a test part result to the list.
2095 void TestResult::AddTestPartResult(const TestPartResult& test_part_result) {
2096   test_part_results_.push_back(test_part_result);
2097 }
2098
2099 // Adds a test property to the list. If a property with the same key as the
2100 // supplied property is already represented, the value of this test_property
2101 // replaces the old value for that key.
2102 void TestResult::RecordProperty(const std::string& xml_element,
2103                                 const TestProperty& test_property) {
2104   if (!ValidateTestProperty(xml_element, test_property)) {
2105     return;
2106   }
2107   internal::MutexLock lock(&test_properites_mutex_);
2108   const std::vector<TestProperty>::iterator property_with_matching_key =
2109       std::find_if(test_properties_.begin(), test_properties_.end(),
2110                    internal::TestPropertyKeyIs(test_property.key()));
2111   if (property_with_matching_key == test_properties_.end()) {
2112     test_properties_.push_back(test_property);
2113     return;
2114   }
2115   property_with_matching_key->SetValue(test_property.value());
2116 }
2117
2118 // The list of reserved attributes used in the <testsuites> element of XML
2119 // output.
2120 static const char* const kReservedTestSuitesAttributes[] = {
2121   "disabled",
2122   "errors",
2123   "failures",
2124   "name",
2125   "random_seed",
2126   "tests",
2127   "time",
2128   "timestamp"
2129 };
2130
2131 // The list of reserved attributes used in the <testsuite> element of XML
2132 // output.
2133 static const char* const kReservedTestSuiteAttributes[] = {
2134   "disabled",
2135   "errors",
2136   "failures",
2137   "name",
2138   "tests",
2139   "time"
2140 };
2141
2142 // The list of reserved attributes used in the <testcase> element of XML output.
2143 static const char* const kReservedTestCaseAttributes[] = {
2144     "classname",  "name",        "status", "time",
2145     "type_param", "value_param", "file",   "line"};
2146
2147 template <int kSize>
2148 std::vector<std::string> ArrayAsVector(const char* const (&array)[kSize]) {
2149   return std::vector<std::string>(array, array + kSize);
2150 }
2151
2152 static std::vector<std::string> GetReservedAttributesForElement(
2153     const std::string& xml_element) {
2154   if (xml_element == "testsuites") {
2155     return ArrayAsVector(kReservedTestSuitesAttributes);
2156   } else if (xml_element == "testsuite") {
2157     return ArrayAsVector(kReservedTestSuiteAttributes);
2158   } else if (xml_element == "testcase") {
2159     return ArrayAsVector(kReservedTestCaseAttributes);
2160   } else {
2161     GTEST_CHECK_(false) << "Unrecognized xml_element provided: " << xml_element;
2162   }
2163   // This code is unreachable but some compilers may not realizes that.
2164   return std::vector<std::string>();
2165 }
2166
2167 static std::string FormatWordList(const std::vector<std::string>& words) {
2168   Message word_list;
2169   for (size_t i = 0; i < words.size(); ++i) {
2170     if (i > 0 && words.size() > 2) {
2171       word_list << ", ";
2172     }
2173     if (i == words.size() - 1) {
2174       word_list << "and ";
2175     }
2176     word_list << "'" << words[i] << "'";
2177   }
2178   return word_list.GetString();
2179 }
2180
2181 static bool ValidateTestPropertyName(
2182     const std::string& property_name,
2183     const std::vector<std::string>& reserved_names) {
2184   if (std::find(reserved_names.begin(), reserved_names.end(), property_name) !=
2185           reserved_names.end()) {
2186     ADD_FAILURE() << "Reserved key used in RecordProperty(): " << property_name
2187                   << " (" << FormatWordList(reserved_names)
2188                   << " are reserved by " << GTEST_NAME_ << ")";
2189     return false;
2190   }
2191   return true;
2192 }
2193
2194 // Adds a failure if the key is a reserved attribute of the element named
2195 // xml_element.  Returns true if the property is valid.
2196 bool TestResult::ValidateTestProperty(const std::string& xml_element,
2197                                       const TestProperty& test_property) {
2198   return ValidateTestPropertyName(test_property.key(),
2199                                   GetReservedAttributesForElement(xml_element));
2200 }
2201
2202 // Clears the object.
2203 void TestResult::Clear() {
2204   test_part_results_.clear();
2205   test_properties_.clear();
2206   death_test_count_ = 0;
2207   elapsed_time_ = 0;
2208 }
2209
2210 // Returns true iff the test failed.
2211 bool TestResult::Failed() const {
2212   for (int i = 0; i < total_part_count(); ++i) {
2213     if (GetTestPartResult(i).failed())
2214       return true;
2215   }
2216   return false;
2217 }
2218
2219 // Returns true iff the test part fatally failed.
2220 static bool TestPartFatallyFailed(const TestPartResult& result) {
2221   return result.fatally_failed();
2222 }
2223
2224 // Returns true iff the test fatally failed.
2225 bool TestResult::HasFatalFailure() const {
2226   return CountIf(test_part_results_, TestPartFatallyFailed) > 0;
2227 }
2228
2229 // Returns true iff the test part non-fatally failed.
2230 static bool TestPartNonfatallyFailed(const TestPartResult& result) {
2231   return result.nonfatally_failed();
2232 }
2233
2234 // Returns true iff the test has a non-fatal failure.
2235 bool TestResult::HasNonfatalFailure() const {
2236   return CountIf(test_part_results_, TestPartNonfatallyFailed) > 0;
2237 }
2238
2239 // Gets the number of all test parts.  This is the sum of the number
2240 // of successful test parts and the number of failed test parts.
2241 int TestResult::total_part_count() const {
2242   return static_cast<int>(test_part_results_.size());
2243 }
2244
2245 // Returns the number of the test properties.
2246 int TestResult::test_property_count() const {
2247   return static_cast<int>(test_properties_.size());
2248 }
2249
2250 // class Test
2251
2252 // Creates a Test object.
2253
2254 // The c'tor saves the states of all flags.
2255 Test::Test()
2256     : gtest_flag_saver_(new GTEST_FLAG_SAVER_) {
2257 }
2258
2259 // The d'tor restores the states of all flags.  The actual work is
2260 // done by the d'tor of the gtest_flag_saver_ field, and thus not
2261 // visible here.
2262 Test::~Test() {
2263 }
2264
2265 // Sets up the test fixture.
2266 //
2267 // A sub-class may override this.
2268 void Test::SetUp() {
2269 }
2270
2271 // Tears down the test fixture.
2272 //
2273 // A sub-class may override this.
2274 void Test::TearDown() {
2275 }
2276
2277 // Allows user supplied key value pairs to be recorded for later output.
2278 void Test::RecordProperty(const std::string& key, const std::string& value) {
2279   UnitTest::GetInstance()->RecordProperty(key, value);
2280 }
2281
2282 // Allows user supplied key value pairs to be recorded for later output.
2283 void Test::RecordProperty(const std::string& key, int value) {
2284   Message value_message;
2285   value_message << value;
2286   RecordProperty(key, value_message.GetString().c_str());
2287 }
2288
2289 namespace internal {
2290
2291 void ReportFailureInUnknownLocation(TestPartResult::Type result_type,
2292                                     const std::string& message) {
2293   // This function is a friend of UnitTest and as such has access to
2294   // AddTestPartResult.
2295   UnitTest::GetInstance()->AddTestPartResult(
2296       result_type,
2297       NULL,  // No info about the source file where the exception occurred.
2298       -1,    // We have no info on which line caused the exception.
2299       message,
2300       "");   // No stack trace, either.
2301 }
2302
2303 }  // namespace internal
2304
2305 // Google Test requires all tests in the same test case to use the same test
2306 // fixture class.  This function checks if the current test has the
2307 // same fixture class as the first test in the current test case.  If
2308 // yes, it returns true; otherwise it generates a Google Test failure and
2309 // returns false.
2310 bool Test::HasSameFixtureClass() {
2311   internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
2312   const TestCase* const test_case = impl->current_test_case();
2313
2314   // Info about the first test in the current test case.
2315   const TestInfo* const first_test_info = test_case->test_info_list()[0];
2316   const internal::TypeId first_fixture_id = first_test_info->fixture_class_id_;
2317   const char* const first_test_name = first_test_info->name();
2318
2319   // Info about the current test.
2320   const TestInfo* const this_test_info = impl->current_test_info();
2321   const internal::TypeId this_fixture_id = this_test_info->fixture_class_id_;
2322   const char* const this_test_name = this_test_info->name();
2323
2324   if (this_fixture_id != first_fixture_id) {
2325     // Is the first test defined using TEST?
2326     const bool first_is_TEST = first_fixture_id == internal::GetTestTypeId();
2327     // Is this test defined using TEST?
2328     const bool this_is_TEST = this_fixture_id == internal::GetTestTypeId();
2329
2330     if (first_is_TEST || this_is_TEST) {
2331       // Both TEST and TEST_F appear in same test case, which is incorrect.
2332       // Tell the user how to fix this.
2333
2334       // Gets the name of the TEST and the name of the TEST_F.  Note
2335       // that first_is_TEST and this_is_TEST cannot both be true, as
2336       // the fixture IDs are different for the two tests.
2337       const char* const TEST_name =
2338           first_is_TEST ? first_test_name : this_test_name;
2339       const char* const TEST_F_name =
2340           first_is_TEST ? this_test_name : first_test_name;
2341
2342       ADD_FAILURE()
2343           << "All tests in the same test case must use the same test fixture\n"
2344           << "class, so mixing TEST_F and TEST in the same test case is\n"
2345           << "illegal.  In test case " << this_test_info->test_case_name()
2346           << ",\n"
2347           << "test " << TEST_F_name << " is defined using TEST_F but\n"
2348           << "test " << TEST_name << " is defined using TEST.  You probably\n"
2349           << "want to change the TEST to TEST_F or move it to another test\n"
2350           << "case.";
2351     } else {
2352       // Two fixture classes with the same name appear in two different
2353       // namespaces, which is not allowed. Tell the user how to fix this.
2354       ADD_FAILURE()
2355           << "All tests in the same test case must use the same test fixture\n"
2356           << "class.  However, in test case "
2357           << this_test_info->test_case_name() << ",\n"
2358           << "you defined test " << first_test_name
2359           << " and test " << this_test_name << "\n"
2360           << "using two different test fixture classes.  This can happen if\n"
2361           << "the two classes are from different namespaces or translation\n"
2362           << "units and have the same name.  You should probably rename one\n"
2363           << "of the classes to put the tests into different test cases.";
2364     }
2365     return false;
2366   }
2367
2368   return true;
2369 }
2370
2371 #if GTEST_HAS_SEH
2372
2373 // Adds an "exception thrown" fatal failure to the current test.  This
2374 // function returns its result via an output parameter pointer because VC++
2375 // prohibits creation of objects with destructors on stack in functions
2376 // using __try (see error C2712).
2377 static std::string* FormatSehExceptionMessage(DWORD exception_code,
2378                                               const char* location) {
2379   Message message;
2380   message << "SEH exception with code 0x" << std::setbase(16) <<
2381     exception_code << std::setbase(10) << " thrown in " << location << ".";
2382
2383   return new std::string(message.GetString());
2384 }
2385
2386 #endif  // GTEST_HAS_SEH
2387
2388 namespace internal {
2389
2390 #if GTEST_HAS_EXCEPTIONS
2391
2392 // Adds an "exception thrown" fatal failure to the current test.
2393 static std::string FormatCxxExceptionMessage(const char* description,
2394                                              const char* location) {
2395   Message message;
2396   if (description != NULL) {
2397     message << "C++ exception with description \"" << description << "\"";
2398   } else {
2399     message << "Unknown C++ exception";
2400   }
2401   message << " thrown in " << location << ".";
2402
2403   return message.GetString();
2404 }
2405
2406 static std::string PrintTestPartResultToString(
2407     const TestPartResult& test_part_result);
2408
2409 GoogleTestFailureException::GoogleTestFailureException(
2410     const TestPartResult& failure)
2411     : ::std::runtime_error(PrintTestPartResultToString(failure).c_str()) {}
2412
2413 #endif  // GTEST_HAS_EXCEPTIONS
2414
2415 // We put these helper functions in the internal namespace as IBM's xlC
2416 // compiler rejects the code if they were declared static.
2417
2418 // Runs the given method and handles SEH exceptions it throws, when
2419 // SEH is supported; returns the 0-value for type Result in case of an
2420 // SEH exception.  (Microsoft compilers cannot handle SEH and C++
2421 // exceptions in the same function.  Therefore, we provide a separate
2422 // wrapper function for handling SEH exceptions.)
2423 template <class T, typename Result>
2424 Result HandleSehExceptionsInMethodIfSupported(
2425     T* object, Result (T::*method)(), const char* location) {
2426 #if GTEST_HAS_SEH
2427   __try {
2428     return (object->*method)();
2429   } __except (internal::UnitTestOptions::GTestShouldProcessSEH(  // NOLINT
2430       GetExceptionCode())) {
2431     // We create the exception message on the heap because VC++ prohibits
2432     // creation of objects with destructors on stack in functions using __try
2433     // (see error C2712).
2434     std::string* exception_message = FormatSehExceptionMessage(
2435         GetExceptionCode(), location);
2436     internal::ReportFailureInUnknownLocation(TestPartResult::kFatalFailure,
2437                                              *exception_message);
2438     delete exception_message;
2439     return static_cast<Result>(0);
2440   }
2441 #else
2442   (void)location;
2443   return (object->*method)();
2444 #endif  // GTEST_HAS_SEH
2445 }
2446
2447 // Runs the given method and catches and reports C++ and/or SEH-style
2448 // exceptions, if they are supported; returns the 0-value for type
2449 // Result in case of an SEH exception.
2450 template <class T, typename Result>
2451 Result HandleExceptionsInMethodIfSupported(
2452     T* object, Result (T::*method)(), const char* location) {
2453   // NOTE: The user code can affect the way in which Google Test handles
2454   // exceptions by setting GTEST_FLAG(catch_exceptions), but only before
2455   // RUN_ALL_TESTS() starts. It is technically possible to check the flag
2456   // after the exception is caught and either report or re-throw the
2457   // exception based on the flag's value:
2458   //
2459   // try {
2460   //   // Perform the test method.
2461   // } catch (...) {
2462   //   if (GTEST_FLAG(catch_exceptions))
2463   //     // Report the exception as failure.
2464   //   else
2465   //     throw;  // Re-throws the original exception.
2466   // }
2467   //
2468   // However, the purpose of this flag is to allow the program to drop into
2469   // the debugger when the exception is thrown. On most platforms, once the
2470   // control enters the catch block, the exception origin information is
2471   // lost and the debugger will stop the program at the point of the
2472   // re-throw in this function -- instead of at the point of the original
2473   // throw statement in the code under test.  For this reason, we perform
2474   // the check early, sacrificing the ability to affect Google Test's
2475   // exception handling in the method where the exception is thrown.
2476   if (internal::GetUnitTestImpl()->catch_exceptions()) {
2477 #if GTEST_HAS_EXCEPTIONS
2478     try {
2479       return HandleSehExceptionsInMethodIfSupported(object, method, location);
2480     } catch (const AssertionException&) {  // NOLINT
2481       // This failure was reported already.
2482     } catch (const internal::GoogleTestFailureException&) {  // NOLINT
2483       // This exception type can only be thrown by a failed Google
2484       // Test assertion with the intention of letting another testing
2485       // framework catch it.  Therefore we just re-throw it.
2486       throw;
2487     } catch (const std::exception& e) {  // NOLINT
2488       internal::ReportFailureInUnknownLocation(
2489           TestPartResult::kFatalFailure,
2490           FormatCxxExceptionMessage(e.what(), location));
2491     } catch (...) {  // NOLINT
2492       internal::ReportFailureInUnknownLocation(
2493           TestPartResult::kFatalFailure,
2494           FormatCxxExceptionMessage(NULL, location));
2495     }
2496     return static_cast<Result>(0);
2497 #else
2498     return HandleSehExceptionsInMethodIfSupported(object, method, location);
2499 #endif  // GTEST_HAS_EXCEPTIONS
2500   } else {
2501     return (object->*method)();
2502   }
2503 }
2504
2505 }  // namespace internal
2506
2507 // Runs the test and updates the test result.
2508 void Test::Run() {
2509   if (!HasSameFixtureClass()) return;
2510
2511   internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
2512   impl->os_stack_trace_getter()->UponLeavingGTest();
2513   internal::HandleExceptionsInMethodIfSupported(this, &Test::SetUp, "SetUp()");
2514   // We will run the test only if SetUp() was successful.
2515   if (!HasFatalFailure()) {
2516     impl->os_stack_trace_getter()->UponLeavingGTest();
2517     internal::HandleExceptionsInMethodIfSupported(
2518         this, &Test::TestBody, "the test body");
2519   }
2520
2521   // However, we want to clean up as much as possible.  Hence we will
2522   // always call TearDown(), even if SetUp() or the test body has
2523   // failed.
2524   impl->os_stack_trace_getter()->UponLeavingGTest();
2525   internal::HandleExceptionsInMethodIfSupported(
2526       this, &Test::TearDown, "TearDown()");
2527 }
2528
2529 // Returns true iff the current test has a fatal failure.
2530 bool Test::HasFatalFailure() {
2531   return internal::GetUnitTestImpl()->current_test_result()->HasFatalFailure();
2532 }
2533
2534 // Returns true iff the current test has a non-fatal failure.
2535 bool Test::HasNonfatalFailure() {
2536   return internal::GetUnitTestImpl()->current_test_result()->
2537       HasNonfatalFailure();
2538 }
2539
2540 // class TestInfo
2541
2542 // Constructs a TestInfo object. It assumes ownership of the test factory
2543 // object.
2544 TestInfo::TestInfo(const std::string& a_test_case_name,
2545                    const std::string& a_name,
2546                    const char* a_type_param,
2547                    const char* a_value_param,
2548                    internal::CodeLocation a_code_location,
2549                    internal::TypeId fixture_class_id,
2550                    internal::TestFactoryBase* factory)
2551     : test_case_name_(a_test_case_name),
2552       name_(a_name),
2553       type_param_(a_type_param ? new std::string(a_type_param) : NULL),
2554       value_param_(a_value_param ? new std::string(a_value_param) : NULL),
2555       location_(a_code_location),
2556       fixture_class_id_(fixture_class_id),
2557       should_run_(false),
2558       is_disabled_(false),
2559       matches_filter_(false),
2560       factory_(factory),
2561       result_() {}
2562
2563 // Destructs a TestInfo object.
2564 TestInfo::~TestInfo() { delete factory_; }
2565
2566 namespace internal {
2567
2568 // Creates a new TestInfo object and registers it with Google Test;
2569 // returns the created object.
2570 //
2571 // Arguments:
2572 //
2573 //   test_case_name:   name of the test case
2574 //   name:             name of the test
2575 //   type_param:       the name of the test's type parameter, or NULL if
2576 //                     this is not a typed or a type-parameterized test.
2577 //   value_param:      text representation of the test's value parameter,
2578 //                     or NULL if this is not a value-parameterized test.
2579 //   code_location:    code location where the test is defined
2580 //   fixture_class_id: ID of the test fixture class
2581 //   set_up_tc:        pointer to the function that sets up the test case
2582 //   tear_down_tc:     pointer to the function that tears down the test case
2583 //   factory:          pointer to the factory that creates a test object.
2584 //                     The newly created TestInfo instance will assume
2585 //                     ownership of the factory object.
2586 TestInfo* MakeAndRegisterTestInfo(
2587     const char* test_case_name,
2588     const char* name,
2589     const char* type_param,
2590     const char* value_param,
2591     CodeLocation code_location,
2592     TypeId fixture_class_id,
2593     SetUpTestCaseFunc set_up_tc,
2594     TearDownTestCaseFunc tear_down_tc,
2595     TestFactoryBase* factory) {
2596   TestInfo* const test_info =
2597       new TestInfo(test_case_name, name, type_param, value_param,
2598                    code_location, fixture_class_id, factory);
2599   GetUnitTestImpl()->AddTestInfo(set_up_tc, tear_down_tc, test_info);
2600   return test_info;
2601 }
2602
2603 void ReportInvalidTestCaseType(const char* test_case_name,
2604                                CodeLocation code_location) {
2605   Message errors;
2606   errors
2607       << "Attempted redefinition of test case " << test_case_name << ".\n"
2608       << "All tests in the same test case must use the same test fixture\n"
2609       << "class.  However, in test case " << test_case_name << ", you tried\n"
2610       << "to define a test using a fixture class different from the one\n"
2611       << "used earlier. This can happen if the two fixture classes are\n"
2612       << "from different namespaces and have the same name. You should\n"
2613       << "probably rename one of the classes to put the tests into different\n"
2614       << "test cases.";
2615
2616   GTEST_LOG_(ERROR) << FormatFileLocation(code_location.file.c_str(),
2617                                           code_location.line)
2618                     << " " << errors.GetString();
2619 }
2620 }  // namespace internal
2621
2622 namespace {
2623
2624 // A predicate that checks the test name of a TestInfo against a known
2625 // value.
2626 //
2627 // This is used for implementation of the TestCase class only.  We put
2628 // it in the anonymous namespace to prevent polluting the outer
2629 // namespace.
2630 //
2631 // TestNameIs is copyable.
2632 class TestNameIs {
2633  public:
2634   // Constructor.
2635   //
2636   // TestNameIs has NO default constructor.
2637   explicit TestNameIs(const char* name)
2638       : name_(name) {}
2639
2640   // Returns true iff the test name of test_info matches name_.
2641   bool operator()(const TestInfo * test_info) const {
2642     return test_info && test_info->name() == name_;
2643   }
2644
2645  private:
2646   std::string name_;
2647 };
2648
2649 }  // namespace
2650
2651 namespace internal {
2652
2653 // This method expands all parameterized tests registered with macros TEST_P
2654 // and INSTANTIATE_TEST_CASE_P into regular tests and registers those.
2655 // This will be done just once during the program runtime.
2656 void UnitTestImpl::RegisterParameterizedTests() {
2657   if (!parameterized_tests_registered_) {
2658     parameterized_test_registry_.RegisterTests();
2659     parameterized_tests_registered_ = true;
2660   }
2661 }
2662
2663 }  // namespace internal
2664
2665 // Creates the test object, runs it, records its result, and then
2666 // deletes it.
2667 void TestInfo::Run() {
2668   if (!should_run_) return;
2669
2670   // Tells UnitTest where to store test result.
2671   internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
2672   impl->set_current_test_info(this);
2673
2674   TestEventListener* repeater = UnitTest::GetInstance()->listeners().repeater();
2675
2676   // Notifies the unit test event listeners that a test is about to start.
2677   repeater->OnTestStart(*this);
2678
2679   const TimeInMillis start = internal::GetTimeInMillis();
2680
2681   impl->os_stack_trace_getter()->UponLeavingGTest();
2682
2683   // Creates the test object.
2684   Test* const test = internal::HandleExceptionsInMethodIfSupported(
2685       factory_, &internal::TestFactoryBase::CreateTest,
2686       "the test fixture's constructor");
2687
2688   // Runs the test if the constructor didn't generate a fatal failure.
2689   // Note that the object will not be null
2690   if (!Test::HasFatalFailure()) {
2691     // This doesn't throw as all user code that can throw are wrapped into
2692     // exception handling code.
2693     test->Run();
2694   }
2695
2696     // Deletes the test object.
2697     impl->os_stack_trace_getter()->UponLeavingGTest();
2698     internal::HandleExceptionsInMethodIfSupported(
2699         test, &Test::DeleteSelf_, "the test fixture's destructor");
2700
2701   result_.set_elapsed_time(internal::GetTimeInMillis() - start);
2702
2703   // Notifies the unit test event listener that a test has just finished.
2704   repeater->OnTestEnd(*this);
2705
2706   // Tells UnitTest to stop associating assertion results to this
2707   // test.
2708   impl->set_current_test_info(NULL);
2709 }
2710
2711 // class TestCase
2712
2713 // Gets the number of successful tests in this test case.
2714 int TestCase::successful_test_count() const {
2715   return CountIf(test_info_list_, TestPassed);
2716 }
2717
2718 // Gets the number of failed tests in this test case.
2719 int TestCase::failed_test_count() const {
2720   return CountIf(test_info_list_, TestFailed);
2721 }
2722
2723 // Gets the number of disabled tests that will be reported in the XML report.
2724 int TestCase::reportable_disabled_test_count() const {
2725   return CountIf(test_info_list_, TestReportableDisabled);
2726 }
2727
2728 // Gets the number of disabled tests in this test case.
2729 int TestCase::disabled_test_count() const {
2730   return CountIf(test_info_list_, TestDisabled);
2731 }
2732
2733 // Gets the number of tests to be printed in the XML report.
2734 int TestCase::reportable_test_count() const {
2735   return CountIf(test_info_list_, TestReportable);
2736 }
2737
2738 // Get the number of tests in this test case that should run.
2739 int TestCase::test_to_run_count() const {
2740   return CountIf(test_info_list_, ShouldRunTest);
2741 }
2742
2743 // Gets the number of all tests.
2744 int TestCase::total_test_count() const {
2745   return static_cast<int>(test_info_list_.size());
2746 }
2747
2748 // Creates a TestCase with the given name.
2749 //
2750 // Arguments:
2751 //
2752 //   name:         name of the test case
2753 //   a_type_param: the name of the test case's type parameter, or NULL if
2754 //                 this is not a typed or a type-parameterized test case.
2755 //   set_up_tc:    pointer to the function that sets up the test case
2756 //   tear_down_tc: pointer to the function that tears down the test case
2757 TestCase::TestCase(const char* a_name, const char* a_type_param,
2758                    Test::SetUpTestCaseFunc set_up_tc,
2759                    Test::TearDownTestCaseFunc tear_down_tc)
2760     : name_(a_name),
2761       type_param_(a_type_param ? new std::string(a_type_param) : NULL),
2762       set_up_tc_(set_up_tc),
2763       tear_down_tc_(tear_down_tc),
2764       should_run_(false),
2765       elapsed_time_(0) {
2766 }
2767
2768 // Destructor of TestCase.
2769 TestCase::~TestCase() {
2770   // Deletes every Test in the collection.
2771   ForEach(test_info_list_, internal::Delete<TestInfo>);
2772 }
2773
2774 // Returns the i-th test among all the tests. i can range from 0 to
2775 // total_test_count() - 1. If i is not in that range, returns NULL.
2776 const TestInfo* TestCase::GetTestInfo(int i) const {
2777   const int index = GetElementOr(test_indices_, i, -1);
2778   return index < 0 ? NULL : test_info_list_[index];
2779 }
2780
2781 // Returns the i-th test among all the tests. i can range from 0 to
2782 // total_test_count() - 1. If i is not in that range, returns NULL.
2783 TestInfo* TestCase::GetMutableTestInfo(int i) {
2784   const int index = GetElementOr(test_indices_, i, -1);
2785   return index < 0 ? NULL : test_info_list_[index];
2786 }
2787
2788 // Adds a test to this test case.  Will delete the test upon
2789 // destruction of the TestCase object.
2790 void TestCase::AddTestInfo(TestInfo * test_info) {
2791   test_info_list_.push_back(test_info);
2792   test_indices_.push_back(static_cast<int>(test_indices_.size()));
2793 }
2794
2795 // Runs every test in this TestCase.
2796 void TestCase::Run() {
2797   if (!should_run_) return;
2798
2799   internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
2800   impl->set_current_test_case(this);
2801
2802   TestEventListener* repeater = UnitTest::GetInstance()->listeners().repeater();
2803
2804   repeater->OnTestCaseStart(*this);
2805   impl->os_stack_trace_getter()->UponLeavingGTest();
2806   internal::HandleExceptionsInMethodIfSupported(
2807       this, &TestCase::RunSetUpTestCase, "SetUpTestCase()");
2808
2809   const internal::TimeInMillis start = internal::GetTimeInMillis();
2810   for (int i = 0; i < total_test_count(); i++) {
2811     GetMutableTestInfo(i)->Run();
2812   }
2813   elapsed_time_ = internal::GetTimeInMillis() - start;
2814
2815   impl->os_stack_trace_getter()->UponLeavingGTest();
2816   internal::HandleExceptionsInMethodIfSupported(
2817       this, &TestCase::RunTearDownTestCase, "TearDownTestCase()");
2818
2819   repeater->OnTestCaseEnd(*this);
2820   impl->set_current_test_case(NULL);
2821 }
2822
2823 // Clears the results of all tests in this test case.
2824 void TestCase::ClearResult() {
2825   ad_hoc_test_result_.Clear();
2826   ForEach(test_info_list_, TestInfo::ClearTestResult);
2827 }
2828
2829 // Shuffles the tests in this test case.
2830 void TestCase::ShuffleTests(internal::Random* random) {
2831   Shuffle(random, &test_indices_);
2832 }
2833
2834 // Restores the test order to before the first shuffle.
2835 void TestCase::UnshuffleTests() {
2836   for (size_t i = 0; i < test_indices_.size(); i++) {
2837     test_indices_[i] = static_cast<int>(i);
2838   }
2839 }
2840
2841 // Formats a countable noun.  Depending on its quantity, either the
2842 // singular form or the plural form is used. e.g.
2843 //
2844 // FormatCountableNoun(1, "formula", "formuli") returns "1 formula".
2845 // FormatCountableNoun(5, "book", "books") returns "5 books".
2846 static std::string FormatCountableNoun(int count,
2847                                        const char * singular_form,
2848                                        const char * plural_form) {
2849   return internal::StreamableToString(count) + " " +
2850       (count == 1 ? singular_form : plural_form);
2851 }
2852
2853 // Formats the count of tests.
2854 static std::string FormatTestCount(int test_count) {
2855   return FormatCountableNoun(test_count, "test", "tests");
2856 }
2857
2858 // Formats the count of test cases.
2859 static std::string FormatTestCaseCount(int test_case_count) {
2860   return FormatCountableNoun(test_case_count, "test case", "test cases");
2861 }
2862
2863 // Converts a TestPartResult::Type enum to human-friendly string
2864 // representation.  Both kNonFatalFailure and kFatalFailure are translated
2865 // to "Failure", as the user usually doesn't care about the difference
2866 // between the two when viewing the test result.
2867 static const char * TestPartResultTypeToString(TestPartResult::Type type) {
2868   switch (type) {
2869     case TestPartResult::kSuccess:
2870       return "Success";
2871
2872     case TestPartResult::kNonFatalFailure:
2873     case TestPartResult::kFatalFailure:
2874 #ifdef _MSC_VER
2875       return "error: ";
2876 #else
2877       return "Failure\n";
2878 #endif
2879     default:
2880       return "Unknown result type";
2881   }
2882 }
2883
2884 namespace internal {
2885
2886 // Prints a TestPartResult to an std::string.
2887 static std::string PrintTestPartResultToString(
2888     const TestPartResult& test_part_result) {
2889   return (Message()
2890           << internal::FormatFileLocation(test_part_result.file_name(),
2891                                           test_part_result.line_number())
2892           << " " << TestPartResultTypeToString(test_part_result.type())
2893           << test_part_result.message()).GetString();
2894 }
2895
2896 // Prints a TestPartResult.
2897 static void PrintTestPartResult(const TestPartResult& test_part_result) {
2898   const std::string& result =
2899       PrintTestPartResultToString(test_part_result);
2900   printf("%s\n", result.c_str());
2901   fflush(stdout);
2902   // If the test program runs in Visual Studio or a debugger, the
2903   // following statements add the test part result message to the Output
2904   // window such that the user can double-click on it to jump to the
2905   // corresponding source code location; otherwise they do nothing.
2906 #if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
2907   // We don't call OutputDebugString*() on Windows Mobile, as printing
2908   // to stdout is done by OutputDebugString() there already - we don't
2909   // want the same message printed twice.
2910   ::OutputDebugStringA(result.c_str());
2911   ::OutputDebugStringA("\n");
2912 #endif
2913 }
2914
2915 // class PrettyUnitTestResultPrinter
2916
2917 enum GTestColor {
2918   COLOR_DEFAULT,
2919   COLOR_RED,
2920   COLOR_GREEN,
2921   COLOR_YELLOW
2922 };
2923
2924 #if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE && \
2925     !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT && !GTEST_OS_WINDOWS_MINGW
2926
2927 // Returns the character attribute for the given color.
2928 static WORD GetColorAttribute(GTestColor color) {
2929   switch (color) {
2930     case COLOR_RED:    return FOREGROUND_RED;
2931     case COLOR_GREEN:  return FOREGROUND_GREEN;
2932     case COLOR_YELLOW: return FOREGROUND_RED | FOREGROUND_GREEN;
2933     default:           return 0;
2934   }
2935 }
2936
2937 static int GetBitOffset(WORD color_mask) {
2938   if (color_mask == 0) return 0;
2939
2940   int bitOffset = 0;
2941   while ((color_mask & 1) == 0) {
2942     color_mask >>= 1;
2943     ++bitOffset;
2944   }
2945   return bitOffset;
2946 }
2947
2948 static WORD GetNewColor(GTestColor color, WORD old_color_attrs) {
2949   // Let's reuse the BG
2950   static const WORD background_mask = BACKGROUND_BLUE | BACKGROUND_GREEN |
2951                                       BACKGROUND_RED | BACKGROUND_INTENSITY;
2952   static const WORD foreground_mask = FOREGROUND_BLUE | FOREGROUND_GREEN |
2953                                       FOREGROUND_RED | FOREGROUND_INTENSITY;
2954   const WORD existing_bg = old_color_attrs & background_mask;
2955
2956   WORD new_color =
2957       GetColorAttribute(color) | existing_bg | FOREGROUND_INTENSITY;
2958   static const int bg_bitOffset = GetBitOffset(background_mask);
2959   static const int fg_bitOffset = GetBitOffset(foreground_mask);
2960
2961   if (((new_color & background_mask) >> bg_bitOffset) ==
2962       ((new_color & foreground_mask) >> fg_bitOffset)) {
2963     new_color ^= FOREGROUND_INTENSITY;  // invert intensity
2964   }
2965   return new_color;
2966 }
2967
2968 #else
2969
2970 // Returns the ANSI color code for the given color.  COLOR_DEFAULT is
2971 // an invalid input.
2972 static const char* GetAnsiColorCode(GTestColor color) {
2973   switch (color) {
2974     case COLOR_RED:     return "1";
2975     case COLOR_GREEN:   return "2";
2976     case COLOR_YELLOW:  return "3";
2977     default:            return NULL;
2978   };
2979 }
2980
2981 #endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
2982
2983 // Returns true iff Google Test should use colors in the output.
2984 bool ShouldUseColor(bool stdout_is_tty) {
2985   const char* const gtest_color = GTEST_FLAG(color).c_str();
2986
2987   if (String::CaseInsensitiveCStringEquals(gtest_color, "auto")) {
2988 #if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MINGW
2989     // On Windows the TERM variable is usually not set, but the
2990     // console there does support colors.
2991     return stdout_is_tty;
2992 #else
2993     // On non-Windows platforms, we rely on the TERM variable.
2994     const char* const term = posix::GetEnv("TERM");
2995     const bool term_supports_color =
2996         String::CStringEquals(term, "xterm") ||
2997         String::CStringEquals(term, "xterm-color") ||
2998         String::CStringEquals(term, "xterm-256color") ||
2999         String::CStringEquals(term, "screen") ||
3000         String::CStringEquals(term, "screen-256color") ||
3001         String::CStringEquals(term, "tmux") ||
3002         String::CStringEquals(term, "tmux-256color") ||
3003         String::CStringEquals(term, "rxvt-unicode") ||
3004         String::CStringEquals(term, "rxvt-unicode-256color") ||
3005         String::CStringEquals(term, "linux") ||
3006         String::CStringEquals(term, "cygwin");
3007     return stdout_is_tty && term_supports_color;
3008 #endif  // GTEST_OS_WINDOWS
3009   }
3010
3011   return String::CaseInsensitiveCStringEquals(gtest_color, "yes") ||
3012       String::CaseInsensitiveCStringEquals(gtest_color, "true") ||
3013       String::CaseInsensitiveCStringEquals(gtest_color, "t") ||
3014       String::CStringEquals(gtest_color, "1");
3015   // We take "yes", "true", "t", and "1" as meaning "yes".  If the
3016   // value is neither one of these nor "auto", we treat it as "no" to
3017   // be conservative.
3018 }
3019
3020 // Helpers for printing colored strings to stdout. Note that on Windows, we
3021 // cannot simply emit special characters and have the terminal change colors.
3022 // This routine must actually emit the characters rather than return a string
3023 // that would be colored when printed, as can be done on Linux.
3024 static void ColoredPrintf(GTestColor color, const char* fmt, ...) {
3025   va_list args;
3026   va_start(args, fmt);
3027
3028 #if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || GTEST_OS_ZOS || \
3029     GTEST_OS_IOS || GTEST_OS_WINDOWS_PHONE || GTEST_OS_WINDOWS_RT
3030   const bool use_color = AlwaysFalse();
3031 #else
3032   static const bool in_color_mode =
3033       ShouldUseColor(posix::IsATTY(posix::FileNo(stdout)) != 0);
3034   const bool use_color = in_color_mode && (color != COLOR_DEFAULT);
3035 #endif  // GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || GTEST_OS_ZOS
3036   // The '!= 0' comparison is necessary to satisfy MSVC 7.1.
3037
3038   if (!use_color) {
3039     vprintf(fmt, args);
3040     va_end(args);
3041     return;
3042   }
3043
3044 #if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE && \
3045     !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT && !GTEST_OS_WINDOWS_MINGW
3046   const HANDLE stdout_handle = GetStdHandle(STD_OUTPUT_HANDLE);
3047
3048   // Gets the current text color.
3049   CONSOLE_SCREEN_BUFFER_INFO buffer_info;
3050   GetConsoleScreenBufferInfo(stdout_handle, &buffer_info);
3051   const WORD old_color_attrs = buffer_info.wAttributes;
3052   const WORD new_color = GetNewColor(color, old_color_attrs);
3053
3054   // We need to flush the stream buffers into the console before each
3055   // SetConsoleTextAttribute call lest it affect the text that is already
3056   // printed but has not yet reached the console.
3057   fflush(stdout);
3058   SetConsoleTextAttribute(stdout_handle, new_color);
3059
3060   vprintf(fmt, args);
3061
3062   fflush(stdout);
3063   // Restores the text color.
3064   SetConsoleTextAttribute(stdout_handle, old_color_attrs);
3065 #else
3066   printf("\033[0;3%sm", GetAnsiColorCode(color));
3067   vprintf(fmt, args);
3068   printf("\033[m");  // Resets the terminal to default.
3069 #endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
3070   va_end(args);
3071 }
3072
3073 // Text printed in Google Test's text output and --gtest_list_tests
3074 // output to label the type parameter and value parameter for a test.
3075 static const char kTypeParamLabel[] = "TypeParam";
3076 static const char kValueParamLabel[] = "GetParam()";
3077
3078 static void PrintFullTestCommentIfPresent(const TestInfo& test_info) {
3079   const char* const type_param = test_info.type_param();
3080   const char* const value_param = test_info.value_param();
3081
3082   if (type_param != NULL || value_param != NULL) {
3083     printf(", where ");
3084     if (type_param != NULL) {
3085       printf("%s = %s", kTypeParamLabel, type_param);
3086       if (value_param != NULL)
3087         printf(" and ");
3088     }
3089     if (value_param != NULL) {
3090       printf("%s = %s", kValueParamLabel, value_param);
3091     }
3092   }
3093 }
3094
3095 // This class implements the TestEventListener interface.
3096 //
3097 // Class PrettyUnitTestResultPrinter is copyable.
3098 class PrettyUnitTestResultPrinter : public TestEventListener {
3099  public:
3100   PrettyUnitTestResultPrinter() {}
3101   static void PrintTestName(const char * test_case, const char * test) {
3102     printf("%s.%s", test_case, test);
3103   }
3104
3105   // The following methods override what's in the TestEventListener class.
3106   virtual void OnTestProgramStart(const UnitTest& /*unit_test*/) {}
3107   virtual void OnTestIterationStart(const UnitTest& unit_test, int iteration);
3108   virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test);
3109   virtual void OnEnvironmentsSetUpEnd(const UnitTest& /*unit_test*/) {}
3110   virtual void OnTestCaseStart(const TestCase& test_case);
3111   virtual void OnTestStart(const TestInfo& test_info);
3112   virtual void OnTestPartResult(const TestPartResult& result);
3113   virtual void OnTestEnd(const TestInfo& test_info);
3114   virtual void OnTestCaseEnd(const TestCase& test_case);
3115   virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test);
3116   virtual void OnEnvironmentsTearDownEnd(const UnitTest& /*unit_test*/) {}
3117   virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration);
3118   virtual void OnTestProgramEnd(const UnitTest& /*unit_test*/) {}
3119
3120  private:
3121   static void PrintFailedTests(const UnitTest& unit_test);
3122 };
3123
3124   // Fired before each iteration of tests starts.
3125 void PrettyUnitTestResultPrinter::OnTestIterationStart(
3126     const UnitTest& unit_test, int iteration) {
3127   if (GTEST_FLAG(repeat) != 1)
3128     printf("\nRepeating all tests (iteration %d) . . .\n\n", iteration + 1);
3129
3130   const char* const filter = GTEST_FLAG(filter).c_str();
3131
3132   // Prints the filter if it's not *.  This reminds the user that some
3133   // tests may be skipped.
3134   if (!String::CStringEquals(filter, kUniversalFilter)) {
3135     ColoredPrintf(COLOR_YELLOW,
3136                   "Note: %s filter = %s\n", GTEST_NAME_, filter);
3137   }
3138
3139   if (internal::ShouldShard(kTestTotalShards, kTestShardIndex, false)) {
3140     const Int32 shard_index = Int32FromEnvOrDie(kTestShardIndex, -1);
3141     ColoredPrintf(COLOR_YELLOW,
3142                   "Note: This is test shard %d of %s.\n",
3143                   static_cast<int>(shard_index) + 1,
3144                   internal::posix::GetEnv(kTestTotalShards));
3145   }
3146
3147   if (GTEST_FLAG(shuffle)) {
3148     ColoredPrintf(COLOR_YELLOW,
3149                   "Note: Randomizing tests' orders with a seed of %d .\n",
3150                   unit_test.random_seed());
3151   }
3152
3153   ColoredPrintf(COLOR_GREEN,  "[==========] ");
3154   printf("Running %s from %s.\n",
3155          FormatTestCount(unit_test.test_to_run_count()).c_str(),
3156          FormatTestCaseCount(unit_test.test_case_to_run_count()).c_str());
3157   fflush(stdout);
3158 }
3159
3160 void PrettyUnitTestResultPrinter::OnEnvironmentsSetUpStart(
3161     const UnitTest& /*unit_test*/) {
3162   ColoredPrintf(COLOR_GREEN,  "[----------] ");
3163   printf("Global test environment set-up.\n");
3164   fflush(stdout);
3165 }
3166
3167 void PrettyUnitTestResultPrinter::OnTestCaseStart(const TestCase& test_case) {
3168   const std::string counts =
3169       FormatCountableNoun(test_case.test_to_run_count(), "test", "tests");
3170   ColoredPrintf(COLOR_GREEN, "[----------] ");
3171   printf("%s from %s", counts.c_str(), test_case.name());
3172   if (test_case.type_param() == NULL) {
3173     printf("\n");
3174   } else {
3175     printf(", where %s = %s\n", kTypeParamLabel, test_case.type_param());
3176   }
3177   fflush(stdout);
3178 }
3179
3180 void PrettyUnitTestResultPrinter::OnTestStart(const TestInfo& test_info) {
3181   ColoredPrintf(COLOR_GREEN,  "[ RUN      ] ");
3182   PrintTestName(test_info.test_case_name(), test_info.name());
3183   printf("\n");
3184   fflush(stdout);
3185 }
3186
3187 // Called after an assertion failure.
3188 void PrettyUnitTestResultPrinter::OnTestPartResult(
3189     const TestPartResult& result) {
3190   // If the test part succeeded, we don't need to do anything.
3191   if (result.type() == TestPartResult::kSuccess)
3192     return;
3193
3194   // Print failure message from the assertion (e.g. expected this and got that).
3195   PrintTestPartResult(result);
3196   fflush(stdout);
3197 }
3198
3199 void PrettyUnitTestResultPrinter::OnTestEnd(const TestInfo& test_info) {
3200   if (test_info.result()->Passed()) {
3201     ColoredPrintf(COLOR_GREEN, "[       OK ] ");
3202   } else {
3203     ColoredPrintf(COLOR_RED, "[  FAILED  ] ");
3204   }
3205   PrintTestName(test_info.test_case_name(), test_info.name());
3206   if (test_info.result()->Failed())
3207     PrintFullTestCommentIfPresent(test_info);
3208
3209   if (GTEST_FLAG(print_time)) {
3210     printf(" (%s ms)\n", internal::StreamableToString(
3211            test_info.result()->elapsed_time()).c_str());
3212   } else {
3213     printf("\n");
3214   }
3215   fflush(stdout);
3216 }
3217
3218 void PrettyUnitTestResultPrinter::OnTestCaseEnd(const TestCase& test_case) {
3219   if (!GTEST_FLAG(print_time)) return;
3220
3221   const std::string counts =
3222       FormatCountableNoun(test_case.test_to_run_count(), "test", "tests");
3223   ColoredPrintf(COLOR_GREEN, "[----------] ");
3224   printf("%s from %s (%s ms total)\n\n",
3225          counts.c_str(), test_case.name(),
3226          internal::StreamableToString(test_case.elapsed_time()).c_str());
3227   fflush(stdout);
3228 }
3229
3230 void PrettyUnitTestResultPrinter::OnEnvironmentsTearDownStart(
3231     const UnitTest& /*unit_test*/) {
3232   ColoredPrintf(COLOR_GREEN,  "[----------] ");
3233   printf("Global test environment tear-down\n");
3234   fflush(stdout);
3235 }
3236
3237 // Internal helper for printing the list of failed tests.
3238 void PrettyUnitTestResultPrinter::PrintFailedTests(const UnitTest& unit_test) {
3239   const int failed_test_count = unit_test.failed_test_count();
3240   if (failed_test_count == 0) {
3241     return;
3242   }
3243
3244   for (int i = 0; i < unit_test.total_test_case_count(); ++i) {
3245     const TestCase& test_case = *unit_test.GetTestCase(i);
3246     if (!test_case.should_run() || (test_case.failed_test_count() == 0)) {
3247       continue;
3248     }
3249     for (int j = 0; j < test_case.total_test_count(); ++j) {
3250       const TestInfo& test_info = *test_case.GetTestInfo(j);
3251       if (!test_info.should_run() || test_info.result()->Passed()) {
3252         continue;
3253       }
3254       ColoredPrintf(COLOR_RED, "[  FAILED  ] ");
3255       printf("%s.%s", test_case.name(), test_info.name());
3256       PrintFullTestCommentIfPresent(test_info);
3257       printf("\n");
3258     }
3259   }
3260 }
3261
3262 void PrettyUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
3263                                                      int /*iteration*/) {
3264   ColoredPrintf(COLOR_GREEN,  "[==========] ");
3265   printf("%s from %s ran.",
3266          FormatTestCount(unit_test.test_to_run_count()).c_str(),
3267          FormatTestCaseCount(unit_test.test_case_to_run_count()).c_str());
3268   if (GTEST_FLAG(print_time)) {
3269     printf(" (%s ms total)",
3270            internal::StreamableToString(unit_test.elapsed_time()).c_str());
3271   }
3272   printf("\n");
3273   ColoredPrintf(COLOR_GREEN,  "[  PASSED  ] ");
3274   printf("%s.\n", FormatTestCount(unit_test.successful_test_count()).c_str());
3275
3276   int num_failures = unit_test.failed_test_count();
3277   if (!unit_test.Passed()) {
3278     const int failed_test_count = unit_test.failed_test_count();
3279     ColoredPrintf(COLOR_RED,  "[  FAILED  ] ");
3280     printf("%s, listed below:\n", FormatTestCount(failed_test_count).c_str());
3281     PrintFailedTests(unit_test);
3282     printf("\n%2d FAILED %s\n", num_failures,
3283                         num_failures == 1 ? "TEST" : "TESTS");
3284   }
3285
3286   int num_disabled = unit_test.reportable_disabled_test_count();
3287   if (num_disabled && !GTEST_FLAG(also_run_disabled_tests)) {
3288     if (!num_failures) {
3289       printf("\n");  // Add a spacer if no FAILURE banner is displayed.
3290     }
3291     ColoredPrintf(COLOR_YELLOW,
3292                   "  YOU HAVE %d DISABLED %s\n\n",
3293                   num_disabled,
3294                   num_disabled == 1 ? "TEST" : "TESTS");
3295   }
3296   // Ensure that Google Test output is printed before, e.g., heapchecker output.
3297   fflush(stdout);
3298 }
3299
3300 // End PrettyUnitTestResultPrinter
3301
3302 // class TestEventRepeater
3303 //
3304 // This class forwards events to other event listeners.
3305 class TestEventRepeater : public TestEventListener {
3306  public:
3307   TestEventRepeater() : forwarding_enabled_(true) {}
3308   virtual ~TestEventRepeater();
3309   void Append(TestEventListener *listener);
3310   TestEventListener* Release(TestEventListener* listener);
3311
3312   // Controls whether events will be forwarded to listeners_. Set to false
3313   // in death test child processes.
3314   bool forwarding_enabled() const { return forwarding_enabled_; }
3315   void set_forwarding_enabled(bool enable) { forwarding_enabled_ = enable; }
3316
3317   virtual void OnTestProgramStart(const UnitTest& unit_test);
3318   virtual void OnTestIterationStart(const UnitTest& unit_test, int iteration);
3319   virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test);
3320   virtual void OnEnvironmentsSetUpEnd(const UnitTest& unit_test);
3321   virtual void OnTestCaseStart(const TestCase& test_case);
3322   virtual void OnTestStart(const TestInfo& test_info);
3323   virtual void OnTestPartResult(const TestPartResult& result);
3324   virtual void OnTestEnd(const TestInfo& test_info);
3325   virtual void OnTestCaseEnd(const TestCase& test_case);
3326   virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test);
3327   virtual void OnEnvironmentsTearDownEnd(const UnitTest& unit_test);
3328   virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration);
3329   virtual void OnTestProgramEnd(const UnitTest& unit_test);
3330
3331  private:
3332   // Controls whether events will be forwarded to listeners_. Set to false
3333   // in death test child processes.
3334   bool forwarding_enabled_;
3335   // The list of listeners that receive events.
3336   std::vector<TestEventListener*> listeners_;
3337
3338   GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventRepeater);
3339 };
3340
3341 TestEventRepeater::~TestEventRepeater() {
3342   ForEach(listeners_, Delete<TestEventListener>);
3343 }
3344
3345 void TestEventRepeater::Append(TestEventListener *listener) {
3346   listeners_.push_back(listener);
3347 }
3348
3349 // FIXME: Factor the search functionality into Vector::Find.
3350 TestEventListener* TestEventRepeater::Release(TestEventListener *listener) {
3351   for (size_t i = 0; i < listeners_.size(); ++i) {
3352     if (listeners_[i] == listener) {
3353       listeners_.erase(listeners_.begin() + i);
3354       return listener;
3355     }
3356   }
3357
3358   return NULL;
3359 }
3360
3361 // Since most methods are very similar, use macros to reduce boilerplate.
3362 // This defines a member that forwards the call to all listeners.
3363 #define GTEST_REPEATER_METHOD_(Name, Type) \
3364 void TestEventRepeater::Name(const Type& parameter) { \
3365   if (forwarding_enabled_) { \
3366     for (size_t i = 0; i < listeners_.size(); i++) { \
3367       listeners_[i]->Name(parameter); \
3368     } \
3369   } \
3370 }
3371 // This defines a member that forwards the call to all listeners in reverse
3372 // order.
3373 #define GTEST_REVERSE_REPEATER_METHOD_(Name, Type) \
3374 void TestEventRepeater::Name(const Type& parameter) { \
3375   if (forwarding_enabled_) { \
3376     for (int i = static_cast<int>(listeners_.size()) - 1; i >= 0; i--) { \
3377       listeners_[i]->Name(parameter); \
3378     } \
3379   } \
3380 }
3381
3382 GTEST_REPEATER_METHOD_(OnTestProgramStart, UnitTest)
3383 GTEST_REPEATER_METHOD_(OnEnvironmentsSetUpStart, UnitTest)
3384 GTEST_REPEATER_METHOD_(OnTestCaseStart, TestCase)
3385 GTEST_REPEATER_METHOD_(OnTestStart, TestInfo)
3386 GTEST_REPEATER_METHOD_(OnTestPartResult, TestPartResult)
3387 GTEST_REPEATER_METHOD_(OnEnvironmentsTearDownStart, UnitTest)
3388 GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsSetUpEnd, UnitTest)
3389 GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsTearDownEnd, UnitTest)
3390 GTEST_REVERSE_REPEATER_METHOD_(OnTestEnd, TestInfo)
3391 GTEST_REVERSE_REPEATER_METHOD_(OnTestCaseEnd, TestCase)
3392 GTEST_REVERSE_REPEATER_METHOD_(OnTestProgramEnd, UnitTest)
3393
3394 #undef GTEST_REPEATER_METHOD_
3395 #undef GTEST_REVERSE_REPEATER_METHOD_
3396
3397 void TestEventRepeater::OnTestIterationStart(const UnitTest& unit_test,
3398                                              int iteration) {
3399   if (forwarding_enabled_) {
3400     for (size_t i = 0; i < listeners_.size(); i++) {
3401       listeners_[i]->OnTestIterationStart(unit_test, iteration);
3402     }
3403   }
3404 }
3405
3406 void TestEventRepeater::OnTestIterationEnd(const UnitTest& unit_test,
3407                                            int iteration) {
3408   if (forwarding_enabled_) {
3409     for (int i = static_cast<int>(listeners_.size()) - 1; i >= 0; i--) {
3410       listeners_[i]->OnTestIterationEnd(unit_test, iteration);
3411     }
3412   }
3413 }
3414
3415 // End TestEventRepeater
3416