113481Sgiacomo.travaglini@arm.com// Copyright 2007, Google Inc. 213481Sgiacomo.travaglini@arm.com// All rights reserved. 313481Sgiacomo.travaglini@arm.com// 413481Sgiacomo.travaglini@arm.com// Redistribution and use in source and binary forms, with or without 513481Sgiacomo.travaglini@arm.com// modification, are permitted provided that the following conditions are 613481Sgiacomo.travaglini@arm.com// met: 713481Sgiacomo.travaglini@arm.com// 813481Sgiacomo.travaglini@arm.com// * Redistributions of source code must retain the above copyright 913481Sgiacomo.travaglini@arm.com// notice, this list of conditions and the following disclaimer. 1013481Sgiacomo.travaglini@arm.com// * Redistributions in binary form must reproduce the above 1113481Sgiacomo.travaglini@arm.com// copyright notice, this list of conditions and the following disclaimer 1213481Sgiacomo.travaglini@arm.com// in the documentation and/or other materials provided with the 1313481Sgiacomo.travaglini@arm.com// distribution. 1413481Sgiacomo.travaglini@arm.com// * Neither the name of Google Inc. nor the names of its 1513481Sgiacomo.travaglini@arm.com// contributors may be used to endorse or promote products derived from 1613481Sgiacomo.travaglini@arm.com// this software without specific prior written permission. 1713481Sgiacomo.travaglini@arm.com// 1813481Sgiacomo.travaglini@arm.com// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1913481Sgiacomo.travaglini@arm.com// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2013481Sgiacomo.travaglini@arm.com// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2113481Sgiacomo.travaglini@arm.com// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2213481Sgiacomo.travaglini@arm.com// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2313481Sgiacomo.travaglini@arm.com// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2413481Sgiacomo.travaglini@arm.com// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2513481Sgiacomo.travaglini@arm.com// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2613481Sgiacomo.travaglini@arm.com// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2713481Sgiacomo.travaglini@arm.com// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2813481Sgiacomo.travaglini@arm.com// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2913481Sgiacomo.travaglini@arm.com// 3013481Sgiacomo.travaglini@arm.com// Author: wan@google.com (Zhanyong Wan) 3113481Sgiacomo.travaglini@arm.com 3213481Sgiacomo.travaglini@arm.com// Google Mock - a framework for writing C++ mock classes. 3313481Sgiacomo.travaglini@arm.com// 3413481Sgiacomo.travaglini@arm.com// This file defines some utilities useful for implementing Google 3513481Sgiacomo.travaglini@arm.com// Mock. They are subject to change without notice, so please DO NOT 3613481Sgiacomo.travaglini@arm.com// USE THEM IN USER CODE. 3713481Sgiacomo.travaglini@arm.com 3813481Sgiacomo.travaglini@arm.com#include "gmock/internal/gmock-internal-utils.h" 3913481Sgiacomo.travaglini@arm.com 4013481Sgiacomo.travaglini@arm.com#include <ctype.h> 4113481Sgiacomo.travaglini@arm.com#include <ostream> // NOLINT 4213481Sgiacomo.travaglini@arm.com#include <string> 4313481Sgiacomo.travaglini@arm.com#include "gmock/gmock.h" 4413481Sgiacomo.travaglini@arm.com#include "gmock/internal/gmock-port.h" 4513481Sgiacomo.travaglini@arm.com#include "gtest/gtest.h" 4613481Sgiacomo.travaglini@arm.com 4713481Sgiacomo.travaglini@arm.comnamespace testing { 4813481Sgiacomo.travaglini@arm.comnamespace internal { 4913481Sgiacomo.travaglini@arm.com 5013481Sgiacomo.travaglini@arm.com// Converts an identifier name to a space-separated list of lower-case 5113481Sgiacomo.travaglini@arm.com// words. Each maximum substring of the form [A-Za-z][a-z]*|\d+ is 5213481Sgiacomo.travaglini@arm.com// treated as one word. For example, both "FooBar123" and 5313481Sgiacomo.travaglini@arm.com// "foo_bar_123" are converted to "foo bar 123". 5413481Sgiacomo.travaglini@arm.comGTEST_API_ string ConvertIdentifierNameToWords(const char* id_name) { 5513481Sgiacomo.travaglini@arm.com string result; 5613481Sgiacomo.travaglini@arm.com char prev_char = '\0'; 5713481Sgiacomo.travaglini@arm.com for (const char* p = id_name; *p != '\0'; prev_char = *(p++)) { 5813481Sgiacomo.travaglini@arm.com // We don't care about the current locale as the input is 5913481Sgiacomo.travaglini@arm.com // guaranteed to be a valid C++ identifier name. 6013481Sgiacomo.travaglini@arm.com const bool starts_new_word = IsUpper(*p) || 6113481Sgiacomo.travaglini@arm.com (!IsAlpha(prev_char) && IsLower(*p)) || 6213481Sgiacomo.travaglini@arm.com (!IsDigit(prev_char) && IsDigit(*p)); 6313481Sgiacomo.travaglini@arm.com 6413481Sgiacomo.travaglini@arm.com if (IsAlNum(*p)) { 6513481Sgiacomo.travaglini@arm.com if (starts_new_word && result != "") 6613481Sgiacomo.travaglini@arm.com result += ' '; 6713481Sgiacomo.travaglini@arm.com result += ToLower(*p); 6813481Sgiacomo.travaglini@arm.com } 6913481Sgiacomo.travaglini@arm.com } 7013481Sgiacomo.travaglini@arm.com return result; 7113481Sgiacomo.travaglini@arm.com} 7213481Sgiacomo.travaglini@arm.com 7313481Sgiacomo.travaglini@arm.com// This class reports Google Mock failures as Google Test failures. A 7413481Sgiacomo.travaglini@arm.com// user can define another class in a similar fashion if he intends to 7513481Sgiacomo.travaglini@arm.com// use Google Mock with a testing framework other than Google Test. 7613481Sgiacomo.travaglini@arm.comclass GoogleTestFailureReporter : public FailureReporterInterface { 7713481Sgiacomo.travaglini@arm.com public: 7813481Sgiacomo.travaglini@arm.com virtual void ReportFailure(FailureType type, const char* file, int line, 7913481Sgiacomo.travaglini@arm.com const string& message) { 8013481Sgiacomo.travaglini@arm.com AssertHelper(type == kFatal ? 8113481Sgiacomo.travaglini@arm.com TestPartResult::kFatalFailure : 8213481Sgiacomo.travaglini@arm.com TestPartResult::kNonFatalFailure, 8313481Sgiacomo.travaglini@arm.com file, 8413481Sgiacomo.travaglini@arm.com line, 8513481Sgiacomo.travaglini@arm.com message.c_str()) = Message(); 8613481Sgiacomo.travaglini@arm.com if (type == kFatal) { 8713481Sgiacomo.travaglini@arm.com posix::Abort(); 8813481Sgiacomo.travaglini@arm.com } 8913481Sgiacomo.travaglini@arm.com } 9013481Sgiacomo.travaglini@arm.com}; 9113481Sgiacomo.travaglini@arm.com 9213481Sgiacomo.travaglini@arm.com// Returns the global failure reporter. Will create a 9313481Sgiacomo.travaglini@arm.com// GoogleTestFailureReporter and return it the first time called. 9413481Sgiacomo.travaglini@arm.comGTEST_API_ FailureReporterInterface* GetFailureReporter() { 9513481Sgiacomo.travaglini@arm.com // Points to the global failure reporter used by Google Mock. gcc 9613481Sgiacomo.travaglini@arm.com // guarantees that the following use of failure_reporter is 9713481Sgiacomo.travaglini@arm.com // thread-safe. We may need to add additional synchronization to 9813481Sgiacomo.travaglini@arm.com // protect failure_reporter if we port Google Mock to other 9913481Sgiacomo.travaglini@arm.com // compilers. 10013481Sgiacomo.travaglini@arm.com static FailureReporterInterface* const failure_reporter = 10113481Sgiacomo.travaglini@arm.com new GoogleTestFailureReporter(); 10213481Sgiacomo.travaglini@arm.com return failure_reporter; 10313481Sgiacomo.travaglini@arm.com} 10413481Sgiacomo.travaglini@arm.com 10513481Sgiacomo.travaglini@arm.com// Protects global resources (stdout in particular) used by Log(). 10613481Sgiacomo.travaglini@arm.comstatic GTEST_DEFINE_STATIC_MUTEX_(g_log_mutex); 10713481Sgiacomo.travaglini@arm.com 10813481Sgiacomo.travaglini@arm.com// Returns true iff a log with the given severity is visible according 10913481Sgiacomo.travaglini@arm.com// to the --gmock_verbose flag. 11013481Sgiacomo.travaglini@arm.comGTEST_API_ bool LogIsVisible(LogSeverity severity) { 11113481Sgiacomo.travaglini@arm.com if (GMOCK_FLAG(verbose) == kInfoVerbosity) { 11213481Sgiacomo.travaglini@arm.com // Always show the log if --gmock_verbose=info. 11313481Sgiacomo.travaglini@arm.com return true; 11413481Sgiacomo.travaglini@arm.com } else if (GMOCK_FLAG(verbose) == kErrorVerbosity) { 11513481Sgiacomo.travaglini@arm.com // Always hide it if --gmock_verbose=error. 11613481Sgiacomo.travaglini@arm.com return false; 11713481Sgiacomo.travaglini@arm.com } else { 11813481Sgiacomo.travaglini@arm.com // If --gmock_verbose is neither "info" nor "error", we treat it 11913481Sgiacomo.travaglini@arm.com // as "warning" (its default value). 12013481Sgiacomo.travaglini@arm.com return severity == kWarning; 12113481Sgiacomo.travaglini@arm.com } 12213481Sgiacomo.travaglini@arm.com} 12313481Sgiacomo.travaglini@arm.com 12413481Sgiacomo.travaglini@arm.com// Prints the given message to stdout iff 'severity' >= the level 12513481Sgiacomo.travaglini@arm.com// specified by the --gmock_verbose flag. If stack_frames_to_skip >= 12613481Sgiacomo.travaglini@arm.com// 0, also prints the stack trace excluding the top 12713481Sgiacomo.travaglini@arm.com// stack_frames_to_skip frames. In opt mode, any positive 12813481Sgiacomo.travaglini@arm.com// stack_frames_to_skip is treated as 0, since we don't know which 12913481Sgiacomo.travaglini@arm.com// function calls will be inlined by the compiler and need to be 13013481Sgiacomo.travaglini@arm.com// conservative. 13113481Sgiacomo.travaglini@arm.comGTEST_API_ void Log(LogSeverity severity, 13213481Sgiacomo.travaglini@arm.com const string& message, 13313481Sgiacomo.travaglini@arm.com int stack_frames_to_skip) { 13413481Sgiacomo.travaglini@arm.com if (!LogIsVisible(severity)) 13513481Sgiacomo.travaglini@arm.com return; 13613481Sgiacomo.travaglini@arm.com 13713481Sgiacomo.travaglini@arm.com // Ensures that logs from different threads don't interleave. 13813481Sgiacomo.travaglini@arm.com MutexLock l(&g_log_mutex); 13913481Sgiacomo.travaglini@arm.com 14013481Sgiacomo.travaglini@arm.com // "using ::std::cout;" doesn't work with Symbian's STLport, where cout is a 14113481Sgiacomo.travaglini@arm.com // macro. 14213481Sgiacomo.travaglini@arm.com 14313481Sgiacomo.travaglini@arm.com if (severity == kWarning) { 14413481Sgiacomo.travaglini@arm.com // Prints a GMOCK WARNING marker to make the warnings easily searchable. 14513481Sgiacomo.travaglini@arm.com std::cout << "\nGMOCK WARNING:"; 14613481Sgiacomo.travaglini@arm.com } 14713481Sgiacomo.travaglini@arm.com // Pre-pends a new-line to message if it doesn't start with one. 14813481Sgiacomo.travaglini@arm.com if (message.empty() || message[0] != '\n') { 14913481Sgiacomo.travaglini@arm.com std::cout << "\n"; 15013481Sgiacomo.travaglini@arm.com } 15113481Sgiacomo.travaglini@arm.com std::cout << message; 15213481Sgiacomo.travaglini@arm.com if (stack_frames_to_skip >= 0) { 15313481Sgiacomo.travaglini@arm.com#ifdef NDEBUG 15413481Sgiacomo.travaglini@arm.com // In opt mode, we have to be conservative and skip no stack frame. 15513481Sgiacomo.travaglini@arm.com const int actual_to_skip = 0; 15613481Sgiacomo.travaglini@arm.com#else 15713481Sgiacomo.travaglini@arm.com // In dbg mode, we can do what the caller tell us to do (plus one 15813481Sgiacomo.travaglini@arm.com // for skipping this function's stack frame). 15913481Sgiacomo.travaglini@arm.com const int actual_to_skip = stack_frames_to_skip + 1; 16013481Sgiacomo.travaglini@arm.com#endif // NDEBUG 16113481Sgiacomo.travaglini@arm.com 16213481Sgiacomo.travaglini@arm.com // Appends a new-line to message if it doesn't end with one. 16313481Sgiacomo.travaglini@arm.com if (!message.empty() && *message.rbegin() != '\n') { 16413481Sgiacomo.travaglini@arm.com std::cout << "\n"; 16513481Sgiacomo.travaglini@arm.com } 16613481Sgiacomo.travaglini@arm.com std::cout << "Stack trace:\n" 16713481Sgiacomo.travaglini@arm.com << ::testing::internal::GetCurrentOsStackTraceExceptTop( 16813481Sgiacomo.travaglini@arm.com ::testing::UnitTest::GetInstance(), actual_to_skip); 16913481Sgiacomo.travaglini@arm.com } 17013481Sgiacomo.travaglini@arm.com std::cout << ::std::flush; 17113481Sgiacomo.travaglini@arm.com} 17213481Sgiacomo.travaglini@arm.com 17313481Sgiacomo.travaglini@arm.com} // namespace internal 17413481Sgiacomo.travaglini@arm.com} // namespace testing 175