1 // Copyright 2007, Google Inc.
2 // All rights reserved.
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
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
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.
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.
30 // Author: wan@google.com (Zhanyong Wan)
32 // Google Mock - a framework for writing C++ mock classes.
34 // This file defines some utilities useful for implementing Google
35 // Mock. They are subject to change without notice, so please DO NOT
36 // USE THEM IN USER CODE.
38 #include "gmock/internal/gmock-internal-utils.h"
41 #include <ostream> // NOLINT
43 #include "gmock/gmock.h"
44 #include "gmock/internal/gmock-port.h"
45 #include "gtest/gtest.h"
50 // Joins a vector of strings as if they are fields of a tuple; returns
52 GTEST_API_
std::string
JoinAsTuple(const Strings
& fields
) {
53 switch (fields
.size()) {
59 std::string result
= "(" + fields
[0];
60 for (size_t i
= 1; i
< fields
.size(); i
++) {
69 // Converts an identifier name to a space-separated list of lower-case
70 // words. Each maximum substring of the form [A-Za-z][a-z]*|\d+ is
71 // treated as one word. For example, both "FooBar123" and
72 // "foo_bar_123" are converted to "foo bar 123".
73 GTEST_API_
std::string
ConvertIdentifierNameToWords(const char* id_name
) {
75 char prev_char
= '\0';
76 for (const char* p
= id_name
; *p
!= '\0'; prev_char
= *(p
++)) {
77 // We don't care about the current locale as the input is
78 // guaranteed to be a valid C++ identifier name.
79 const bool starts_new_word
= IsUpper(*p
) ||
80 (!IsAlpha(prev_char
) && IsLower(*p
)) ||
81 (!IsDigit(prev_char
) && IsDigit(*p
));
84 if (starts_new_word
&& result
!= "")
86 result
+= ToLower(*p
);
92 // This class reports Google Mock failures as Google Test failures. A
93 // user can define another class in a similar fashion if they intend to
94 // use Google Mock with a testing framework other than Google Test.
95 class GoogleTestFailureReporter
: public FailureReporterInterface
{
97 virtual void ReportFailure(FailureType type
, const char* file
, int line
,
98 const std::string
& message
) {
99 AssertHelper(type
== kFatal
?
100 TestPartResult::kFatalFailure
:
101 TestPartResult::kNonFatalFailure
,
104 message
.c_str()) = Message();
105 if (type
== kFatal
) {
111 // Returns the global failure reporter. Will create a
112 // GoogleTestFailureReporter and return it the first time called.
113 GTEST_API_ FailureReporterInterface
* GetFailureReporter() {
114 // Points to the global failure reporter used by Google Mock. gcc
115 // guarantees that the following use of failure_reporter is
116 // thread-safe. We may need to add additional synchronization to
117 // protect failure_reporter if we port Google Mock to other
119 static FailureReporterInterface
* const failure_reporter
=
120 new GoogleTestFailureReporter();
121 return failure_reporter
;
124 // Protects global resources (stdout in particular) used by Log().
125 static GTEST_DEFINE_STATIC_MUTEX_(g_log_mutex
);
127 // Returns true iff a log with the given severity is visible according
128 // to the --gmock_verbose flag.
129 GTEST_API_
bool LogIsVisible(LogSeverity severity
) {
130 if (GMOCK_FLAG(verbose
) == kInfoVerbosity
) {
131 // Always show the log if --gmock_verbose=info.
133 } else if (GMOCK_FLAG(verbose
) == kErrorVerbosity
) {
134 // Always hide it if --gmock_verbose=error.
137 // If --gmock_verbose is neither "info" nor "error", we treat it
138 // as "warning" (its default value).
139 return severity
== kWarning
;
143 // Prints the given message to stdout iff 'severity' >= the level
144 // specified by the --gmock_verbose flag. If stack_frames_to_skip >=
145 // 0, also prints the stack trace excluding the top
146 // stack_frames_to_skip frames. In opt mode, any positive
147 // stack_frames_to_skip is treated as 0, since we don't know which
148 // function calls will be inlined by the compiler and need to be
150 GTEST_API_
void Log(LogSeverity severity
, const std::string
& message
,
151 int stack_frames_to_skip
) {
152 if (!LogIsVisible(severity
))
155 // Ensures that logs from different threads don't interleave.
156 MutexLock
l(&g_log_mutex
);
158 // "using ::std::cout;" doesn't work with Symbian's STLport, where cout is a
161 if (severity
== kWarning
) {
162 // Prints a GMOCK WARNING marker to make the warnings easily searchable.
163 std::cout
<< "\nGMOCK WARNING:";
165 // Pre-pends a new-line to message if it doesn't start with one.
166 if (message
.empty() || message
[0] != '\n') {
169 std::cout
<< message
;
170 if (stack_frames_to_skip
>= 0) {
172 // In opt mode, we have to be conservative and skip no stack frame.
173 const int actual_to_skip
= 0;
175 // In dbg mode, we can do what the caller tell us to do (plus one
176 // for skipping this function's stack frame).
177 const int actual_to_skip
= stack_frames_to_skip
+ 1;
180 // Appends a new-line to message if it doesn't end with one.
181 if (!message
.empty() && *message
.rbegin() != '\n') {
184 std::cout
<< "Stack trace:\n"
185 << ::testing::internal::GetCurrentOsStackTraceExceptTop(
186 ::testing::UnitTest::GetInstance(), actual_to_skip
);
188 std::cout
<< ::std::flush
;
191 GTEST_API_ WithoutMatchers
GetWithoutMatchers() { return WithoutMatchers(); }
193 GTEST_API_
void IllegalDoDefault(const char* file
, int line
) {
196 "You are using DoDefault() inside a composite action like "
197 "DoAll() or WithArgs(). This is not supported for technical "
198 "reasons. Please instead spell out the default action, or "
199 "assign the default action to an Action variable and use "
200 "the variable in various places.");
203 } // namespace internal
204 } // namespace testing