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