gmock-spec-builders.h 72.7 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
64
#ifndef GMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_
#define GMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_

#include <map>
misterg's avatar
misterg committed
65
#include <memory>
66
67
68
#include <set>
#include <sstream>
#include <string>
Abseil Team's avatar
Abseil Team committed
69
#include <utility>
70
#include <vector>
71
72
73
74
75
76
#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"
77

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

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

85
86
namespace testing {

87
88
89
90
91
92
// An abstract handle of an expectation.
class Expectation;

// A set of expectation handles.
class ExpectationSet;

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

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

// Base class for expectations.
class ExpectationBase;

103
104
105
// Implements an expectation.
template <typename F> class TypedExpectation;

106
107
108
109
110
111
112
113
114
115
116
117
118
119
// 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.
120
GTEST_API_ GTEST_DECLARE_STATIC_MUTEX_(g_gmock_mutex);
121

122
123
124
// Untyped base class for ActionResultHolder<R>.
class UntypedActionResultHolderBase;

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

  // 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.
136
137
  bool VerifyAndClearExpectationsLocked()
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
138
139

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

  // 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
153
      void* untyped_args, const std::string& call_description) const = 0;
154
155
156
157
158

  // 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
159
      const void* untyped_action, void* untyped_args) const = 0;
160
161
162
163

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

  // 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,
178
179
      ::std::ostream* what, ::std::ostream* why)
          GTEST_LOCK_EXCLUDED_(g_gmock_mutex) = 0;
180
181
182
183
184
185
186
187
188

  // 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.
189
190
  void RegisterOwner(const void* mock_obj)
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
191
192
193
194

  // 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.
195
196
  void SetOwnerAndName(const void* mock_obj, const char* name)
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
197
198
199
200

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

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

  // 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
213
214
  UntypedActionResultHolderBase* UntypedInvokeWith(void* untyped_args)
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
215
216
217
218

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

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

  // 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
238
239
240
241
242
243
244
245
  //
  // 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.
246
  UntypedExpectations untyped_expectations_;
247
248
};  // class UntypedFunctionMockerBase

249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
// 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,
267
    kWillByDefault
268
269
270
  };

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

  // Expects that the ON_CALL() statement has a certain property.
277
278
  void ExpectSpecProperty(bool property,
                          const std::string& failure_message) const {
279
280
281
282
283
284
285
286
287
288
289
290
    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.
291
template <typename F>
292
class OnCallSpec : public UntypedOnCallSpecBase {
293
294
295
296
 public:
  typedef typename Function<F>::ArgumentTuple ArgumentTuple;
  typedef typename Function<F>::ArgumentMatcherTuple ArgumentMatcherTuple;

297
  // Constructs an OnCallSpec object from the information inside
298
  // the parenthesis of an ON_CALL() statement.
299
300
301
  OnCallSpec(const char* a_file, int a_line,
             const ArgumentMatcherTuple& matchers)
      : UntypedOnCallSpecBase(a_file, a_line),
302
        matchers_(matchers),
Abseil Team's avatar
Abseil Team committed
303
304
305
306
        // 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&>()) {}
307

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

    extra_matcher_ = m;
    return *this;
  }

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

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

  // Returns true iff the given arguments match the matchers.
  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 {
340
    AssertSpecProperty(last_clause_ == kWillByDefault,
341
342
343
344
                       ".WillByDefault() must appear exactly "
                       "once in an ON_CALL().");
    return action_;
  }
345

346
347
348
349
 private:
  // The information in statement
  //
  //   ON_CALL(mock_object, Method(matchers))
350
  //       .With(multi-argument-matcher)
351
352
353
354
355
356
357
358
359
360
361
362
  //       .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_;
363
};  // class OnCallSpec
364

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

}  // namespace internal

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

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

384
385
386
  // 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.
387
388
  static bool VerifyAndClearExpectations(void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
389
390
391
392

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

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

406
 private:
407
408
  friend class internal::UntypedFunctionMockerBase;

409
410
411
  // 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
412
  friend class internal::FunctionMocker;
413
414

  template <typename M>
415
  friend class NiceMock;
416

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

420
  template <typename M>
421
  friend class StrictMock;
422
423
424

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

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

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

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

  // 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
446
      const void* mock_obj)
447
          GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
448
449
450
451

  // 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.
452
453
  static bool VerifyAndClearExpectationsLocked(void* mock_obj)
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex);
454
455

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

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

465
466
467
468
  // 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(
469
470
      const void* mock_obj, const char* file, int line)
          GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
471

472
473
474
  // 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
475
  // FunctionMocker.
476
477
  static void UnregisterLocked(internal::UntypedFunctionMockerBase* mocker)
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex);
478
479
};  // class Mock

480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
// 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
495

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

  ~Expectation();
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527

  // 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.

  // Returns true iff rhs references the same expectation as this object does.
  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;
528
  friend class ::testing::internal::UntypedFunctionMockerBase;
529
530

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

  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
547
      const std::shared_ptr<internal::ExpectationBase>& expectation_base);
548
549

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

misterg's avatar
misterg committed
554
555
  // A shared_ptr that co-owns the expectation this handle references.
  std::shared_ptr<internal::ExpectationBase> expectation_base_;
556
557
558
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
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
};

// 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.

  // Returns true iff rhs contains the same set of Expectation objects
  // as this does.
  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_;
};


624
625
626
// 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).
627
class GTEST_API_ Sequence {
628
629
 public:
  // Constructs an empty sequence.
630
  Sequence() : last_expectation_(new Expectation) {}
631
632
633

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

636
 private:
misterg's avatar
misterg committed
637
638
  // The last expectation in this sequence.
  std::shared_ptr<Expectation> last_expectation_;
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
};  // 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.
665
class GTEST_API_ InSequence {
666
667
668
669
670
671
672
 public:
  InSequence();
  ~InSequence();
 private:
  bool sequence_created_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(InSequence);  // NOLINT
673
} GTEST_ATTRIBUTE_UNUSED_;
674
675
676
677
678

namespace internal {

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

// 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.
695
class GTEST_API_ ExpectationBase {
696
 public:
697
  // source_text is the EXPECT_CALL(...) source that created this Expectation.
698
  ExpectationBase(const char* file, int line, const std::string& source_text);
699
700
701
702
703
704

  virtual ~ExpectationBase();

  // Where in the source file was the expectation spec defined?
  const char* file() const { return file_; }
  int line() const { return line_; }
705
  const char* source_text() const { return source_text_.c_str(); }
706
707
708
709
710
  // 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 {
711
    *os << FormatFileLocation(file(), line()) << " ";
712
713
714
715
  }

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

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

723
 protected:
724
  friend class ::testing::Expectation;
725
  friend class UntypedFunctionMockerBase;
726
727
728

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

739
740
  typedef std::vector<const void*> UntypedActions;

741
742
743
744
  // Returns an Expectation object that references and co-owns this
  // expectation.
  virtual Expectation GetHandle() = 0;

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

  // Expects that the EXPECT_CALL() statement has the given property.
752
753
  void ExpectSpecProperty(bool property,
                          const std::string& failure_message) const {
754
755
756
757
758
759
760
761
762
763
764
765
    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);

  // Returns true iff the user specified the cardinality explicitly
  // using a .Times().
  bool cardinality_specified() const { return cardinality_specified_; }

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

  // 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.
775
776
  void RetireAllPreRequisites()
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
777
778

  // Returns true iff this expectation is retired.
779
780
  bool is_retired() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
781
782
783
784
785
    g_gmock_mutex.AssertHeld();
    return retired_;
  }

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

  // Returns true iff this expectation is satisfied.
793
794
  bool IsSatisfied() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
795
796
797
798
799
    g_gmock_mutex.AssertHeld();
    return cardinality().IsSatisfiedByCallCount(call_count_);
  }

  // Returns true iff this expectation is saturated.
800
801
  bool IsSaturated() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
802
803
804
805
806
    g_gmock_mutex.AssertHeld();
    return cardinality().IsSaturatedByCallCount(call_count_);
  }

  // Returns true iff this expectation is over-saturated.
807
808
  bool IsOverSaturated() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
809
810
811
812
813
    g_gmock_mutex.AssertHeld();
    return cardinality().IsOverSaturatedByCallCount(call_count_);
  }

  // Returns true iff all pre-requisites of this expectation are satisfied.
814
815
  bool AllPrerequisitesAreSatisfied() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
816
817

  // Adds unsatisfied pre-requisites of this expectation to 'result'.
818
819
  void FindUnsatisfiedPrerequisites(ExpectationSet* result) const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
820
821

  // Returns the number this expectation has been invoked.
822
823
  int call_count() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
824
825
826
827
828
    g_gmock_mutex.AssertHeld();
    return call_count_;
  }

  // Increments the number this expectation has been invoked.
829
830
  void IncrementCallCount()
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
831
832
833
834
    g_gmock_mutex.AssertHeld();
    call_count_++;
  }

835
836
837
838
  // 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.
839
840
  void CheckActionCountIfNotDone() const
      GTEST_LOCK_EXCLUDED_(mutex_);
841

842
843
844
845
  friend class ::testing::Sequence;
  friend class ::testing::internal::ExpectationTester;

  template <typename Function>
846
  friend class TypedExpectation;
847

848
849
850
  // Implements the .Times() clause.
  void UntypedTimes(const Cardinality& a_cardinality);

851
852
  // This group of fields are part of the spec and won't change after
  // an EXPECT_CALL() statement finishes.
853
854
  const char* file_;          // The file that contains the expectation.
  int line_;                  // The line number of the expectation.
855
  const std::string source_text_;  // The EXPECT_CALL(...) source text.
856
857
858
  // True iff the cardinality is specified explicitly.
  bool cardinality_specified_;
  Cardinality cardinality_;            // The cardinality of the expectation.
859
860
  // The immediate pre-requisites (i.e. expectations that must be
  // satisfied before this expectation can be matched) of this
misterg's avatar
misterg committed
861
  // expectation.  We use std::shared_ptr in the set because we want an
862
863
864
865
  // 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_;
866
867
868
869
870

  // 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.
  bool retired_;    // True iff this expectation has retired.
871
872
873
874
875
876
877
  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_.
878
879

  GTEST_DISALLOW_ASSIGN_(ExpectationBase);
880
881
882
883
};  // class ExpectationBase

// Impements an expectation for the given function type.
template <typename F>
884
class TypedExpectation : public ExpectationBase {
885
886
887
888
889
 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
890
  TypedExpectation(FunctionMocker<F>* owner, const char* a_file, int a_line,
891
                   const std::string& a_source_text,
892
                   const ArgumentMatcherTuple& m)
893
      : ExpectationBase(a_file, a_line, a_source_text),
894
895
        owner_(owner),
        matchers_(m),
Abseil Team's avatar
Abseil Team committed
896
897
898
899
        // 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&>()),
900
        repeated_action_(DoDefault()) {}
901

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

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

    extra_matcher_ = m;
926
    extra_matcher_specified_ = true;
927
928
929
930
    return *this;
  }

  // Implements the .Times() clause.
931
  TypedExpectation& Times(const Cardinality& a_cardinality) {
932
    ExpectationBase::UntypedTimes(a_cardinality);
933
934
935
936
    return *this;
  }

  // Implements the .Times() clause.
937
  TypedExpectation& Times(int n) {
938
939
940
941
    return Times(Exactly(n));
  }

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

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

969
970
971
972
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
  // 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);
  }

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

1006
    untyped_actions_.push_back(new Action<F>(action));
1007
    if (!cardinality_specified()) {
1008
      set_cardinality(Exactly(static_cast<int>(untyped_actions_.size())));
1009
1010
1011
1012
1013
    }
    return *this;
  }

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

    repeated_action_ = action;
    if (!cardinality_specified()) {
1029
      set_cardinality(AtLeast(static_cast<int>(untyped_actions_.size())));
1030
1031
1032
1033
1034
1035
1036
1037
1038
    }

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

  // Implements the .RetiresOnSaturation() clause.
1039
  TypedExpectation& RetiresOnSaturation() {
1040
    ExpectSpecProperty(last_clause_ < kRetiresOnSaturation,
1041
1042
                       ".RetiresOnSaturation() cannot appear "
                       "more than once.");
1043
    last_clause_ = kRetiresOnSaturation;
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
    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_;
  }

1058
  // Returns the matcher specified by the .With() clause.
1059
1060
1061
1062
1063
1064
1065
  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_; }

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

1076
1077
 private:
  template <typename Function>
Abseil Team's avatar
Abseil Team committed
1078
  friend class FunctionMocker;
1079

1080
1081
  // Returns an Expectation object that references and co-owns this
  // expectation.
Abseil Team's avatar
Abseil Team committed
1082
  Expectation GetHandle() override { return owner_->GetHandleOf(this); }
1083

1084
1085
1086
1087
1088
  // The following methods will be called only after the EXPECT_CALL()
  // statement finishes and when the current thread holds
  // g_gmock_mutex.

  // Returns true iff this expectation matches the given arguments.
1089
1090
  bool Matches(const ArgumentTuple& args) const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1091
1092
1093
1094
1095
    g_gmock_mutex.AssertHeld();
    return TupleMatches(matchers_, args) && extra_matcher_.Matches(args);
  }

  // Returns true iff this expectation should handle the given arguments.
1096
1097
  bool ShouldHandleArguments(const ArgumentTuple& args) const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
    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.
1110
1111
1112
1113
  void ExplainMatchResultTo(
      const ArgumentTuple& args,
      ::std::ostream* os) const
          GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1114
1115
1116
1117
1118
1119
1120
    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)) {
1121
        ExplainMatchFailureTupleTo(matchers_, args, os);
1122
      }
zhanyong.wan's avatar
zhanyong.wan committed
1123
1124
      StringMatchResultListener listener;
      if (!extra_matcher_.MatchAndExplain(args, &listener)) {
1125
        *os << "    Expected args: ";
1126
        extra_matcher_.DescribeTo(os);
1127
        *os << "\n           Actual: don't match";
1128

1129
        internal::PrintIfNotEmpty(listener.str(), os);
1130
1131
1132
1133
1134
1135
        *os << "\n";
      }
    } else if (!AllPrerequisitesAreSatisfied()) {
      *os << "         Expected: all pre-requisites are satisfied\n"
          << "           Actual: the following immediate pre-requisites "
          << "are not satisfied:\n";
1136
      ExpectationSet unsatisfied_prereqs;
1137
1138
      FindUnsatisfiedPrerequisites(&unsatisfied_prereqs);
      int i = 0;
1139
      for (ExpectationSet::const_iterator it = unsatisfied_prereqs.begin();
1140
           it != unsatisfied_prereqs.end(); ++it) {
1141
        it->expectation_base()->DescribeLocationTo(os);
1142
1143
1144
1145
1146
        *os << "pre-requisite #" << i++ << "\n";
      }
      *os << "                   (end of pre-requisites)\n";
    } else {
      // This line is here just for completeness' sake.  It will never
1147
      // be executed as currently the ExplainMatchResultTo() function
1148
1149
1150
1151
1152
1153
1154
      // 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
1155
1156
1157
  const Action<F>& GetCurrentAction(const FunctionMocker<F>* mocker,
                                    const ArgumentTuple& args) const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1158
1159
1160
1161
1162
1163
    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.");

1164
    const int action_count = static_cast<int>(untyped_actions_.size());
1165
1166
1167
1168
1169
1170
    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);
1171
      ss << "Actions ran out in " << source_text() << "...\n"
1172
1173
1174
1175
         << "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
1176
      Log(kWarning, ss.str(), 1);
1177
1178
    }

1179
1180
1181
1182
    return count <= action_count
               ? *static_cast<const Action<F>*>(
                     untyped_actions_[static_cast<size_t>(count - 1)])
               : repeated_action();
1183
1184
1185
1186
1187
1188
1189
  }

  // 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
1190
1191
  // IncrementCallCount().  A return value of NULL means the default
  // action.
Abseil Team's avatar
Abseil Team committed
1192
1193
1194
1195
1196
  const Action<F>* GetActionForArguments(const FunctionMocker<F>* mocker,
                                         const ArgumentTuple& args,
                                         ::std::ostream* what,
                                         ::std::ostream* why)
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1197
1198
1199
1200
1201
1202
1203
1204
    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);

1205
      return nullptr;
1206
1207
1208
1209
1210
    }

    IncrementCallCount();
    RetireAllPreRequisites();

1211
    if (retires_on_saturation_ && IsSaturated()) {
1212
1213
1214
1215
      Retire();
    }

    // Must be done after IncrementCount()!
1216
    *what << "Mock function call matches " << source_text() <<"...\n";
1217
    return &(GetCurrentAction(mocker, args));
1218
1219
1220
1221
  }

  // All the fields below won't change once the EXPECT_CALL()
  // statement finishes.
Abseil Team's avatar
Abseil Team committed
1222
  FunctionMocker<F>* const owner_;
1223
1224
1225
  ArgumentMatcherTuple matchers_;
  Matcher<const ArgumentTuple&> extra_matcher_;
  Action<F> repeated_action_;
1226
1227

  GTEST_DISALLOW_COPY_AND_ASSIGN_(TypedExpectation);
1228
};  // class TypedExpectation
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239

// 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.

1240
// Logs a message including file and line number information.
1241
1242
GTEST_API_ void LogWithLocation(testing::internal::LogSeverity severity,
                                const char* file, int line,
1243
                                const std::string& message);
1244

1245
1246
1247
1248
1249
1250
1251
1252
1253
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
1254
  MockSpec(internal::FunctionMocker<F>* function_mocker,
Gennadiy Civil's avatar
Gennadiy Civil committed
1255
1256
           const ArgumentMatcherTuple& matchers)
      : function_mocker_(function_mocker), matchers_(matchers) {}
1257
1258
1259

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

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

1278
1279
1280
1281
1282
1283
1284
  // 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;
  }

1285
1286
1287
1288
1289
 private:
  template <typename Function>
  friend class internal::FunctionMocker;

  // The function mocker that owns this spec.
Abseil Team's avatar
Abseil Team committed
1290
  internal::FunctionMocker<F>* const function_mocker_;
1291
1292
  // The argument matchers specified in the spec.
  ArgumentMatcherTuple matchers_;
1293
1294

  GTEST_DISALLOW_ASSIGN_(MockSpec);
1295
1296
};  // class MockSpec

1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
// 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.
1310
  explicit ReferenceOrValueWrapper(T value)
Abseil Team's avatar
Abseil Team committed
1311
      : value_(std::move(value)) {
1312
  }
1313
1314
1315
1316

  // 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
1317
  T Unwrap() { return std::move(value_); }
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347

  // Provides nondestructive access to the underlying value/reference.
  // Always returns a const reference (more precisely,
  // const RemoveReference<T>&). The behavior of calling this after
  // calling Unwrap on the same object is unspecified.
  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_;
};

1348
1349
1350
1351
// MSVC warns about using 'this' in base member initializer list, so
// we need to temporarily disable the warning.  We have to do it for
// the entire class to suppress the warning, even though it's about
// the constructor only.
misterg's avatar
misterg committed
1352
GTEST_DISABLE_MSC_WARNINGS_PUSH_(4355)
1353

1354
1355
1356
1357
1358
1359
// 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
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
// 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.
1372
template <typename T>
1373
class ActionResultHolder : public UntypedActionResultHolderBase {
1374
 public:
1375
1376
1377
  // Returns the held value. Must not be called more than once.
  T Unwrap() {
    return result_.Unwrap();
1378
  }
1379
1380

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

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

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

 private:
1408
  typedef ReferenceOrValueWrapper<T> Wrapper;
1409

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

  Wrapper result_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ActionResultHolder);
1417
1418
1419
1420
};

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

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

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

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

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

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

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

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

Abseil Team's avatar
Abseil Team committed
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
  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;
1480
1481
1482
1483

  // 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
1484
  ~FunctionMocker() override GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1485
1486
1487
    MutexLock l(&g_gmock_mutex);
    VerifyAndClearExpectationsLocked();
    Mock::UnregisterLocked(this);
1488
    ClearDefaultActionsLocked();
1489
1490
1491
1492
1493
  }

  // Returns the ON_CALL spec that matches this mock function with the
  // given arguments; returns NULL if no matching ON_CALL is found.
  // L = *
1494
  const OnCallSpec<F>* FindOnCallSpec(
1495
      const ArgumentTuple& args) const {
1496
1497
1498
1499
1500
1501
    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;
1502
1503
    }

1504
    return nullptr;
1505
1506
  }

1507
1508
1509
1510
1511
1512
  // 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.
1513
  // L = *
Abseil Team's avatar
Abseil Team committed
1514
  Result PerformDefaultAction(ArgumentTuple&& args,
Abseil Team's avatar
Abseil Team committed
1515
                              const std::string& call_description) const {
1516
1517
    const OnCallSpec<F>* const spec =
        this->FindOnCallSpec(args);
1518
    if (spec != nullptr) {
Abseil Team's avatar
Abseil Team committed
1519
      return spec->GetAction().Perform(std::move(args));
1520
    }
1521
1522
    const std::string message =
        call_description +
1523
1524
1525
1526
1527
1528
1529
1530
1531
        "\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
1532
    return DefaultValue<Result>::Get();
1533
1534
  }

1535
1536
1537
1538
1539
  // 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
1540
  UntypedActionResultHolderBase* UntypedPerformDefaultAction(
Gennadiy Civil's avatar
Gennadiy Civil committed
1541
      void* untyped_args,  // must point to an ArgumentTuple
Abseil Team's avatar
Abseil Team committed
1542
      const std::string& call_description) const override {
Gennadiy Civil's avatar
Gennadiy Civil committed
1543
    ArgumentTuple* args = static_cast<ArgumentTuple*>(untyped_args);
Abseil Team's avatar
Abseil Team committed
1544
    return ResultHolder::PerformDefaultAction(this, std::move(*args),
Gennadiy Civil's avatar
Gennadiy Civil committed
1545
                                              call_description);
1546
1547
  }

1548
1549
1550
1551
  // 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
1552
1553
  UntypedActionResultHolderBase* UntypedPerformAction(
      const void* untyped_action, void* untyped_args) const override {
1554
1555
1556
    // 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
1557
    ArgumentTuple* args = static_cast<ArgumentTuple*>(untyped_args);
Abseil Team's avatar
Abseil Team committed
1558
    return ResultHolder::PerformAction(action, std::move(*args));
1559
1560
1561
1562
  }

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

    // 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();
1578
    for (UntypedOnCallSpecs::const_iterator it =
1579
1580
             specs_to_delete.begin();
         it != specs_to_delete.end(); ++it) {
1581
      delete static_cast<const OnCallSpec<F>*>(*it);
1582
    }
1583
1584
1585
1586

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

1589
1590
1591
  // 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
1592
1593
1594
1595
  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))));
1596
    return holder->Unwrap();
1597
  }
1598

Abseil Team's avatar
Abseil Team committed
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
  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;

1609
  // Adds and returns a default action spec for this mock function.
1610
  OnCallSpec<F>& AddNewOnCallSpec(
1611
      const char* file, int line,
1612
1613
      const ArgumentMatcherTuple& m)
          GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1614
    Mock::RegisterUseByOnCallOrExpectCall(MockObject(), file, line);
1615
1616
1617
    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;
1618
1619
1620
  }

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

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

    return *expectation;
  }

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

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

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

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

  // 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
1667
1668
1669
  void UntypedDescribeUninterestingCall(const void* untyped_args,
                                        ::std::ostream* os) const override
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1670
1671
    const ArgumentTuple& args =
        *static_cast<const ArgumentTuple*>(untyped_args);
1672
1673
1674
    *os << "Uninteresting mock function call - ";
    DescribeDefaultActionTo(args, os);
    *os << "    Function call: " << Name();
vladlosev's avatar
vladlosev committed
1675
    UniversalPrint(args, os);
1676
1677
  }

1678
1679
1680
1681
1682
1683
1684
  // 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.
  //
1685
1686
1687
1688
1689
1690
1691
1692
1693
  // 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
1694
1695
1696
1697
  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) {
1698
1699
    const ArgumentTuple& args =
        *static_cast<const ArgumentTuple*>(untyped_args);
1700
    MutexLock l(&g_gmock_mutex);
1701
    TypedExpectation<F>* exp = this->FindMatchingExpectationLocked(args);
1702
    if (exp == nullptr) {  // A match wasn't found.
1703
      this->FormatUnexpectedCallMessageLocked(args, what, why);
1704
      return nullptr;
1705
1706
1707
1708
1709
    }

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

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

  // Returns the expectation that matches the arguments, or NULL if no
  // expectation matches them.
1728
  TypedExpectation<F>* FindMatchingExpectationLocked(
1729
1730
      const ArgumentTuple& args) const
          GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1731
    g_gmock_mutex.AssertHeld();
Gennadiy Civil's avatar
Gennadiy Civil committed
1732
1733
    // See the definition of untyped_expectations_ for why access to
    // it is unprotected here.
1734
1735
1736
1737
1738
    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());
1739
1740
1741
1742
      if (exp->ShouldHandleArguments(args)) {
        return exp;
      }
    }
1743
    return nullptr;
1744
1745
1746
  }

  // Returns a message that the arguments don't match any expectation.
1747
1748
1749
1750
1751
  void FormatUnexpectedCallMessageLocked(
      const ArgumentTuple& args,
      ::std::ostream* os,
      ::std::ostream* why) const
          GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1752
1753
1754
1755
1756
1757
1758
1759
    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.
1760
1761
1762
1763
  void PrintTriedExpectationsLocked(
      const ArgumentTuple& args,
      ::std::ostream* why) const
          GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1764
    g_gmock_mutex.AssertHeld();
1765
    const size_t count = untyped_expectations_.size();
1766
1767
1768
1769
    *why << "Google Mock tried the following " << count << " "
         << (count == 1 ? "expectation, but it didn't match" :
             "expectations, but none matched")
         << ":\n";
1770
    for (size_t i = 0; i < count; i++) {
1771
1772
      TypedExpectation<F>* const expectation =
          static_cast<TypedExpectation<F>*>(untyped_expectations_[i].get());
1773
      *why << "\n";
1774
      expectation->DescribeLocationTo(why);
1775
      if (count > 1) {
1776
        *why << "tried expectation #" << i << ": ";
1777
      }
1778
1779
1780
      *why << expectation->source_text() << "...\n";
      expectation->ExplainMatchResultTo(args, why);
      expectation->DescribeCallCountTo(why);
1781
1782
    }
  }
Abseil Team's avatar
Abseil Team committed
1783
};  // class FunctionMocker
1784

misterg's avatar
misterg committed
1785
GTEST_DISABLE_MSC_WARNINGS_POP_()  //  4355
1786
1787
1788

// Reports an uninteresting call (whose description is in msg) in the
// manner specified by 'reaction'.
1789
void ReportUninterestingCall(CallReaction reaction, const std::string& msg);
1790
1791
1792

}  // namespace internal

Abseil Team's avatar
Abseil Team committed
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
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
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
// A MockFunction<F> class has one mock method whose type is 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:
//
//   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
// std::function<F> callbacks. To do so, use AsStdFunction() method
// to create std::function proxy forwarding to original object's Call.
// Example:
//
// TEST(FooTest, RunsCallbackWithBarArgument) {
//   MockFunction<int(string)> callback;
//   EXPECT_CALL(callback, Call("bar")).WillOnce(Return(1));
//   Foo(callback.AsStdFunction());
// }
template <typename F>
class MockFunction;

template <typename R, typename... Args>
class MockFunction<R(Args...)> {
 public:
  MockFunction() {}
  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)...);
  }

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

  internal::MockSpec<R(Args...)> gmock_Call(const internal::WithoutMatchers&,
                                            R (*)(Args...)) {
    return this->gmock_Call(::testing::A<Args>()...);
  }

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

1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
// 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; }

1900
1901
1902
1903
// Constructs an Expectation object that references and co-owns exp.
inline Expectation::Expectation(internal::ExpectationBase& exp)  // NOLINT
    : expectation_base_(exp.GetHandle().expectation_base()) {}

1904
1905
}  // namespace testing

misterg's avatar
misterg committed
1906
1907
GTEST_DISABLE_MSC_WARNINGS_POP_()  //  4251

1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
// 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:
1919
1920
//   ON_CALL(mock, NoArgsMethod()).WillByDefault(...);
//   ON_CALL(mock, NoArgsMethod).WillByDefault(...);
1921
1922
//
//   // As are these:
1923
1924
//   ON_CALL(mock, TwoArgsMethod(_, _)).WillByDefault(...);
//   ON_CALL(mock, TwoArgsMethod).WillByDefault(...);
1925
1926
//
//   // Can also specify args if you want, of course:
1927
//   ON_CALL(mock, TwoArgsMethod(_, 45)).WillByDefault(...);
1928
1929
//
//   // Overloads work as long as you specify parameters:
1930
1931
//   ON_CALL(mock, OverloadedMethod(_)).WillByDefault(...);
//   ON_CALL(mock, OverloadedMethod(_, _)).WillByDefault(...);
1932
1933
//
//   // Oops! Which overload did you want?
1934
//   ON_CALL(mock, OverloadedMethod).WillByDefault(...);
1935
1936
1937
1938
1939
1940
1941
//     => 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:
1942
//   ON_CALL(mock, TwoArgsMethod(_, 45))...
1943
//
1944
1945
//   // ...expands to:
//   mock.gmock_TwoArgsMethod(_, 45)(WithoutMatchers(), nullptr)...
1946
1947
1948
//   |-------------v---------------||------------v-------------|
//       invokes first overload        swallowed by operator()
//
1949
1950
//   // ...which is essentially:
//   mock.gmock_TwoArgsMethod(_, 45)...
1951
1952
1953
1954
//
// Whereas the form without a matcher list:
//
//   // This statement:
1955
//   ON_CALL(mock, TwoArgsMethod)...
1956
//
1957
1958
//   // ...expands to:
//   mock.gmock_TwoArgsMethod(WithoutMatchers(), nullptr)...
1959
1960
1961
//   |-----------------------v--------------------------|
//                 invokes second overload
//
1962
1963
//   // ...which is essentially:
//   mock.gmock_TwoArgsMethod(_, _)...
1964
1965
1966
1967
1968
1969
//
// 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.
1970
1971
1972
#define GMOCK_ON_CALL_IMPL_(mock_expr, Setter, call)                    \
  ((mock_expr).gmock_##call)(::testing::internal::GetWithoutMatchers(), \
                             nullptr)                                   \
1973
1974
1975
1976
1977
1978
1979
      .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)
1980
1981

#endif  // GMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_