1dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Copyright 2007, Google Inc. 2dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// All rights reserved. 3dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 4dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Redistribution and use in source and binary forms, with or without 5dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// modification, are permitted provided that the following conditions are 6dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// met: 7dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 8dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// * Redistributions of source code must retain the above copyright 9dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// notice, this list of conditions and the following disclaimer. 10dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// * Redistributions in binary form must reproduce the above 11dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// copyright notice, this list of conditions and the following disclaimer 12dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// in the documentation and/or other materials provided with the 13dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// distribution. 14dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// * Neither the name of Google Inc. nor the names of its 15dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// contributors may be used to endorse or promote products derived from 16dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// this software without specific prior written permission. 17dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 18dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 30dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Author: wan@google.com (Zhanyong Wan) 31dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 32dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Google Mock - a framework for writing C++ mock classes. 33dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 34dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// This file defines some utilities useful for implementing Google 35dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Mock. They are subject to change without notice, so please DO NOT 36dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// USE THEM IN USER CODE. 37dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 3846108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan#include "gmock/internal/gmock-internal-utils.h" 39dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 40dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#include <ctype.h> 41dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#include <ostream> // NOLINT 42dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#include <string> 4346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan#include "gmock/gmock.h" 4446108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan#include "gmock/internal/gmock-port.h" 4546108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan#include "gtest/gtest.h" 46dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 47dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixternamespace testing { 48dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixternamespace internal { 49dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 50dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Converts an identifier name to a space-separated list of lower-case 51dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// words. Each maximum substring of the form [A-Za-z][a-z]*|\d+ is 52dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// treated as one word. For example, both "FooBar123" and 53dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// "foo_bar_123" are converted to "foo bar 123". 5446108a219a4b812dd8f36fee479a0340ea5963f5Ben ChanGTEST_API_ string ConvertIdentifierNameToWords(const char* id_name) { 55dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter string result; 56dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter char prev_char = '\0'; 57dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter for (const char* p = id_name; *p != '\0'; prev_char = *(p++)) { 58dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // We don't care about the current locale as the input is 59dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // guaranteed to be a valid C++ identifier name. 6046108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan const bool starts_new_word = IsUpper(*p) || 6146108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan (!IsAlpha(prev_char) && IsLower(*p)) || 6246108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan (!IsDigit(prev_char) && IsDigit(*p)); 63dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 6446108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan if (IsAlNum(*p)) { 65dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter if (starts_new_word && result != "") 66dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter result += ' '; 6746108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan result += ToLower(*p); 68dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter } 69dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter } 70dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter return result; 71dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter} 72dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 73dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// This class reports Google Mock failures as Google Test failures. A 74dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// user can define another class in a similar fashion if he intends to 75dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// use Google Mock with a testing framework other than Google Test. 76dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixterclass GoogleTestFailureReporter : public FailureReporterInterface { 77dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter public: 78dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter virtual void ReportFailure(FailureType type, const char* file, int line, 79dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter const string& message) { 8046108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan AssertHelper(type == kFatal ? 8146108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan TestPartResult::kFatalFailure : 8246108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan TestPartResult::kNonFatalFailure, 8346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan file, 8446108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan line, 8546108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan message.c_str()) = Message(); 8646108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan if (type == kFatal) { 8746108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan posix::Abort(); 88dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter } 89dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter } 90dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter}; 91dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 92dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Returns the global failure reporter. Will create a 93dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// GoogleTestFailureReporter and return it the first time called. 9446108a219a4b812dd8f36fee479a0340ea5963f5Ben ChanGTEST_API_ FailureReporterInterface* GetFailureReporter() { 95dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Points to the global failure reporter used by Google Mock. gcc 96dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // guarantees that the following use of failure_reporter is 97dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // thread-safe. We may need to add additional synchronization to 98dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // protect failure_reporter if we port Google Mock to other 99dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // compilers. 100dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter static FailureReporterInterface* const failure_reporter = 101dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter new GoogleTestFailureReporter(); 102dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter return failure_reporter; 103dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter} 104dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 105dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Protects global resources (stdout in particular) used by Log(). 10646108a219a4b812dd8f36fee479a0340ea5963f5Ben Chanstatic GTEST_DEFINE_STATIC_MUTEX_(g_log_mutex); 107dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 108dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Returns true iff a log with the given severity is visible according 109dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// to the --gmock_verbose flag. 11046108a219a4b812dd8f36fee479a0340ea5963f5Ben ChanGTEST_API_ bool LogIsVisible(LogSeverity severity) { 111dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter if (GMOCK_FLAG(verbose) == kInfoVerbosity) { 112dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Always show the log if --gmock_verbose=info. 113dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter return true; 114dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter } else if (GMOCK_FLAG(verbose) == kErrorVerbosity) { 115dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Always hide it if --gmock_verbose=error. 116dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter return false; 117dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter } else { 118dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // If --gmock_verbose is neither "info" nor "error", we treat it 119dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // as "warning" (its default value). 12046108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan return severity == kWarning; 121dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter } 122dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter} 123dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 124dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Prints the given message to stdout iff 'severity' >= the level 125dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// specified by the --gmock_verbose flag. If stack_frames_to_skip >= 126dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 0, also prints the stack trace excluding the top 127dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// stack_frames_to_skip frames. In opt mode, any positive 128dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// stack_frames_to_skip is treated as 0, since we don't know which 129dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// function calls will be inlined by the compiler and need to be 130dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// conservative. 13146108a219a4b812dd8f36fee479a0340ea5963f5Ben ChanGTEST_API_ void Log(LogSeverity severity, 13246108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan const string& message, 13346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan int stack_frames_to_skip) { 134dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter if (!LogIsVisible(severity)) 135dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter return; 136dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 137dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Ensures that logs from different threads don't interleave. 138dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter MutexLock l(&g_log_mutex); 139dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 140dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // "using ::std::cout;" doesn't work with Symbian's STLport, where cout is a 141dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // macro. 142dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 14346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan if (severity == kWarning) { 144dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Prints a GMOCK WARNING marker to make the warnings easily searchable. 145dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter std::cout << "\nGMOCK WARNING:"; 146dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter } 147dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Pre-pends a new-line to message if it doesn't start with one. 148dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter if (message.empty() || message[0] != '\n') { 149dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter std::cout << "\n"; 150dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter } 151dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter std::cout << message; 152dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter if (stack_frames_to_skip >= 0) { 153dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#ifdef NDEBUG 154dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // In opt mode, we have to be conservative and skip no stack frame. 155dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter const int actual_to_skip = 0; 156dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#else 157dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // In dbg mode, we can do what the caller tell us to do (plus one 158dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // for skipping this function's stack frame). 159dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter const int actual_to_skip = stack_frames_to_skip + 1; 160dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#endif // NDEBUG 161dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 162dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Appends a new-line to message if it doesn't end with one. 163dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter if (!message.empty() && *message.rbegin() != '\n') { 164dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter std::cout << "\n"; 165dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter } 166dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter std::cout << "Stack trace:\n" 167dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter << ::testing::internal::GetCurrentOsStackTraceExceptTop( 168dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter ::testing::UnitTest::GetInstance(), actual_to_skip); 169dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter } 170dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter std::cout << ::std::flush; 171dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter} 172dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 173dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter} // namespace internal 174dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter} // namespace testing 175