gmock-spec-builders.h 74.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
// Copyright 2007, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
29

30
31
32
33
34
35
36
37
38

// Google Mock - a framework for writing C++ mock classes.
//
// This file implements the ON_CALL() and EXPECT_CALL() macros.
//
// A user can use the ON_CALL() macro to specify the default action of
// a mock method.  The syntax is:
//
//   ON_CALL(mock_object, Method(argument-matchers))
39
//       .With(multi-argument-matcher)
40
41
//       .WillByDefault(action);
//
42
//  where the .With() clause is optional.
43
44
45
46
47
//
// A user can use the EXPECT_CALL() macro to specify an expectation on
// a mock method.  The syntax is:
//
//   EXPECT_CALL(mock_object, Method(argument-matchers))
48
//       .With(multi-argument-matchers)
49
50
//       .Times(cardinality)
//       .InSequence(sequences)
51
//       .After(expectations)
52
53
54
55
//       .WillOnce(action)
//       .WillRepeatedly(action)
//       .RetiresOnSaturation();
//
56
57
// where all clauses are optional, and .InSequence()/.After()/
// .WillOnce() can appear any number of times.
58

Gennadiy Civil's avatar
 
Gennadiy Civil committed
59
60
// GOOGLETEST_CM0002 DO NOT DELETE

61
62
63
#ifndef GMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_
#define GMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_

Adam Badura's avatar
Adam Badura committed
64
#include <functional>
65
#include <map>
misterg's avatar
misterg committed
66
#include <memory>
67
68
69
#include <set>
#include <sstream>
#include <string>
70
#include <type_traits>
Abseil Team's avatar
Abseil Team committed
71
#include <utility>
72
#include <vector>
73
74
75
76
77
78
#include "gmock/gmock-actions.h"
#include "gmock/gmock-cardinalities.h"
#include "gmock/gmock-matchers.h"
#include "gmock/internal/gmock-internal-utils.h"
#include "gmock/internal/gmock-port.h"
#include "gtest/gtest.h"
79

Gennadiy Civil's avatar
Gennadiy Civil committed
80
81
82
83
#if GTEST_HAS_EXCEPTIONS
# include <stdexcept>  // NOLINT
#endif

misterg's avatar
misterg committed
84
85
86
GTEST_DISABLE_MSC_WARNINGS_PUSH_(4251 \
/* class A needs to have dll-interface to be used by clients of class B */)

87
88
namespace testing {

89
90
91
92
93
94
// An abstract handle of an expectation.
class Expectation;

// A set of expectation handles.
class ExpectationSet;

95
96
97
98
// Anything inside the 'internal' namespace IS INTERNAL IMPLEMENTATION
// and MUST NOT BE USED IN USER CODE!!!
namespace internal {

99
100
// Implements a mock function.
template <typename F> class FunctionMocker;
101
102
103
104

// Base class for expectations.
class ExpectationBase;

105
106
107
// Implements an expectation.
template <typename F> class TypedExpectation;

108
109
110
111
112
113
114
115
116
117
118
119
120
121
// Helper class for testing the Expectation class template.
class ExpectationTester;

// Protects the mock object registry (in class Mock), all function
// mockers, and all expectations.
//
// The reason we don't use more fine-grained protection is: when a
// mock function Foo() is called, it needs to consult its expectations
// to see which one should be picked.  If another thread is allowed to
// call a mock function (either Foo() or a different one) at the same
// time, it could affect the "retired" attributes of Foo()'s
// expectations when InSequence() is used, and thus affect which
// expectation gets picked.  Therefore, we sequence all mock function
// calls to ensure the integrity of the mock objects' states.
122
GTEST_API_ GTEST_DECLARE_STATIC_MUTEX_(g_gmock_mutex);
123

124
125
126
// Untyped base class for ActionResultHolder<R>.
class UntypedActionResultHolderBase;

Abseil Team's avatar
Abseil Team committed
127
// Abstract base class of FunctionMocker.  This is the
128
// type-agnostic part of the function mocker interface.  Its pure
Abseil Team's avatar
Abseil Team committed
129
// virtual methods are implemented by FunctionMocker.
130
class GTEST_API_ UntypedFunctionMockerBase {
131
 public:
132
133
  UntypedFunctionMockerBase();
  virtual ~UntypedFunctionMockerBase();
134
135
136
137

  // Verifies that all expectations on this mock function have been
  // satisfied.  Reports one or more Google Test non-fatal failures
  // and returns false if not.
138
139
  bool VerifyAndClearExpectationsLocked()
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
140
141

  // Clears the ON_CALL()s set on this mock function.
142
143
  virtual void ClearDefaultActionsLocked()
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) = 0;
144
145
146
147
148
149
150
151
152
153
154

  // In all of the following Untyped* functions, it's the caller's
  // responsibility to guarantee the correctness of the arguments'
  // types.

  // Performs the default action with the given arguments and returns
  // the action's result.  The call description string will be used in
  // the error message to describe the call in the case the default
  // action fails.
  // L = *
  virtual UntypedActionResultHolderBase* UntypedPerformDefaultAction(
Gennadiy Civil's avatar
Gennadiy Civil committed
155
      void* untyped_args, const std::string& call_description) const = 0;
156
157
158
159
160

  // Performs the given action with the given arguments and returns
  // the action's result.
  // L = *
  virtual UntypedActionResultHolderBase* UntypedPerformAction(
Gennadiy Civil's avatar
Gennadiy Civil committed
161
      const void* untyped_action, void* untyped_args) const = 0;
162
163
164
165

  // Writes a message that the call is uninteresting (i.e. neither
  // explicitly expected nor explicitly unexpected) to the given
  // ostream.
166
167
168
169
  virtual void UntypedDescribeUninterestingCall(
      const void* untyped_args,
      ::std::ostream* os) const
          GTEST_LOCK_EXCLUDED_(g_gmock_mutex) = 0;
170
171
172
173
174
175
176
177
178
179

  // Returns the expectation that matches the given function arguments
  // (or NULL is there's no match); when a match is found,
  // untyped_action is set to point to the action that should be
  // performed (or NULL if the action is "do default"), and
  // is_excessive is modified to indicate whether the call exceeds the
  // expected number.
  virtual const ExpectationBase* UntypedFindMatchingExpectation(
      const void* untyped_args,
      const void** untyped_action, bool* is_excessive,
180
181
      ::std::ostream* what, ::std::ostream* why)
          GTEST_LOCK_EXCLUDED_(g_gmock_mutex) = 0;
182
183
184
185
186
187
188
189
190

  // Prints the given function arguments to the ostream.
  virtual void UntypedPrintArgs(const void* untyped_args,
                                ::std::ostream* os) const = 0;

  // Sets the mock object this mock method belongs to, and registers
  // this information in the global mock registry.  Will be called
  // whenever an EXPECT_CALL() or ON_CALL() is executed on this mock
  // method.
191
192
  void RegisterOwner(const void* mock_obj)
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
193
194
195
196

  // Sets the mock object this mock method belongs to, and sets the
  // name of the mock function.  Will be called upon each invocation
  // of this mock function.
197
198
  void SetOwnerAndName(const void* mock_obj, const char* name)
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
199
200
201
202

  // Returns the mock object this mock method belongs to.  Must be
  // called after RegisterOwner() or SetOwnerAndName() has been
  // called.
203
204
  const void* MockObject() const
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
205
206
207

  // Returns the name of this mock method.  Must be called after
  // SetOwnerAndName() has been called.
208
209
  const char* Name() const
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
210
211
212
213
214

  // Returns the result of invoking this mock function with the given
  // arguments.  This function can be safely called from multiple
  // threads concurrently.  The caller is responsible for deleting the
  // result.
Gennadiy Civil's avatar
Gennadiy Civil committed
215
216
  UntypedActionResultHolderBase* UntypedInvokeWith(void* untyped_args)
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
217
218
219
220

 protected:
  typedef std::vector<const void*> UntypedOnCallSpecs;

misterg's avatar
misterg committed
221
  using UntypedExpectations = std::vector<std::shared_ptr<ExpectationBase>>;
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239

  // Returns an Expectation object that references and co-owns exp,
  // which must be an expectation on this mock function.
  Expectation GetHandleOf(ExpectationBase* exp);

  // Address of the mock object this mock method belongs to.  Only
  // valid after this mock method has been called or
  // ON_CALL/EXPECT_CALL has been invoked on it.
  const void* mock_obj_;  // Protected by g_gmock_mutex.

  // Name of the function being mocked.  Only valid after this mock
  // method has been called.
  const char* name_;  // Protected by g_gmock_mutex.

  // All default action specs for this function mocker.
  UntypedOnCallSpecs untyped_on_call_specs_;

  // All expectations for this function mocker.
Gennadiy Civil's avatar
Gennadiy Civil committed
240
241
242
243
244
245
246
247
  //
  // It's undefined behavior to interleave expectations (EXPECT_CALLs
  // or ON_CALLs) and mock function calls.  Also, the order of
  // expectations is important.  Therefore it's a logic race condition
  // to read/write untyped_expectations_ concurrently.  In order for
  // tools like tsan to catch concurrent read/write accesses to
  // untyped_expectations, we deliberately leave accesses to it
  // unprotected.
248
  UntypedExpectations untyped_expectations_;
249
250
};  // class UntypedFunctionMockerBase

251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
// Untyped base class for OnCallSpec<F>.
class UntypedOnCallSpecBase {
 public:
  // The arguments are the location of the ON_CALL() statement.
  UntypedOnCallSpecBase(const char* a_file, int a_line)
      : file_(a_file), line_(a_line), last_clause_(kNone) {}

  // Where in the source file was the default action spec defined?
  const char* file() const { return file_; }
  int line() const { return line_; }

 protected:
  // Gives each clause in the ON_CALL() statement a name.
  enum Clause {
    // Do not change the order of the enum members!  The run-time
    // syntax checking relies on it.
    kNone,
    kWith,
269
    kWillByDefault
270
271
272
  };

  // Asserts that the ON_CALL() statement has a certain property.
273
274
  void AssertSpecProperty(bool property,
                          const std::string& failure_message) const {
275
276
277
278
    Assert(property, file_, line_, failure_message);
  }

  // Expects that the ON_CALL() statement has a certain property.
279
280
  void ExpectSpecProperty(bool property,
                          const std::string& failure_message) const {
281
282
283
284
285
286
287
288
289
290
291
292
    Expect(property, file_, line_, failure_message);
  }

  const char* file_;
  int line_;

  // The last clause in the ON_CALL() statement as seen so far.
  // Initially kNone and changes as the statement is parsed.
  Clause last_clause_;
};  // class UntypedOnCallSpecBase

// This template class implements an ON_CALL spec.
293
template <typename F>
294
class OnCallSpec : public UntypedOnCallSpecBase {
295
296
297
298
 public:
  typedef typename Function<F>::ArgumentTuple ArgumentTuple;
  typedef typename Function<F>::ArgumentMatcherTuple ArgumentMatcherTuple;

299
  // Constructs an OnCallSpec object from the information inside
300
  // the parenthesis of an ON_CALL() statement.
301
302
303
  OnCallSpec(const char* a_file, int a_line,
             const ArgumentMatcherTuple& matchers)
      : UntypedOnCallSpecBase(a_file, a_line),
304
        matchers_(matchers),
Abseil Team's avatar
Abseil Team committed
305
306
307
308
        // By default, extra_matcher_ should match anything.  However,
        // we cannot initialize it with _ as that causes ambiguity between
        // Matcher's copy and move constructor for some argument types.
        extra_matcher_(A<const ArgumentTuple&>()) {}
309

310
  // Implements the .With() clause.
311
  OnCallSpec& With(const Matcher<const ArgumentTuple&>& m) {
312
    // Makes sure this is called at most once.
313
314
    ExpectSpecProperty(last_clause_ < kWith,
                       ".With() cannot appear "
315
                       "more than once in an ON_CALL().");
316
    last_clause_ = kWith;
317
318
319
320
321
322

    extra_matcher_ = m;
    return *this;
  }

  // Implements the .WillByDefault() clause.
323
  OnCallSpec& WillByDefault(const Action<F>& action) {
324
    ExpectSpecProperty(last_clause_ < kWillByDefault,
325
326
                       ".WillByDefault() must appear "
                       "exactly once in an ON_CALL().");
327
    last_clause_ = kWillByDefault;
328
329
330
331
332
333
334

    ExpectSpecProperty(!action.IsDoDefault(),
                       "DoDefault() cannot be used in ON_CALL().");
    action_ = action;
    return *this;
  }

335
  // Returns true if and only if the given arguments match the matchers.
336
337
338
339
340
341
  bool Matches(const ArgumentTuple& args) const {
    return TupleMatches(matchers_, args) && extra_matcher_.Matches(args);
  }

  // Returns the action specified by the user.
  const Action<F>& GetAction() const {
342
    AssertSpecProperty(last_clause_ == kWillByDefault,
343
344
345
346
                       ".WillByDefault() must appear exactly "
                       "once in an ON_CALL().");
    return action_;
  }
347

348
349
350
351
 private:
  // The information in statement
  //
  //   ON_CALL(mock_object, Method(matchers))
352
  //       .With(multi-argument-matcher)
353
354
355
356
357
358
359
360
361
362
363
364
  //       .WillByDefault(action);
  //
  // is recorded in the data members like this:
  //
  //   source file that contains the statement => file_
  //   line number of the statement            => line_
  //   matchers                                => matchers_
  //   multi-argument-matcher                  => extra_matcher_
  //   action                                  => action_
  ArgumentMatcherTuple matchers_;
  Matcher<const ArgumentTuple&> extra_matcher_;
  Action<F> action_;
365
};  // class OnCallSpec
366

zhanyong.wan's avatar
zhanyong.wan committed
367
// Possible reactions on uninteresting calls.
368
enum CallReaction {
zhanyong.wan's avatar
zhanyong.wan committed
369
370
  kAllow,
  kWarn,
371
  kFail,
372
373
374
375
376
};

}  // namespace internal

// Utilities for manipulating mock objects.
377
class GTEST_API_ Mock {
378
379
380
 public:
  // The following public methods can be called concurrently.

381
382
  // Tells Google Mock to ignore mock_obj when checking for leaked
  // mock objects.
383
384
  static void AllowLeak(const void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
385

386
387
388
  // Verifies and clears all expectations on the given mock object.
  // If the expectations aren't satisfied, generates one or more
  // Google Test non-fatal failures and returns false.
389
390
  static bool VerifyAndClearExpectations(void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
391
392

  // Verifies all expectations on the given mock object and clears its
393
  // default actions and expectations.  Returns true if and only if the
394
  // verification was successful.
395
396
  static bool VerifyAndClear(void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
397

398
  // Returns whether the mock was created as a naggy mock (default)
399
400
  static bool IsNaggy(void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
401
  // Returns whether the mock was created as a nice mock
402
403
  static bool IsNice(void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
404
  // Returns whether the mock was created as a strict mock
405
406
407
  static bool IsStrict(void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);

408
 private:
409
410
  friend class internal::UntypedFunctionMockerBase;

411
412
413
  // Needed for a function mocker to register itself (so that we know
  // how to clear a mock object).
  template <typename F>
Abseil Team's avatar
Abseil Team committed
414
  friend class internal::FunctionMocker;
415
416

  template <typename M>
417
  friend class NiceMock;
418

zhanyong.wan's avatar
zhanyong.wan committed
419
  template <typename M>
420
  friend class NaggyMock;
zhanyong.wan's avatar
zhanyong.wan committed
421

422
  template <typename M>
423
  friend class StrictMock;
424
425
426

  // Tells Google Mock to allow uninteresting calls on the given mock
  // object.
427
428
  static void AllowUninterestingCalls(const void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
429
430
431

  // Tells Google Mock to warn the user about uninteresting calls on
  // the given mock object.
432
433
  static void WarnUninterestingCalls(const void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
434
435
436

  // Tells Google Mock to fail uninteresting calls on the given mock
  // object.
437
438
  static void FailUninterestingCalls(const void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
439
440
441

  // Tells Google Mock the given mock object is being destroyed and
  // its entry in the call-reaction table should be removed.
442
443
  static void UnregisterCallReaction(const void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
444
445
446
447

  // Returns the reaction Google Mock will have on uninteresting calls
  // made on the given mock object.
  static internal::CallReaction GetReactionOnUninterestingCalls(
zhanyong.wan's avatar
zhanyong.wan committed
448
      const void* mock_obj)
449
          GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
450
451
452
453

  // Verifies that all expectations on the given mock object have been
  // satisfied.  Reports one or more Google Test non-fatal failures
  // and returns false if not.
454
455
  static bool VerifyAndClearExpectationsLocked(void* mock_obj)
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex);
456
457

  // Clears all ON_CALL()s set on the given mock object.
458
459
  static void ClearDefaultActionsLocked(void* mock_obj)
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex);
460
461

  // Registers a mock object and a mock method it owns.
462
463
464
465
  static void Register(
      const void* mock_obj,
      internal::UntypedFunctionMockerBase* mocker)
          GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
466

467
468
469
470
  // Tells Google Mock where in the source code mock_obj is used in an
  // ON_CALL or EXPECT_CALL.  In case mock_obj is leaked, this
  // information helps the user identify which object it is.
  static void RegisterUseByOnCallOrExpectCall(
471
472
      const void* mock_obj, const char* file, int line)
          GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
473

474
475
476
  // Unregisters a mock method; removes the owning mock object from
  // the registry when the last mock method associated with it has
  // been unregistered.  This is called only in the destructor of
Abseil Team's avatar
Abseil Team committed
477
  // FunctionMocker.
478
479
  static void UnregisterLocked(internal::UntypedFunctionMockerBase* mocker)
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex);
480
481
};  // class Mock

482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
// An abstract handle of an expectation.  Useful in the .After()
// clause of EXPECT_CALL() for setting the (partial) order of
// expectations.  The syntax:
//
//   Expectation e1 = EXPECT_CALL(...)...;
//   EXPECT_CALL(...).After(e1)...;
//
// sets two expectations where the latter can only be matched after
// the former has been satisfied.
//
// Notes:
//   - This class is copyable and has value semantics.
//   - Constness is shallow: a const Expectation object itself cannot
//     be modified, but the mutable methods of the ExpectationBase
//     object it references can be called via expectation_base().
misterg's avatar
misterg committed
497

498
class GTEST_API_ Expectation {
499
500
 public:
  // Constructs a null object that doesn't reference any expectation.
501
502
503
  Expectation();

  ~Expectation();
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518

  // This single-argument ctor must not be explicit, in order to support the
  //   Expectation e = EXPECT_CALL(...);
  // syntax.
  //
  // A TypedExpectation object stores its pre-requisites as
  // Expectation objects, and needs to call the non-const Retire()
  // method on the ExpectationBase objects they reference.  Therefore
  // Expectation must receive a *non-const* reference to the
  // ExpectationBase object.
  Expectation(internal::ExpectationBase& exp);  // NOLINT

  // The compiler-generated copy ctor and operator= work exactly as
  // intended, so we don't need to define our own.

519
520
  // Returns true if and only if rhs references the same expectation as this
  // object does.
521
522
523
524
525
526
527
528
529
530
  bool operator==(const Expectation& rhs) const {
    return expectation_base_ == rhs.expectation_base_;
  }

  bool operator!=(const Expectation& rhs) const { return !(*this == rhs); }

 private:
  friend class ExpectationSet;
  friend class Sequence;
  friend class ::testing::internal::ExpectationBase;
531
  friend class ::testing::internal::UntypedFunctionMockerBase;
532
533

  template <typename F>
Abseil Team's avatar
Abseil Team committed
534
  friend class ::testing::internal::FunctionMocker;
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549

  template <typename F>
  friend class ::testing::internal::TypedExpectation;

  // This comparator is needed for putting Expectation objects into a set.
  class Less {
   public:
    bool operator()(const Expectation& lhs, const Expectation& rhs) const {
      return lhs.expectation_base_.get() < rhs.expectation_base_.get();
    }
  };

  typedef ::std::set<Expectation, Less> Set;

  Expectation(
misterg's avatar
misterg committed
550
      const std::shared_ptr<internal::ExpectationBase>& expectation_base);
551
552

  // Returns the expectation this object references.
misterg's avatar
misterg committed
553
  const std::shared_ptr<internal::ExpectationBase>& expectation_base() const {
554
555
556
    return expectation_base_;
  }

misterg's avatar
misterg committed
557
558
  // A shared_ptr that co-owns the expectation this handle references.
  std::shared_ptr<internal::ExpectationBase> expectation_base_;
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
};

// A set of expectation handles.  Useful in the .After() clause of
// EXPECT_CALL() for setting the (partial) order of expectations.  The
// syntax:
//
//   ExpectationSet es;
//   es += EXPECT_CALL(...)...;
//   es += EXPECT_CALL(...)...;
//   EXPECT_CALL(...).After(es)...;
//
// sets three expectations where the last one can only be matched
// after the first two have both been satisfied.
//
// This class is copyable and has value semantics.
class ExpectationSet {
 public:
  // A bidirectional iterator that can read a const element in the set.
  typedef Expectation::Set::const_iterator const_iterator;

  // An object stored in the set.  This is an alias of Expectation.
  typedef Expectation::Set::value_type value_type;

  // Constructs an empty set.
  ExpectationSet() {}

  // This single-argument ctor must not be explicit, in order to support the
  //   ExpectationSet es = EXPECT_CALL(...);
  // syntax.
  ExpectationSet(internal::ExpectationBase& exp) {  // NOLINT
    *this += Expectation(exp);
  }

  // This single-argument ctor implements implicit conversion from
  // Expectation and thus must not be explicit.  This allows either an
  // Expectation or an ExpectationSet to be used in .After().
  ExpectationSet(const Expectation& e) {  // NOLINT
    *this += e;
  }

  // The compiler-generator ctor and operator= works exactly as
  // intended, so we don't need to define our own.

602
603
  // Returns true if and only if rhs contains the same set of Expectation
  // objects as this does.
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
  bool operator==(const ExpectationSet& rhs) const {
    return expectations_ == rhs.expectations_;
  }

  bool operator!=(const ExpectationSet& rhs) const { return !(*this == rhs); }

  // Implements the syntax
  //   expectation_set += EXPECT_CALL(...);
  ExpectationSet& operator+=(const Expectation& e) {
    expectations_.insert(e);
    return *this;
  }

  int size() const { return static_cast<int>(expectations_.size()); }

  const_iterator begin() const { return expectations_.begin(); }
  const_iterator end() const { return expectations_.end(); }

 private:
  Expectation::Set expectations_;
};


627
628
629
// Sequence objects are used by a user to specify the relative order
// in which the expectations should match.  They are copyable (we rely
// on the compiler-defined copy constructor and assignment operator).
630
class GTEST_API_ Sequence {
631
632
 public:
  // Constructs an empty sequence.
633
  Sequence() : last_expectation_(new Expectation) {}
634
635
636

  // Adds an expectation to this sequence.  The caller must ensure
  // that no other thread is accessing this Sequence object.
637
638
  void AddExpectation(const Expectation& expectation) const;

639
 private:
misterg's avatar
misterg committed
640
641
  // The last expectation in this sequence.
  std::shared_ptr<Expectation> last_expectation_;
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
};  // class Sequence

// An object of this type causes all EXPECT_CALL() statements
// encountered in its scope to be put in an anonymous sequence.  The
// work is done in the constructor and destructor.  You should only
// create an InSequence object on the stack.
//
// The sole purpose for this class is to support easy definition of
// sequential expectations, e.g.
//
//   {
//     InSequence dummy;  // The name of the object doesn't matter.
//
//     // The following expectations must match in the order they appear.
//     EXPECT_CALL(a, Bar())...;
//     EXPECT_CALL(a, Baz())...;
//     ...
//     EXPECT_CALL(b, Xyz())...;
//   }
//
// You can create InSequence objects in multiple threads, as long as
// they are used to affect different mock objects.  The idea is that
// each thread can create and set up its own mocks as if it's the only
// thread.  However, for clarity of your tests we recommend you to set
// up mocks in the main thread unless you have a good reason not to do
// so.
668
class GTEST_API_ InSequence {
669
670
671
672
673
674
675
 public:
  InSequence();
  ~InSequence();
 private:
  bool sequence_created_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(InSequence);  // NOLINT
676
} GTEST_ATTRIBUTE_UNUSED_;
677
678
679
680
681

namespace internal {

// Points to the implicit sequence introduced by a living InSequence
// object (if any) in the current thread or NULL.
682
GTEST_API_ extern ThreadLocal<Sequence*> g_gmock_implicit_sequence;
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697

// Base class for implementing expectations.
//
// There are two reasons for having a type-agnostic base class for
// Expectation:
//
//   1. We need to store collections of expectations of different
//   types (e.g. all pre-requisites of a particular expectation, all
//   expectations in a sequence).  Therefore these expectation objects
//   must share a common base class.
//
//   2. We can avoid binary code bloat by moving methods not depending
//   on the template argument of Expectation to the base class.
//
// This class is internal and mustn't be used by user code directly.
698
class GTEST_API_ ExpectationBase {
699
 public:
700
  // source_text is the EXPECT_CALL(...) source that created this Expectation.
701
  ExpectationBase(const char* file, int line, const std::string& source_text);
702
703
704
705
706
707

  virtual ~ExpectationBase();

  // Where in the source file was the expectation spec defined?
  const char* file() const { return file_; }
  int line() const { return line_; }
708
  const char* source_text() const { return source_text_.c_str(); }
709
710
711
712
713
  // Returns the cardinality specified in the expectation spec.
  const Cardinality& cardinality() const { return cardinality_; }

  // Describes the source file location of this expectation.
  void DescribeLocationTo(::std::ostream* os) const {
714
    *os << FormatFileLocation(file(), line()) << " ";
715
716
717
718
  }

  // Describes how many times a function call matching this
  // expectation has occurred.
719
720
  void DescribeCallCountTo(::std::ostream* os) const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
721
722
723
724

  // If this mock method has an extra matcher (i.e. .With(matcher)),
  // describes it to the ostream.
  virtual void MaybeDescribeExtraMatcherTo(::std::ostream* os) = 0;
725

726
 protected:
727
  friend class ::testing::Expectation;
728
  friend class UntypedFunctionMockerBase;
729
730
731

  enum Clause {
    // Don't change the order of the enum members!
732
733
734
735
    kNone,
    kWith,
    kTimes,
    kInSequence,
736
    kAfter,
737
738
    kWillOnce,
    kWillRepeatedly,
739
    kRetiresOnSaturation
740
741
  };

742
743
  typedef std::vector<const void*> UntypedActions;

744
745
746
747
  // Returns an Expectation object that references and co-owns this
  // expectation.
  virtual Expectation GetHandle() = 0;

748
  // Asserts that the EXPECT_CALL() statement has the given property.
749
750
  void AssertSpecProperty(bool property,
                          const std::string& failure_message) const {
751
752
753
754
    Assert(property, file_, line_, failure_message);
  }

  // Expects that the EXPECT_CALL() statement has the given property.
755
756
  void ExpectSpecProperty(bool property,
                          const std::string& failure_message) const {
757
758
759
760
761
762
763
    Expect(property, file_, line_, failure_message);
  }

  // Explicitly specifies the cardinality of this expectation.  Used
  // by the subclasses to implement the .Times() clause.
  void SpecifyCardinality(const Cardinality& cardinality);

764
765
  // Returns true if and only if the user specified the cardinality
  // explicitly using a .Times().
766
767
768
  bool cardinality_specified() const { return cardinality_specified_; }

  // Sets the cardinality of this expectation spec.
769
770
  void set_cardinality(const Cardinality& a_cardinality) {
    cardinality_ = a_cardinality;
771
772
773
774
775
776
777
  }

  // The following group of methods should only be called after the
  // EXPECT_CALL() statement, and only when g_gmock_mutex is held by
  // the current thread.

  // Retires all pre-requisites of this expectation.
778
779
  void RetireAllPreRequisites()
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
780

781
  // Returns true if and only if this expectation is retired.
782
783
  bool is_retired() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
784
785
786
787
788
    g_gmock_mutex.AssertHeld();
    return retired_;
  }

  // Retires this expectation.
789
790
  void Retire()
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
791
792
793
794
    g_gmock_mutex.AssertHeld();
    retired_ = true;
  }

795
  // Returns true if and only if this expectation is satisfied.
796
797
  bool IsSatisfied() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
798
799
800
801
    g_gmock_mutex.AssertHeld();
    return cardinality().IsSatisfiedByCallCount(call_count_);
  }

802
  // Returns true if and only if this expectation is saturated.
803
804
  bool IsSaturated() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
805
806
807
808
    g_gmock_mutex.AssertHeld();
    return cardinality().IsSaturatedByCallCount(call_count_);
  }

809
  // Returns true if and only if this expectation is over-saturated.
810
811
  bool IsOverSaturated() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
812
813
814
815
    g_gmock_mutex.AssertHeld();
    return cardinality().IsOverSaturatedByCallCount(call_count_);
  }

816
817
  // Returns true if and only if all pre-requisites of this expectation are
  // satisfied.
818
819
  bool AllPrerequisitesAreSatisfied() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
820
821

  // Adds unsatisfied pre-requisites of this expectation to 'result'.
822
823
  void FindUnsatisfiedPrerequisites(ExpectationSet* result) const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
824
825

  // Returns the number this expectation has been invoked.
826
827
  int call_count() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
828
829
830
831
832
    g_gmock_mutex.AssertHeld();
    return call_count_;
  }

  // Increments the number this expectation has been invoked.
833
834
  void IncrementCallCount()
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
835
836
837
838
    g_gmock_mutex.AssertHeld();
    call_count_++;
  }

839
840
841
842
  // Checks the action count (i.e. the number of WillOnce() and
  // WillRepeatedly() clauses) against the cardinality if this hasn't
  // been done before.  Prints a warning if there are too many or too
  // few actions.
843
844
  void CheckActionCountIfNotDone() const
      GTEST_LOCK_EXCLUDED_(mutex_);
845

846
847
848
849
  friend class ::testing::Sequence;
  friend class ::testing::internal::ExpectationTester;

  template <typename Function>
850
  friend class TypedExpectation;
851

852
853
854
  // Implements the .Times() clause.
  void UntypedTimes(const Cardinality& a_cardinality);

855
856
  // This group of fields are part of the spec and won't change after
  // an EXPECT_CALL() statement finishes.
857
858
  const char* file_;          // The file that contains the expectation.
  int line_;                  // The line number of the expectation.
859
  const std::string source_text_;  // The EXPECT_CALL(...) source text.
860
  // True if and only if the cardinality is specified explicitly.
861
862
  bool cardinality_specified_;
  Cardinality cardinality_;            // The cardinality of the expectation.
863
864
  // The immediate pre-requisites (i.e. expectations that must be
  // satisfied before this expectation can be matched) of this
misterg's avatar
misterg committed
865
  // expectation.  We use std::shared_ptr in the set because we want an
866
867
868
869
  // Expectation object to be co-owned by its FunctionMocker and its
  // successors.  This allows multiple mock objects to be deleted at
  // different times.
  ExpectationSet immediate_prerequisites_;
870
871
872
873

  // This group of fields are the current state of the expectation,
  // and can change as the mock function is called.
  int call_count_;  // How many times this expectation has been invoked.
874
  bool retired_;    // True if and only if this expectation has retired.
875
876
877
878
879
880
881
  UntypedActions untyped_actions_;
  bool extra_matcher_specified_;
  bool repeated_action_specified_;  // True if a WillRepeatedly() was specified.
  bool retires_on_saturation_;
  Clause last_clause_;
  mutable bool action_count_checked_;  // Under mutex_.
  mutable Mutex mutex_;  // Protects action_count_checked_.
882
883

  GTEST_DISALLOW_ASSIGN_(ExpectationBase);
884
885
886
887
};  // class ExpectationBase

// Impements an expectation for the given function type.
template <typename F>
888
class TypedExpectation : public ExpectationBase {
889
890
891
892
893
 public:
  typedef typename Function<F>::ArgumentTuple ArgumentTuple;
  typedef typename Function<F>::ArgumentMatcherTuple ArgumentMatcherTuple;
  typedef typename Function<F>::Result Result;

Abseil Team's avatar
Abseil Team committed
894
  TypedExpectation(FunctionMocker<F>* owner, const char* a_file, int a_line,
895
                   const std::string& a_source_text,
896
                   const ArgumentMatcherTuple& m)
897
      : ExpectationBase(a_file, a_line, a_source_text),
898
899
        owner_(owner),
        matchers_(m),
Abseil Team's avatar
Abseil Team committed
900
901
902
903
        // By default, extra_matcher_ should match anything.  However,
        // we cannot initialize it with _ as that causes ambiguity between
        // Matcher's copy and move constructor for some argument types.
        extra_matcher_(A<const ArgumentTuple&>()),
904
        repeated_action_(DoDefault()) {}
905

Abseil Team's avatar
Abseil Team committed
906
  ~TypedExpectation() override {
907
908
909
    // Check the validity of the action count if it hasn't been done
    // yet (for example, if the expectation was never used).
    CheckActionCountIfNotDone();
910
911
912
913
    for (UntypedActions::const_iterator it = untyped_actions_.begin();
         it != untyped_actions_.end(); ++it) {
      delete static_cast<const Action<F>*>(*it);
    }
914
915
  }

916
  // Implements the .With() clause.
917
  TypedExpectation& With(const Matcher<const ArgumentTuple&>& m) {
918
    if (last_clause_ == kWith) {
919
      ExpectSpecProperty(false,
920
                         ".With() cannot appear "
921
922
                         "more than once in an EXPECT_CALL().");
    } else {
923
924
      ExpectSpecProperty(last_clause_ < kWith,
                         ".With() must be the first "
925
926
                         "clause in an EXPECT_CALL().");
    }
927
    last_clause_ = kWith;
928
929

    extra_matcher_ = m;
930
    extra_matcher_specified_ = true;
931
932
933
934
    return *this;
  }

  // Implements the .Times() clause.
935
  TypedExpectation& Times(const Cardinality& a_cardinality) {
936
    ExpectationBase::UntypedTimes(a_cardinality);
937
938
939
940
    return *this;
  }

  // Implements the .Times() clause.
941
  TypedExpectation& Times(int n) {
942
943
944
945
    return Times(Exactly(n));
  }

  // Implements the .InSequence() clause.
946
  TypedExpectation& InSequence(const Sequence& s) {
947
    ExpectSpecProperty(last_clause_ <= kInSequence,
948
949
                       ".InSequence() cannot appear after .After(),"
                       " .WillOnce(), .WillRepeatedly(), or "
950
                       ".RetiresOnSaturation().");
951
    last_clause_ = kInSequence;
952

953
    s.AddExpectation(GetHandle());
954
955
    return *this;
  }
956
  TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2) {
957
958
    return InSequence(s1).InSequence(s2);
  }
959
960
  TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2,
                               const Sequence& s3) {
961
962
    return InSequence(s1, s2).InSequence(s3);
  }
963
964
  TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2,
                               const Sequence& s3, const Sequence& s4) {
965
966
    return InSequence(s1, s2, s3).InSequence(s4);
  }
967
968
969
  TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2,
                               const Sequence& s3, const Sequence& s4,
                               const Sequence& s5) {
970
971
972
    return InSequence(s1, s2, s3, s4).InSequence(s5);
  }

973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
  // Implements that .After() clause.
  TypedExpectation& After(const ExpectationSet& s) {
    ExpectSpecProperty(last_clause_ <= kAfter,
                       ".After() cannot appear after .WillOnce(),"
                       " .WillRepeatedly(), or "
                       ".RetiresOnSaturation().");
    last_clause_ = kAfter;

    for (ExpectationSet::const_iterator it = s.begin(); it != s.end(); ++it) {
      immediate_prerequisites_ += *it;
    }
    return *this;
  }
  TypedExpectation& After(const ExpectationSet& s1, const ExpectationSet& s2) {
    return After(s1).After(s2);
  }
  TypedExpectation& After(const ExpectationSet& s1, const ExpectationSet& s2,
                          const ExpectationSet& s3) {
    return After(s1, s2).After(s3);
  }
  TypedExpectation& After(const ExpectationSet& s1, const ExpectationSet& s2,
                          const ExpectationSet& s3, const ExpectationSet& s4) {
    return After(s1, s2, s3).After(s4);
  }
  TypedExpectation& After(const ExpectationSet& s1, const ExpectationSet& s2,
                          const ExpectationSet& s3, const ExpectationSet& s4,
                          const ExpectationSet& s5) {
    return After(s1, s2, s3, s4).After(s5);
  }

1003
  // Implements the .WillOnce() clause.
1004
  TypedExpectation& WillOnce(const Action<F>& action) {
1005
    ExpectSpecProperty(last_clause_ <= kWillOnce,
1006
1007
                       ".WillOnce() cannot appear after "
                       ".WillRepeatedly() or .RetiresOnSaturation().");
1008
    last_clause_ = kWillOnce;
1009

1010
    untyped_actions_.push_back(new Action<F>(action));
1011
    if (!cardinality_specified()) {
1012
      set_cardinality(Exactly(static_cast<int>(untyped_actions_.size())));
1013
1014
1015
1016
1017
    }
    return *this;
  }

  // Implements the .WillRepeatedly() clause.
1018
  TypedExpectation& WillRepeatedly(const Action<F>& action) {
1019
    if (last_clause_ == kWillRepeatedly) {
1020
1021
1022
1023
      ExpectSpecProperty(false,
                         ".WillRepeatedly() cannot appear "
                         "more than once in an EXPECT_CALL().");
    } else {
1024
      ExpectSpecProperty(last_clause_ < kWillRepeatedly,
1025
1026
1027
                         ".WillRepeatedly() cannot appear "
                         "after .RetiresOnSaturation().");
    }
1028
    last_clause_ = kWillRepeatedly;
1029
1030
1031
1032
    repeated_action_specified_ = true;

    repeated_action_ = action;
    if (!cardinality_specified()) {
1033
      set_cardinality(AtLeast(static_cast<int>(untyped_actions_.size())));
1034
1035
1036
1037
1038
1039
1040
1041
1042
    }

    // Now that no more action clauses can be specified, we check
    // whether their count makes sense.
    CheckActionCountIfNotDone();
    return *this;
  }

  // Implements the .RetiresOnSaturation() clause.
1043
  TypedExpectation& RetiresOnSaturation() {
1044
    ExpectSpecProperty(last_clause_ < kRetiresOnSaturation,
1045
1046
                       ".RetiresOnSaturation() cannot appear "
                       "more than once.");
1047
    last_clause_ = kRetiresOnSaturation;
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
    retires_on_saturation_ = true;

    // Now that no more action clauses can be specified, we check
    // whether their count makes sense.
    CheckActionCountIfNotDone();
    return *this;
  }

  // Returns the matchers for the arguments as specified inside the
  // EXPECT_CALL() macro.
  const ArgumentMatcherTuple& matchers() const {
    return matchers_;
  }

1062
  // Returns the matcher specified by the .With() clause.
1063
1064
1065
1066
1067
1068
1069
  const Matcher<const ArgumentTuple&>& extra_matcher() const {
    return extra_matcher_;
  }

  // Returns the action specified by the .WillRepeatedly() clause.
  const Action<F>& repeated_action() const { return repeated_action_; }

1070
1071
  // If this mock method has an extra matcher (i.e. .With(matcher)),
  // describes it to the ostream.
Abseil Team's avatar
Abseil Team committed
1072
  void MaybeDescribeExtraMatcherTo(::std::ostream* os) override {
1073
1074
1075
1076
1077
1078
1079
    if (extra_matcher_specified_) {
      *os << "    Expected args: ";
      extra_matcher_.DescribeTo(os);
      *os << "\n";
    }
  }

1080
1081
 private:
  template <typename Function>
Abseil Team's avatar
Abseil Team committed
1082
  friend class FunctionMocker;
1083

1084
1085
  // Returns an Expectation object that references and co-owns this
  // expectation.
Abseil Team's avatar
Abseil Team committed
1086
  Expectation GetHandle() override { return owner_->GetHandleOf(this); }
1087

1088
1089
1090
1091
  // The following methods will be called only after the EXPECT_CALL()
  // statement finishes and when the current thread holds
  // g_gmock_mutex.

1092
  // Returns true if and only if this expectation matches the given arguments.
1093
1094
  bool Matches(const ArgumentTuple& args) const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1095
1096
1097
1098
    g_gmock_mutex.AssertHeld();
    return TupleMatches(matchers_, args) && extra_matcher_.Matches(args);
  }

1099
1100
  // Returns true if and only if this expectation should handle the given
  // arguments.
1101
1102
  bool ShouldHandleArguments(const ArgumentTuple& args) const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
    g_gmock_mutex.AssertHeld();

    // In case the action count wasn't checked when the expectation
    // was defined (e.g. if this expectation has no WillRepeatedly()
    // or RetiresOnSaturation() clause), we check it when the
    // expectation is used for the first time.
    CheckActionCountIfNotDone();
    return !is_retired() && AllPrerequisitesAreSatisfied() && Matches(args);
  }

  // Describes the result of matching the arguments against this
  // expectation to the given ostream.
1115
1116
1117
1118
  void ExplainMatchResultTo(
      const ArgumentTuple& args,
      ::std::ostream* os) const
          GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1119
1120
1121
1122
1123
1124
1125
    g_gmock_mutex.AssertHeld();

    if (is_retired()) {
      *os << "         Expected: the expectation is active\n"
          << "           Actual: it is retired\n";
    } else if (!Matches(args)) {
      if (!TupleMatches(matchers_, args)) {
1126
        ExplainMatchFailureTupleTo(matchers_, args, os);
1127
      }
zhanyong.wan's avatar
zhanyong.wan committed
1128
1129
      StringMatchResultListener listener;
      if (!extra_matcher_.MatchAndExplain(args, &listener)) {
1130
        *os << "    Expected args: ";
1131
        extra_matcher_.DescribeTo(os);
1132
        *os << "\n           Actual: don't match";
1133

1134
        internal::PrintIfNotEmpty(listener.str(), os);
1135
1136
1137
1138
1139
1140
        *os << "\n";
      }
    } else if (!AllPrerequisitesAreSatisfied()) {
      *os << "         Expected: all pre-requisites are satisfied\n"
          << "           Actual: the following immediate pre-requisites "
          << "are not satisfied:\n";
1141
      ExpectationSet unsatisfied_prereqs;
1142
1143
      FindUnsatisfiedPrerequisites(&unsatisfied_prereqs);
      int i = 0;
1144
      for (ExpectationSet::const_iterator it = unsatisfied_prereqs.begin();
1145
           it != unsatisfied_prereqs.end(); ++it) {
1146
        it->expectation_base()->DescribeLocationTo(os);
1147
1148
1149
1150
1151
        *os << "pre-requisite #" << i++ << "\n";
      }
      *os << "                   (end of pre-requisites)\n";
    } else {
      // This line is here just for completeness' sake.  It will never
1152
      // be executed as currently the ExplainMatchResultTo() function
1153
1154
1155
1156
1157
1158
1159
      // is called only when the mock function call does NOT match the
      // expectation.
      *os << "The call matches the expectation.\n";
    }
  }

  // Returns the action that should be taken for the current invocation.
Abseil Team's avatar
Abseil Team committed
1160
1161
1162
  const Action<F>& GetCurrentAction(const FunctionMocker<F>* mocker,
                                    const ArgumentTuple& args) const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1163
1164
1165
1166
1167
1168
    g_gmock_mutex.AssertHeld();
    const int count = call_count();
    Assert(count >= 1, __FILE__, __LINE__,
           "call_count() is <= 0 when GetCurrentAction() is "
           "called - this should never happen.");

1169
    const int action_count = static_cast<int>(untyped_actions_.size());
1170
1171
1172
1173
1174
1175
    if (action_count > 0 && !repeated_action_specified_ &&
        count > action_count) {
      // If there is at least one WillOnce() and no WillRepeatedly(),
      // we warn the user when the WillOnce() clauses ran out.
      ::std::stringstream ss;
      DescribeLocationTo(&ss);
1176
      ss << "Actions ran out in " << source_text() << "...\n"
1177
1178
1179
1180
         << "Called " << count << " times, but only "
         << action_count << " WillOnce()"
         << (action_count == 1 ? " is" : "s are") << " specified - ";
      mocker->DescribeDefaultActionTo(args, &ss);
zhanyong.wan's avatar
zhanyong.wan committed
1181
      Log(kWarning, ss.str(), 1);
1182
1183
    }

1184
1185
1186
1187
    return count <= action_count
               ? *static_cast<const Action<F>*>(
                     untyped_actions_[static_cast<size_t>(count - 1)])
               : repeated_action();
1188
1189
1190
1191
1192
1193
1194
  }

  // Given the arguments of a mock function call, if the call will
  // over-saturate this expectation, returns the default action;
  // otherwise, returns the next action in this expectation.  Also
  // describes *what* happened to 'what', and explains *why* Google
  // Mock does it to 'why'.  This method is not const as it calls
1195
1196
  // IncrementCallCount().  A return value of NULL means the default
  // action.
Abseil Team's avatar
Abseil Team committed
1197
1198
1199
1200
1201
  const Action<F>* GetActionForArguments(const FunctionMocker<F>* mocker,
                                         const ArgumentTuple& args,
                                         ::std::ostream* what,
                                         ::std::ostream* why)
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1202
1203
1204
1205
1206
1207
1208
1209
    g_gmock_mutex.AssertHeld();
    if (IsSaturated()) {
      // We have an excessive call.
      IncrementCallCount();
      *what << "Mock function called more times than expected - ";
      mocker->DescribeDefaultActionTo(args, what);
      DescribeCallCountTo(why);

1210
      return nullptr;
1211
1212
1213
1214
1215
    }

    IncrementCallCount();
    RetireAllPreRequisites();

1216
    if (retires_on_saturation_ && IsSaturated()) {
1217
1218
1219
1220
      Retire();
    }

    // Must be done after IncrementCount()!
1221
    *what << "Mock function call matches " << source_text() <<"...\n";
1222
    return &(GetCurrentAction(mocker, args));
1223
1224
1225
1226
  }

  // All the fields below won't change once the EXPECT_CALL()
  // statement finishes.
Abseil Team's avatar
Abseil Team committed
1227
  FunctionMocker<F>* const owner_;
1228
1229
1230
  ArgumentMatcherTuple matchers_;
  Matcher<const ArgumentTuple&> extra_matcher_;
  Action<F> repeated_action_;
1231
1232

  GTEST_DISALLOW_COPY_AND_ASSIGN_(TypedExpectation);
1233
};  // class TypedExpectation
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244

// A MockSpec object is used by ON_CALL() or EXPECT_CALL() for
// specifying the default behavior of, or expectation on, a mock
// function.

// Note: class MockSpec really belongs to the ::testing namespace.
// However if we define it in ::testing, MSVC will complain when
// classes in ::testing::internal declare it as a friend class
// template.  To workaround this compiler bug, we define MockSpec in
// ::testing::internal and import it into ::testing.

1245
// Logs a message including file and line number information.
1246
1247
GTEST_API_ void LogWithLocation(testing::internal::LogSeverity severity,
                                const char* file, int line,
1248
                                const std::string& message);
1249

1250
1251
1252
1253
1254
1255
1256
1257
1258
template <typename F>
class MockSpec {
 public:
  typedef typename internal::Function<F>::ArgumentTuple ArgumentTuple;
  typedef typename internal::Function<F>::ArgumentMatcherTuple
      ArgumentMatcherTuple;

  // Constructs a MockSpec object, given the function mocker object
  // that the spec is associated with.
Abseil Team's avatar
Abseil Team committed
1259
  MockSpec(internal::FunctionMocker<F>* function_mocker,
Gennadiy Civil's avatar
Gennadiy Civil committed
1260
1261
           const ArgumentMatcherTuple& matchers)
      : function_mocker_(function_mocker), matchers_(matchers) {}
1262
1263
1264

  // Adds a new default action spec to the function mocker and returns
  // the newly created spec.
1265
  internal::OnCallSpec<F>& InternalDefaultActionSetAt(
1266
      const char* file, int line, const char* obj, const char* call) {
zhanyong.wan's avatar
zhanyong.wan committed
1267
    LogWithLocation(internal::kInfo, file, line,
1268
                    std::string("ON_CALL(") + obj + ", " + call + ") invoked");
1269
    return function_mocker_->AddNewOnCallSpec(file, line, matchers_);
1270
1271
1272
1273
  }

  // Adds a new expectation spec to the function mocker and returns
  // the newly created spec.
1274
  internal::TypedExpectation<F>& InternalExpectedAt(
1275
      const char* file, int line, const char* obj, const char* call) {
1276
1277
    const std::string source_text(std::string("EXPECT_CALL(") + obj + ", " +
                                  call + ")");
zhanyong.wan's avatar
zhanyong.wan committed
1278
    LogWithLocation(internal::kInfo, file, line, source_text + " invoked");
1279
1280
    return function_mocker_->AddNewExpectation(
        file, line, source_text, matchers_);
1281
1282
  }

1283
1284
1285
1286
1287
1288
1289
  // This operator overload is used to swallow the superfluous parameter list
  // introduced by the ON/EXPECT_CALL macros. See the macro comments for more
  // explanation.
  MockSpec<F>& operator()(const internal::WithoutMatchers&, void* const) {
    return *this;
  }

1290
1291
1292
1293
1294
 private:
  template <typename Function>
  friend class internal::FunctionMocker;

  // The function mocker that owns this spec.
Abseil Team's avatar
Abseil Team committed
1295
  internal::FunctionMocker<F>* const function_mocker_;
1296
1297
  // The argument matchers specified in the spec.
  ArgumentMatcherTuple matchers_;
1298
1299

  GTEST_DISALLOW_ASSIGN_(MockSpec);
1300
1301
};  // class MockSpec

1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
// Wrapper type for generically holding an ordinary value or lvalue reference.
// If T is not a reference type, it must be copyable or movable.
// ReferenceOrValueWrapper<T> is movable, and will also be copyable unless
// T is a move-only value type (which means that it will always be copyable
// if the current platform does not support move semantics).
//
// The primary template defines handling for values, but function header
// comments describe the contract for the whole template (including
// specializations).
template <typename T>
class ReferenceOrValueWrapper {
 public:
  // Constructs a wrapper from the given value/reference.
1315
  explicit ReferenceOrValueWrapper(T value)
Abseil Team's avatar
Abseil Team committed
1316
      : value_(std::move(value)) {
1317
  }
1318
1319
1320
1321

  // Unwraps and returns the underlying value/reference, exactly as
  // originally passed. The behavior of calling this more than once on
  // the same object is unspecified.
Abseil Team's avatar
Abseil Team committed
1322
  T Unwrap() { return std::move(value_); }
1323
1324
1325

  // Provides nondestructive access to the underlying value/reference.
  // Always returns a const reference (more precisely,
kuzkry's avatar
kuzkry committed
1326
1327
  // const std::add_lvalue_reference<T>::type). The behavior of calling this
  // after calling Unwrap on the same object is unspecified.
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
  const T& Peek() const {
    return value_;
  }

 private:
  T value_;
};

// Specialization for lvalue reference types. See primary template
// for documentation.
template <typename T>
class ReferenceOrValueWrapper<T&> {
 public:
  // Workaround for debatable pass-by-reference lint warning (c-library-team
  // policy precludes NOLINT in this context)
  typedef T& reference;
  explicit ReferenceOrValueWrapper(reference ref)
      : value_ptr_(&ref) {}
  T& Unwrap() { return *value_ptr_; }
  const T& Peek() const { return *value_ptr_; }

 private:
  T* value_ptr_;
};

1353
1354
1355
1356
1357
1358
// C++ treats the void type specially.  For example, you cannot define
// a void-typed variable or pass a void value to a function.
// ActionResultHolder<T> holds a value of type T, where T must be a
// copyable type or void (T doesn't need to be default-constructable).
// It hides the syntactic difference between void and other types, and
// is used to unify the code for invoking both void-returning and
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
// non-void-returning mock functions.

// Untyped base class for ActionResultHolder<T>.
class UntypedActionResultHolderBase {
 public:
  virtual ~UntypedActionResultHolderBase() {}

  // Prints the held value as an action's result to os.
  virtual void PrintAsActionResult(::std::ostream* os) const = 0;
};

// This generic definition is used when T is not void.
1371
template <typename T>
1372
class ActionResultHolder : public UntypedActionResultHolderBase {
1373
 public:
1374
1375
1376
  // Returns the held value. Must not be called more than once.
  T Unwrap() {
    return result_.Unwrap();
1377
  }
1378
1379

  // Prints the held value as an action's result to os.
Abseil Team's avatar
Abseil Team committed
1380
  void PrintAsActionResult(::std::ostream* os) const override {
1381
    *os << "\n          Returns: ";
vladlosev's avatar
vladlosev committed
1382
    // T may be a reference type, so we don't use UniversalPrint().
1383
    UniversalPrinter<T>::Print(result_.Peek(), os);
1384
1385
1386
  }

  // Performs the given mock function's default action and returns the
1387
1388
1389
  // result in a new-ed ActionResultHolder.
  template <typename F>
  static ActionResultHolder* PerformDefaultAction(
Abseil Team's avatar
Abseil Team committed
1390
      const FunctionMocker<F>* func_mocker,
Abseil Team's avatar
Abseil Team committed
1391
      typename Function<F>::ArgumentTuple&& args,
1392
      const std::string& call_description) {
Gennadiy Civil's avatar
Gennadiy Civil committed
1393
    return new ActionResultHolder(Wrapper(func_mocker->PerformDefaultAction(
Abseil Team's avatar
Abseil Team committed
1394
        std::move(args), call_description)));
1395
1396
  }

1397
  // Performs the given action and returns the result in a new-ed
1398
  // ActionResultHolder.
1399
  template <typename F>
Gennadiy Civil's avatar
Gennadiy Civil committed
1400
  static ActionResultHolder* PerformAction(
Abseil Team's avatar
Abseil Team committed
1401
      const Action<F>& action, typename Function<F>::ArgumentTuple&& args) {
Gennadiy Civil's avatar
Gennadiy Civil committed
1402
    return new ActionResultHolder(
Abseil Team's avatar
Abseil Team committed
1403
        Wrapper(action.Perform(std::move(args))));
1404
1405
1406
  }

 private:
1407
  typedef ReferenceOrValueWrapper<T> Wrapper;
1408

1409
  explicit ActionResultHolder(Wrapper result)
Abseil Team's avatar
Abseil Team committed
1410
      : result_(std::move(result)) {
1411
  }
1412
1413
1414
1415

  Wrapper result_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ActionResultHolder);
1416
1417
1418
1419
};

// Specialization for T = void.
template <>
1420
class ActionResultHolder<void> : public UntypedActionResultHolderBase {
1421
 public:
1422
  void Unwrap() { }
1423

Abseil Team's avatar
Abseil Team committed
1424
  void PrintAsActionResult(::std::ostream* /* os */) const override {}
1425

1426
1427
  // Performs the given mock function's default action and returns ownership
  // of an empty ActionResultHolder*.
1428
1429
  template <typename F>
  static ActionResultHolder* PerformDefaultAction(
Abseil Team's avatar
Abseil Team committed
1430
      const FunctionMocker<F>* func_mocker,
Abseil Team's avatar
Abseil Team committed
1431
      typename Function<F>::ArgumentTuple&& args,
1432
      const std::string& call_description) {
Abseil Team's avatar
Abseil Team committed
1433
    func_mocker->PerformDefaultAction(std::move(args), call_description);
1434
    return new ActionResultHolder;
1435
1436
  }

1437
1438
  // Performs the given action and returns ownership of an empty
  // ActionResultHolder*.
1439
1440
  template <typename F>
  static ActionResultHolder* PerformAction(
Abseil Team's avatar
Abseil Team committed
1441
1442
      const Action<F>& action, typename Function<F>::ArgumentTuple&& args) {
    action.Perform(std::move(args));
1443
    return new ActionResultHolder;
1444
  }
1445
1446
1447
1448

 private:
  ActionResultHolder() {}
  GTEST_DISALLOW_COPY_AND_ASSIGN_(ActionResultHolder);
1449
1450
};

1451
template <typename F>
Abseil Team's avatar
Abseil Team committed
1452
1453
1454
class FunctionMocker;

template <typename R, typename... Args>
Abseil Team's avatar
Abseil Team committed
1455
class FunctionMocker<R(Args...)> final : public UntypedFunctionMockerBase {
Abseil Team's avatar
Abseil Team committed
1456
1457
  using F = R(Args...);

1458
 public:
Abseil Team's avatar
Abseil Team committed
1459
1460
1461
  using Result = R;
  using ArgumentTuple = std::tuple<Args...>;
  using ArgumentMatcherTuple = std::tuple<Matcher<Args>...>;
1462

Abseil Team's avatar
Abseil Team committed
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
  FunctionMocker() {}

  // There is no generally useful and implementable semantics of
  // copying a mock object, so copying a mock is usually a user error.
  // Thus we disallow copying function mockers.  If the user really
  // wants to copy a mock object, they should implement their own copy
  // operation, for example:
  //
  //   class MockFoo : public Foo {
  //    public:
  //     // Defines a copy constructor explicitly.
  //     MockFoo(const MockFoo& src) {}
  //     ...
  //   };
  FunctionMocker(const FunctionMocker&) = delete;
  FunctionMocker& operator=(const FunctionMocker&) = delete;
1479
1480
1481
1482

  // The destructor verifies that all expectations on this mock
  // function have been satisfied.  If not, it will report Google Test
  // non-fatal failures for the violations.
Abseil Team's avatar
Abseil Team committed
1483
  ~FunctionMocker() override GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1484
1485
1486
    MutexLock l(&g_gmock_mutex);
    VerifyAndClearExpectationsLocked();
    Mock::UnregisterLocked(this);
1487
    ClearDefaultActionsLocked();
1488
1489
1490
1491
1492
  }

  // Returns the ON_CALL spec that matches this mock function with the
  // given arguments; returns NULL if no matching ON_CALL is found.
  // L = *
1493
  const OnCallSpec<F>* FindOnCallSpec(
1494
      const ArgumentTuple& args) const {
1495
1496
1497
1498
1499
1500
    for (UntypedOnCallSpecs::const_reverse_iterator it
             = untyped_on_call_specs_.rbegin();
         it != untyped_on_call_specs_.rend(); ++it) {
      const OnCallSpec<F>* spec = static_cast<const OnCallSpec<F>*>(*it);
      if (spec->Matches(args))
        return spec;
1501
1502
    }

1503
    return nullptr;
1504
1505
  }

1506
1507
1508
1509
1510
1511
  // Performs the default action of this mock function on the given
  // arguments and returns the result. Asserts (or throws if
  // exceptions are enabled) with a helpful call descrption if there
  // is no valid return value. This method doesn't depend on the
  // mutable state of this object, and thus can be called concurrently
  // without locking.
1512
  // L = *
Abseil Team's avatar
Abseil Team committed
1513
  Result PerformDefaultAction(ArgumentTuple&& args,
Abseil Team's avatar
Abseil Team committed
1514
                              const std::string& call_description) const {
1515
1516
    const OnCallSpec<F>* const spec =
        this->FindOnCallSpec(args);
1517
    if (spec != nullptr) {
Abseil Team's avatar
Abseil Team committed
1518
      return spec->GetAction().Perform(std::move(args));
1519
    }
1520
1521
    const std::string message =
        call_description +
1522
1523
1524
1525
1526
1527
1528
1529
1530
        "\n    The mock function has no default action "
        "set, and its return type has no default value set.";
#if GTEST_HAS_EXCEPTIONS
    if (!DefaultValue<Result>::Exists()) {
      throw std::runtime_error(message);
    }
#else
    Assert(DefaultValue<Result>::Exists(), "", -1, message);
#endif
1531
    return DefaultValue<Result>::Get();
1532
1533
  }

1534
1535
1536
1537
1538
  // Performs the default action with the given arguments and returns
  // the action's result.  The call description string will be used in
  // the error message to describe the call in the case the default
  // action fails.  The caller is responsible for deleting the result.
  // L = *
Abseil Team's avatar
Abseil Team committed
1539
  UntypedActionResultHolderBase* UntypedPerformDefaultAction(
Gennadiy Civil's avatar
Gennadiy Civil committed
1540
      void* untyped_args,  // must point to an ArgumentTuple
Abseil Team's avatar
Abseil Team committed
1541
      const std::string& call_description) const override {
Gennadiy Civil's avatar
Gennadiy Civil committed
1542
    ArgumentTuple* args = static_cast<ArgumentTuple*>(untyped_args);
Abseil Team's avatar
Abseil Team committed
1543
    return ResultHolder::PerformDefaultAction(this, std::move(*args),
Gennadiy Civil's avatar
Gennadiy Civil committed
1544
                                              call_description);
1545
1546
  }

1547
1548
1549
1550
  // Performs the given action with the given arguments and returns
  // the action's result.  The caller is responsible for deleting the
  // result.
  // L = *
Abseil Team's avatar
Abseil Team committed
1551
1552
  UntypedActionResultHolderBase* UntypedPerformAction(
      const void* untyped_action, void* untyped_args) const override {
1553
1554
1555
    // Make a copy of the action before performing it, in case the
    // action deletes the mock object (and thus deletes itself).
    const Action<F> action = *static_cast<const Action<F>*>(untyped_action);
Gennadiy Civil's avatar
Gennadiy Civil committed
1556
    ArgumentTuple* args = static_cast<ArgumentTuple*>(untyped_args);
Abseil Team's avatar
Abseil Team committed
1557
    return ResultHolder::PerformAction(action, std::move(*args));
1558
1559
1560
1561
  }

  // Implements UntypedFunctionMockerBase::ClearDefaultActionsLocked():
  // clears the ON_CALL()s set on this mock function.
Abseil Team's avatar
Abseil Team committed
1562
  void ClearDefaultActionsLocked() override
1563
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1564
    g_gmock_mutex.AssertHeld();
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576

    // Deleting our default actions may trigger other mock objects to be
    // deleted, for example if an action contains a reference counted smart
    // pointer to that mock object, and that is the last reference. So if we
    // delete our actions within the context of the global mutex we may deadlock
    // when this method is called again. Instead, make a copy of the set of
    // actions to delete, clear our set within the mutex, and then delete the
    // actions outside of the mutex.
    UntypedOnCallSpecs specs_to_delete;
    untyped_on_call_specs_.swap(specs_to_delete);

    g_gmock_mutex.Unlock();
1577
    for (UntypedOnCallSpecs::const_iterator it =
1578
1579
             specs_to_delete.begin();
         it != specs_to_delete.end(); ++it) {
1580
      delete static_cast<const OnCallSpec<F>*>(*it);
1581
    }
1582
1583
1584
1585

    // Lock the mutex again, since the caller expects it to be locked when we
    // return.
    g_gmock_mutex.Lock();
1586
  }
1587

1588
1589
1590
  // Returns the result of invoking this mock function with the given
  // arguments.  This function can be safely called from multiple
  // threads concurrently.
Abseil Team's avatar
Abseil Team committed
1591
1592
1593
1594
  Result Invoke(Args... args) GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
    ArgumentTuple tuple(std::forward<Args>(args)...);
    std::unique_ptr<ResultHolder> holder(DownCast_<ResultHolder*>(
        this->UntypedInvokeWith(static_cast<void*>(&tuple))));
1595
    return holder->Unwrap();
1596
  }
1597

Abseil Team's avatar
Abseil Team committed
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
  MockSpec<F> With(Matcher<Args>... m) {
    return MockSpec<F>(this, ::std::make_tuple(std::move(m)...));
  }

 protected:
  template <typename Function>
  friend class MockSpec;

  typedef ActionResultHolder<Result> ResultHolder;

1608
  // Adds and returns a default action spec for this mock function.
1609
  OnCallSpec<F>& AddNewOnCallSpec(
1610
      const char* file, int line,
1611
1612
      const ArgumentMatcherTuple& m)
          GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1613
    Mock::RegisterUseByOnCallOrExpectCall(MockObject(), file, line);
1614
1615
1616
    OnCallSpec<F>* const on_call_spec = new OnCallSpec<F>(file, line, m);
    untyped_on_call_specs_.push_back(on_call_spec);
    return *on_call_spec;
1617
1618
1619
  }

  // Adds and returns an expectation spec for this mock function.
1620
1621
1622
1623
  TypedExpectation<F>& AddNewExpectation(const char* file, int line,
                                         const std::string& source_text,
                                         const ArgumentMatcherTuple& m)
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1624
    Mock::RegisterUseByOnCallOrExpectCall(MockObject(), file, line);
1625
1626
    TypedExpectation<F>* const expectation =
        new TypedExpectation<F>(this, file, line, source_text, m);
misterg's avatar
misterg committed
1627
    const std::shared_ptr<ExpectationBase> untyped_expectation(expectation);
Gennadiy Civil's avatar
Gennadiy Civil committed
1628
1629
    // See the definition of untyped_expectations_ for why access to
    // it is unprotected here.
1630
    untyped_expectations_.push_back(untyped_expectation);
1631
1632
1633

    // Adds this expectation into the implicit sequence if there is one.
    Sequence* const implicit_sequence = g_gmock_implicit_sequence.get();
1634
    if (implicit_sequence != nullptr) {
1635
      implicit_sequence->AddExpectation(Expectation(untyped_expectation));
1636
1637
1638
1639
1640
1641
    }

    return *expectation;
  }

 private:
1642
  template <typename Func> friend class TypedExpectation;
1643

1644
  // Some utilities needed for implementing UntypedInvokeWith().
1645
1646
1647
1648
1649
1650

  // Describes what default action will be performed for the given
  // arguments.
  // L = *
  void DescribeDefaultActionTo(const ArgumentTuple& args,
                               ::std::ostream* os) const {
1651
    const OnCallSpec<F>* const spec = FindOnCallSpec(args);
1652

1653
    if (spec == nullptr) {
1654
1655
      *os << (std::is_void<Result>::value ? "returning directly.\n"
                                          : "returning default value.\n");
1656
1657
    } else {
      *os << "taking default action specified at:\n"
1658
          << FormatFileLocation(spec->file(), spec->line()) << "\n";
1659
1660
1661
1662
1663
1664
    }
  }

  // Writes a message that the call is uninteresting (i.e. neither
  // explicitly expected nor explicitly unexpected) to the given
  // ostream.
Abseil Team's avatar
Abseil Team committed
1665
1666
1667
  void UntypedDescribeUninterestingCall(const void* untyped_args,
                                        ::std::ostream* os) const override
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1668
1669
    const ArgumentTuple& args =
        *static_cast<const ArgumentTuple*>(untyped_args);
1670
1671
1672
    *os << "Uninteresting mock function call - ";
    DescribeDefaultActionTo(args, os);
    *os << "    Function call: " << Name();
vladlosev's avatar
vladlosev committed
1673
    UniversalPrint(args, os);
1674
1675
  }

1676
1677
1678
1679
1680
1681
1682
  // Returns the expectation that matches the given function arguments
  // (or NULL is there's no match); when a match is found,
  // untyped_action is set to point to the action that should be
  // performed (or NULL if the action is "do default"), and
  // is_excessive is modified to indicate whether the call exceeds the
  // expected number.
  //
1683
1684
1685
1686
1687
1688
1689
1690
1691
  // Critical section: We must find the matching expectation and the
  // corresponding action that needs to be taken in an ATOMIC
  // transaction.  Otherwise another thread may call this mock
  // method in the middle and mess up the state.
  //
  // However, performing the action has to be left out of the critical
  // section.  The reason is that we have no control on what the
  // action does (it can invoke an arbitrary user function or even a
  // mock function) and excessive locking could cause a dead lock.
Abseil Team's avatar
Abseil Team committed
1692
1693
1694
1695
  const ExpectationBase* UntypedFindMatchingExpectation(
      const void* untyped_args, const void** untyped_action, bool* is_excessive,
      ::std::ostream* what, ::std::ostream* why) override
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1696
1697
    const ArgumentTuple& args =
        *static_cast<const ArgumentTuple*>(untyped_args);
1698
    MutexLock l(&g_gmock_mutex);
1699
    TypedExpectation<F>* exp = this->FindMatchingExpectationLocked(args);
1700
    if (exp == nullptr) {  // A match wasn't found.
1701
      this->FormatUnexpectedCallMessageLocked(args, what, why);
1702
      return nullptr;
1703
1704
1705
1706
1707
    }

    // This line must be done before calling GetActionForArguments(),
    // which will increment the call count for *exp and thus affect
    // its saturation status.
1708
1709
    *is_excessive = exp->IsSaturated();
    const Action<F>* action = exp->GetActionForArguments(this, args, what, why);
1710
1711
    if (action != nullptr && action->IsDoDefault())
      action = nullptr;  // Normalize "do default" to NULL.
1712
1713
1714
1715
1716
    *untyped_action = action;
    return exp;
  }

  // Prints the given function arguments to the ostream.
Abseil Team's avatar
Abseil Team committed
1717
1718
  void UntypedPrintArgs(const void* untyped_args,
                        ::std::ostream* os) const override {
1719
1720
1721
    const ArgumentTuple& args =
        *static_cast<const ArgumentTuple*>(untyped_args);
    UniversalPrint(args, os);
1722
1723
1724
1725
  }

  // Returns the expectation that matches the arguments, or NULL if no
  // expectation matches them.
1726
  TypedExpectation<F>* FindMatchingExpectationLocked(
1727
1728
      const ArgumentTuple& args) const
          GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1729
    g_gmock_mutex.AssertHeld();
Gennadiy Civil's avatar
Gennadiy Civil committed
1730
1731
    // See the definition of untyped_expectations_ for why access to
    // it is unprotected here.
1732
1733
1734
1735
1736
    for (typename UntypedExpectations::const_reverse_iterator it =
             untyped_expectations_.rbegin();
         it != untyped_expectations_.rend(); ++it) {
      TypedExpectation<F>* const exp =
          static_cast<TypedExpectation<F>*>(it->get());
1737
1738
1739
1740
      if (exp->ShouldHandleArguments(args)) {
        return exp;
      }
    }
1741
    return nullptr;
1742
1743
1744
  }

  // Returns a message that the arguments don't match any expectation.
1745
1746
1747
1748
1749
  void FormatUnexpectedCallMessageLocked(
      const ArgumentTuple& args,
      ::std::ostream* os,
      ::std::ostream* why) const
          GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1750
1751
1752
1753
1754
1755
1756
1757
    g_gmock_mutex.AssertHeld();
    *os << "\nUnexpected mock function call - ";
    DescribeDefaultActionTo(args, os);
    PrintTriedExpectationsLocked(args, why);
  }

  // Prints a list of expectations that have been tried against the
  // current mock function call.
1758
1759
1760
1761
  void PrintTriedExpectationsLocked(
      const ArgumentTuple& args,
      ::std::ostream* why) const
          GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1762
    g_gmock_mutex.AssertHeld();
1763
    const size_t count = untyped_expectations_.size();
1764
1765
1766
1767
    *why << "Google Mock tried the following " << count << " "
         << (count == 1 ? "expectation, but it didn't match" :
             "expectations, but none matched")
         << ":\n";
1768
    for (size_t i = 0; i < count; i++) {
1769
1770
      TypedExpectation<F>* const expectation =
          static_cast<TypedExpectation<F>*>(untyped_expectations_[i].get());
1771
      *why << "\n";
1772
      expectation->DescribeLocationTo(why);
1773
      if (count > 1) {
1774
        *why << "tried expectation #" << i << ": ";
1775
      }
1776
1777
1778
      *why << expectation->source_text() << "...\n";
      expectation->ExplainMatchResultTo(args, why);
      expectation->DescribeCallCountTo(why);
1779
1780
    }
  }
Abseil Team's avatar
Abseil Team committed
1781
};  // class FunctionMocker
1782
1783
1784

// Reports an uninteresting call (whose description is in msg) in the
// manner specified by 'reaction'.
1785
void ReportUninterestingCall(CallReaction reaction, const std::string& msg);
1786
1787
1788

}  // namespace internal

1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
namespace internal {

template <typename F>
class MockFunction;

template <typename R, typename... Args>
class MockFunction<R(Args...)> {
 public:
  MockFunction(const MockFunction&) = delete;
  MockFunction& operator=(const MockFunction&) = delete;

  std::function<R(Args...)> AsStdFunction() {
    return [this](Args... args) -> R {
      return this->Call(std::forward<Args>(args)...);
    };
  }

  // Implementation detail: the expansion of the MOCK_METHOD macro.
  R Call(Args... args) {
    mock_.SetOwnerAndName(this, "Call");
    return mock_.Invoke(std::forward<Args>(args)...);
  }

  MockSpec<R(Args...)> gmock_Call(Matcher<Args>... m) {
    mock_.RegisterOwner(this);
    return mock_.With(std::move(m)...);
  }

1817
  MockSpec<R(Args...)> gmock_Call(const WithoutMatchers&, R (*)(Args...)) {
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
    return this->gmock_Call(::testing::A<Args>()...);
  }

 protected:
  MockFunction() = default;
  ~MockFunction() = default;

 private:
  FunctionMocker<R(Args...)> mock_;
};

/*
The SignatureOf<F> struct is a meta-function returning function signature
corresponding to the provided F argument.

It makes use of MockFunction easier by allowing it to accept more F arguments
than just function signatures.

Specializations provided here cover only a signature type itself and
std::function. However, if need be it can be easily extended to cover also other
types (like for example boost::function).
*/

template <typename F>
struct SignatureOf;

template <typename R, typename... Args>
struct SignatureOf<R(Args...)> {
  using type = R(Args...);
};

template <typename F>
struct SignatureOf<std::function<F>> : SignatureOf<F> {};

template <typename F>
using SignatureOfT = typename SignatureOf<F>::type;

}  // namespace internal

// A MockFunction<F> type has one mock method whose type is
// internal::SignatureOfT<F>.  It is useful when you just want your
// test code to emit some messages and have Google Mock verify the
// right messages are sent (and perhaps at the right times).  For
// example, if you are exercising code:
Abseil Team's avatar
Abseil Team committed
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
//
//   Foo(1);
//   Foo(2);
//   Foo(3);
//
// and want to verify that Foo(1) and Foo(3) both invoke
// mock.Bar("a"), but Foo(2) doesn't invoke anything, you can write:
//
// TEST(FooTest, InvokesBarCorrectly) {
//   MyMock mock;
//   MockFunction<void(string check_point_name)> check;
//   {
//     InSequence s;
//
//     EXPECT_CALL(mock, Bar("a"));
//     EXPECT_CALL(check, Call("1"));
//     EXPECT_CALL(check, Call("2"));
//     EXPECT_CALL(mock, Bar("a"));
//   }
//   Foo(1);
//   check.Call("1");
//   Foo(2);
//   check.Call("2");
//   Foo(3);
// }
//
// The expectation spec says that the first Bar("a") must happen
// before check point "1", the second Bar("a") must happen after check
// point "2", and nothing should happen between the two check
// points. The explicit check points make it easy to tell which
// Bar("a") is called by which call to Foo().
//
// MockFunction<F> can also be used to exercise code that accepts
1895
1896
1897
// std::function<internal::SignatureOfT<F>> callbacks. To do so, use
// AsStdFunction() method to create std::function proxy forwarding to
// original object's Call. Example:
Abseil Team's avatar
Abseil Team committed
1898
1899
1900
1901
1902
1903
//
// TEST(FooTest, RunsCallbackWithBarArgument) {
//   MockFunction<int(string)> callback;
//   EXPECT_CALL(callback, Call("bar")).WillOnce(Return(1));
//   Foo(callback.AsStdFunction());
// }
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
//
// The internal::SignatureOfT<F> indirection allows to use other types
// than just function signature type. This is typically useful when
// providing a mock for a predefined std::function type. Example:
//
// using FilterPredicate = std::function<bool(string)>;
// void MyFilterAlgorithm(FilterPredicate predicate);
//
// TEST(FooTest, FilterPredicateAlwaysAccepts) {
//   MockFunction<FilterPredicate> predicateMock;
//   EXPECT_CALL(predicateMock, Call(_)).WillRepeatedly(Return(true));
//   MyFilterAlgorithm(predicateMock.AsStdFunction());
// }
Abseil Team's avatar
Abseil Team committed
1917
template <typename F>
1918
1919
class MockFunction : public internal::MockFunction<internal::SignatureOfT<F>> {
  using Base = internal::MockFunction<internal::SignatureOfT<F>>;
Abseil Team's avatar
Abseil Team committed
1920
1921

 public:
1922
  using Base::Base;
Abseil Team's avatar
Abseil Team committed
1923
1924
};

1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
// The style guide prohibits "using" statements in a namespace scope
// inside a header file.  However, the MockSpec class template is
// meant to be defined in the ::testing namespace.  The following line
// is just a trick for working around a bug in MSVC 8.0, which cannot
// handle it if we define MockSpec in ::testing.
using internal::MockSpec;

// Const(x) is a convenient function for obtaining a const reference
// to x.  This is useful for setting expectations on an overloaded
// const mock method, e.g.
//
//   class MockFoo : public FooInterface {
//    public:
//     MOCK_METHOD0(Bar, int());
//     MOCK_CONST_METHOD0(Bar, int&());
//   };
//
//   MockFoo foo;
//   // Expects a call to non-const MockFoo::Bar().
//   EXPECT_CALL(foo, Bar());
//   // Expects a call to const MockFoo::Bar().
//   EXPECT_CALL(Const(foo), Bar());
template <typename T>
inline const T& Const(const T& x) { return x; }

1950
1951
1952
1953
// Constructs an Expectation object that references and co-owns exp.
inline Expectation::Expectation(internal::ExpectationBase& exp)  // NOLINT
    : expectation_base_(exp.GetHandle().expectation_base()) {}

1954
1955
}  // namespace testing

misterg's avatar
misterg committed
1956
1957
GTEST_DISABLE_MSC_WARNINGS_POP_()  //  4251

1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
// Implementation for ON_CALL and EXPECT_CALL macros. A separate macro is
// required to avoid compile errors when the name of the method used in call is
// a result of macro expansion. See CompilesWithMethodNameExpandedFromMacro
// tests in internal/gmock-spec-builders_test.cc for more details.
//
// This macro supports statements both with and without parameter matchers. If
// the parameter list is omitted, gMock will accept any parameters, which allows
// tests to be written that don't need to encode the number of method
// parameter. This technique may only be used for non-overloaded methods.
//
//   // These are the same:
1969
1970
//   ON_CALL(mock, NoArgsMethod()).WillByDefault(...);
//   ON_CALL(mock, NoArgsMethod).WillByDefault(...);
1971
1972
//
//   // As are these:
1973
1974
//   ON_CALL(mock, TwoArgsMethod(_, _)).WillByDefault(...);
//   ON_CALL(mock, TwoArgsMethod).WillByDefault(...);
1975
1976
//
//   // Can also specify args if you want, of course:
1977
//   ON_CALL(mock, TwoArgsMethod(_, 45)).WillByDefault(...);
1978
1979
//
//   // Overloads work as long as you specify parameters:
1980
1981
//   ON_CALL(mock, OverloadedMethod(_)).WillByDefault(...);
//   ON_CALL(mock, OverloadedMethod(_, _)).WillByDefault(...);
1982
1983
//
//   // Oops! Which overload did you want?
1984
//   ON_CALL(mock, OverloadedMethod).WillByDefault(...);
1985
1986
1987
1988
1989
1990
1991
//     => ERROR: call to member function 'gmock_OverloadedMethod' is ambiguous
//
// How this works: The mock class uses two overloads of the gmock_Method
// expectation setter method plus an operator() overload on the MockSpec object.
// In the matcher list form, the macro expands to:
//
//   // This statement:
1992
//   ON_CALL(mock, TwoArgsMethod(_, 45))...
1993
//
1994
1995
//   // ...expands to:
//   mock.gmock_TwoArgsMethod(_, 45)(WithoutMatchers(), nullptr)...
1996
1997
1998
//   |-------------v---------------||------------v-------------|
//       invokes first overload        swallowed by operator()
//
1999
2000
//   // ...which is essentially:
//   mock.gmock_TwoArgsMethod(_, 45)...
2001
2002
2003
2004
//
// Whereas the form without a matcher list:
//
//   // This statement:
2005
//   ON_CALL(mock, TwoArgsMethod)...
2006
//
2007
2008
//   // ...expands to:
//   mock.gmock_TwoArgsMethod(WithoutMatchers(), nullptr)...
2009
2010
2011
//   |-----------------------v--------------------------|
//                 invokes second overload
//
2012
2013
//   // ...which is essentially:
//   mock.gmock_TwoArgsMethod(_, _)...
2014
2015
2016
2017
2018
2019
//
// The WithoutMatchers() argument is used to disambiguate overloads and to
// block the caller from accidentally invoking the second overload directly. The
// second argument is an internal type derived from the method signature. The
// failure to disambiguate two overloads of this method in the ON_CALL statement
// is how we block callers from setting expectations on overloaded methods.
2020
2021
2022
#define GMOCK_ON_CALL_IMPL_(mock_expr, Setter, call)                    \
  ((mock_expr).gmock_##call)(::testing::internal::GetWithoutMatchers(), \
                             nullptr)                                   \
2023
2024
2025
2026
2027
2028
2029
      .Setter(__FILE__, __LINE__, #mock_expr, #call)

#define ON_CALL(obj, call) \
  GMOCK_ON_CALL_IMPL_(obj, InternalDefaultActionSetAt, call)

#define EXPECT_CALL(obj, call) \
  GMOCK_ON_CALL_IMPL_(obj, InternalExpectedAt, call)
2030
2031

#endif  // GMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_