gmock-spec-builders.h 65.6 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
29
30
31
32
33
34
35
36
37
38
39
// 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.
//
// Author: wan@google.com (Zhanyong Wan)

// 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))
40
//       .With(multi-argument-matcher)
41
42
//       .WillByDefault(action);
//
43
//  where the .With() clause is optional.
44
45
46
47
48
//
// 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))
49
//       .With(multi-argument-matchers)
50
51
//       .Times(cardinality)
//       .InSequence(sequences)
52
//       .After(expectations)
53
54
55
56
//       .WillOnce(action)
//       .WillRepeatedly(action)
//       .RetiresOnSaturation();
//
57
58
// where all clauses are optional, and .InSequence()/.After()/
// .WillOnce() can appear any number of times.
59
60
61
62
63
64
65
66
67
68

#ifndef GMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_
#define GMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_

#include <map>
#include <set>
#include <sstream>
#include <string>
#include <vector>

69
70
71
72
#if GTEST_HAS_EXCEPTIONS
# include <stdexcept>  // NOLINT
#endif

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
80
81

namespace testing {

82
83
84
85
86
87
// An abstract handle of an expectation.
class Expectation;

// A set of expectation handles.
class ExpectationSet;

88
89
90
91
// Anything inside the 'internal' namespace IS INTERNAL IMPLEMENTATION
// and MUST NOT BE USED IN USER CODE!!!
namespace internal {

92
93
// Implements a mock function.
template <typename F> class FunctionMocker;
94
95
96
97

// Base class for expectations.
class ExpectationBase;

98
99
100
// Implements an expectation.
template <typename F> class TypedExpectation;

101
102
103
104
// Helper class for testing the Expectation class template.
class ExpectationTester;

// Base class for function mockers.
105
template <typename F> class FunctionMockerBase;
106
107
108
109
110
111
112
113
114
115
116
117

// 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.
118
GTEST_API_ GTEST_DECLARE_STATIC_MUTEX_(g_gmock_mutex);
119

120
121
122
// Untyped base class for ActionResultHolder<R>.
class UntypedActionResultHolderBase;

123
124
125
// Abstract base class of FunctionMockerBase.  This is the
// type-agnostic part of the function mocker interface.  Its pure
// virtual methods are implemented by FunctionMockerBase.
126
class GTEST_API_ UntypedFunctionMockerBase {
127
 public:
128
129
  UntypedFunctionMockerBase();
  virtual ~UntypedFunctionMockerBase();
130
131
132
133

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

  // Clears the ON_CALL()s set on this mock function.
138
139
  virtual void ClearDefaultActionsLocked()
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) = 0;
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

  // 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(
      const void* untyped_args,
      const string& call_description) const = 0;

  // Performs the given action with the given arguments and returns
  // the action's result.
  // L = *
  virtual UntypedActionResultHolderBase* UntypedPerformAction(
      const void* untyped_action,
      const void* untyped_args) const = 0;

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

  // 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.
  // TODO(wan@google.com): rename to SetAndRegisterOwner().
190
191
  void RegisterOwner(const void* mock_obj)
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
192
193
194
195

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

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

  // Returns the name of this mock method.  Must be called after
  // SetOwnerAndName() has been called.
207
208
  const char* Name() const
      GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
209
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.
  const UntypedActionResultHolderBase* UntypedInvokeWith(
215
216
      const void* untyped_args)
          GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241

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

  typedef std::vector<internal::linked_ptr<ExpectationBase> >
  UntypedExpectations;

  // 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.
  UntypedExpectations untyped_expectations_;
242
243
};  // class UntypedFunctionMockerBase

244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
// 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,
262
    kWillByDefault
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
  };

  // Asserts that the ON_CALL() statement has a certain property.
  void AssertSpecProperty(bool property, const string& failure_message) const {
    Assert(property, file_, line_, failure_message);
  }

  // Expects that the ON_CALL() statement has a certain property.
  void ExpectSpecProperty(bool property, const string& failure_message) const {
    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.
284
template <typename F>
285
class OnCallSpec : public UntypedOnCallSpecBase {
286
287
288
289
 public:
  typedef typename Function<F>::ArgumentTuple ArgumentTuple;
  typedef typename Function<F>::ArgumentMatcherTuple ArgumentMatcherTuple;

290
  // Constructs an OnCallSpec object from the information inside
291
  // the parenthesis of an ON_CALL() statement.
292
293
294
  OnCallSpec(const char* a_file, int a_line,
             const ArgumentMatcherTuple& matchers)
      : UntypedOnCallSpecBase(a_file, a_line),
295
        matchers_(matchers),
296
297
298
299
        // By default, extra_matcher_ should match anything.  However,
        // we cannot initialize it with _ as that triggers a compiler
        // bug in Symbian's C++ compiler (cannot decide between two
        // overloaded constructors of Matcher<const ArgumentTuple&>).
300
        extra_matcher_(A<const ArgumentTuple&>()) {
301
302
  }

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

    extra_matcher_ = m;
    return *this;
  }

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

    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 {
335
    AssertSpecProperty(last_clause_ == kWillByDefault,
336
337
338
339
                       ".WillByDefault() must appear exactly "
                       "once in an ON_CALL().");
    return action_;
  }
340

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

zhanyong.wan's avatar
zhanyong.wan committed
360
// Possible reactions on uninteresting calls.
361
enum CallReaction {
zhanyong.wan's avatar
zhanyong.wan committed
362
363
364
  kAllow,
  kWarn,
  kFail
365
366
367
368
369
};

}  // namespace internal

// Utilities for manipulating mock objects.
370
class GTEST_API_ Mock {
371
372
373
 public:
  // The following public methods can be called concurrently.

374
375
  // Tells Google Mock to ignore mock_obj when checking for leaked
  // mock objects.
376
377
  static void AllowLeak(const void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
378

379
380
381
  // 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.
382
383
  static bool VerifyAndClearExpectations(void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
384
385
386
387

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

391
 private:
392
393
  friend class internal::UntypedFunctionMockerBase;

394
395
396
397
398
399
400
401
402
403
404
405
406
  // Needed for a function mocker to register itself (so that we know
  // how to clear a mock object).
  template <typename F>
  friend class internal::FunctionMockerBase;

  template <typename M>
  friend class NiceMock;

  template <typename M>
  friend class StrictMock;

  // Tells Google Mock to allow uninteresting calls on the given mock
  // object.
407
408
  static void AllowUninterestingCalls(const void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
409
410
411

  // Tells Google Mock to warn the user about uninteresting calls on
  // the given mock object.
412
413
  static void WarnUninterestingCalls(const void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
414
415
416

  // Tells Google Mock to fail uninteresting calls on the given mock
  // object.
417
418
  static void FailUninterestingCalls(const void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
419
420
421

  // Tells Google Mock the given mock object is being destroyed and
  // its entry in the call-reaction table should be removed.
422
423
  static void UnregisterCallReaction(const void* mock_obj)
      GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
424
425
426
427

  // 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
428
      const void* mock_obj)
429
          GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
430
431
432
433

  // 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.
434
435
  static bool VerifyAndClearExpectationsLocked(void* mock_obj)
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex);
436
437

  // Clears all ON_CALL()s set on the given mock object.
438
439
  static void ClearDefaultActionsLocked(void* mock_obj)
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex);
440
441

  // Registers a mock object and a mock method it owns.
442
443
444
445
  static void Register(
      const void* mock_obj,
      internal::UntypedFunctionMockerBase* mocker)
          GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
446

447
448
449
450
  // 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(
451
452
      const void* mock_obj, const char* file, int line)
          GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
453

454
455
456
457
  // 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
  // FunctionMockerBase.
458
459
  static void UnregisterLocked(internal::UntypedFunctionMockerBase* mocker)
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex);
460
461
};  // class Mock

462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
// 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().
477
478
479
480
481
482
//   - The constructors and destructor are defined out-of-line because
//     the Symbian WINSCW compiler wants to otherwise instantiate them
//     when it sees this class definition, at which point it doesn't have
//     ExpectationBase available yet, leading to incorrect destruction
//     in the linked_ptr (or compilation errors if using a checking
//     linked_ptr).
483
class GTEST_API_ Expectation {
484
485
 public:
  // Constructs a null object that doesn't reference any expectation.
486
487
488
  Expectation();

  ~Expectation();
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514

  // 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;
515
  friend class ::testing::internal::UntypedFunctionMockerBase;
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533

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

  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(
534
      const internal::linked_ptr<internal::ExpectationBase>& expectation_base);
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
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

  // Returns the expectation this object references.
  const internal::linked_ptr<internal::ExpectationBase>&
  expectation_base() const {
    return expectation_base_;
  }

  // A linked_ptr that co-owns the expectation this handle references.
  internal::linked_ptr<internal::ExpectationBase> expectation_base_;
};

// 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_;
};


612
613
614
// 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).
615
class GTEST_API_ Sequence {
616
617
 public:
  // Constructs an empty sequence.
618
  Sequence() : last_expectation_(new Expectation) {}
619
620
621

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

624
 private:
625
626
627
628
629
  // The last expectation in this sequence.  We use a linked_ptr here
  // because Sequence objects are copyable and we want the copies to
  // be aliases.  The linked_ptr allows the copies to co-own and share
  // the same Expectation object.
  internal::linked_ptr<Expectation> last_expectation_;
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
};  // 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.
656
class GTEST_API_ InSequence {
657
658
659
660
661
662
663
 public:
  InSequence();
  ~InSequence();
 private:
  bool sequence_created_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(InSequence);  // NOLINT
664
} GTEST_ATTRIBUTE_UNUSED_;
665
666
667
668
669

namespace internal {

// Points to the implicit sequence introduced by a living InSequence
// object (if any) in the current thread or NULL.
670
GTEST_API_ extern ThreadLocal<Sequence*> g_gmock_implicit_sequence;
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685

// 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.
686
class GTEST_API_ ExpectationBase {
687
 public:
688
689
  // source_text is the EXPECT_CALL(...) source that created this Expectation.
  ExpectationBase(const char* file, int line, const string& source_text);
690
691
692
693
694
695

  virtual ~ExpectationBase();

  // Where in the source file was the expectation spec defined?
  const char* file() const { return file_; }
  int line() const { return line_; }
696
  const char* source_text() const { return source_text_.c_str(); }
697
698
699
700
701
  // 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 {
702
    *os << FormatFileLocation(file(), line()) << " ";
703
704
705
706
  }

  // Describes how many times a function call matching this
  // expectation has occurred.
707
708
  void DescribeCallCountTo(::std::ostream* os) const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
709
710
711
712

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

714
 protected:
715
  friend class ::testing::Expectation;
716
  friend class UntypedFunctionMockerBase;
717
718
719

  enum Clause {
    // Don't change the order of the enum members!
720
721
722
723
    kNone,
    kWith,
    kTimes,
    kInSequence,
724
    kAfter,
725
726
    kWillOnce,
    kWillRepeatedly,
727
    kRetiresOnSaturation
728
729
  };

730
731
  typedef std::vector<const void*> UntypedActions;

732
733
734
735
  // Returns an Expectation object that references and co-owns this
  // expectation.
  virtual Expectation GetHandle() = 0;

736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
  // Asserts that the EXPECT_CALL() statement has the given property.
  void AssertSpecProperty(bool property, const string& failure_message) const {
    Assert(property, file_, line_, failure_message);
  }

  // Expects that the EXPECT_CALL() statement has the given property.
  void ExpectSpecProperty(bool property, const string& failure_message) const {
    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.
755
756
  void set_cardinality(const Cardinality& a_cardinality) {
    cardinality_ = a_cardinality;
757
758
759
760
761
762
763
  }

  // 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.
764
765
  void RetireAllPreRequisites()
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
766
767

  // Returns true iff this expectation is retired.
768
769
  bool is_retired() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
770
771
772
773
774
    g_gmock_mutex.AssertHeld();
    return retired_;
  }

  // Retires this expectation.
775
776
  void Retire()
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
777
778
779
780
781
    g_gmock_mutex.AssertHeld();
    retired_ = true;
  }

  // Returns true iff this expectation is satisfied.
782
783
  bool IsSatisfied() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
784
785
786
787
788
    g_gmock_mutex.AssertHeld();
    return cardinality().IsSatisfiedByCallCount(call_count_);
  }

  // Returns true iff this expectation is saturated.
789
790
  bool IsSaturated() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
791
792
793
794
795
    g_gmock_mutex.AssertHeld();
    return cardinality().IsSaturatedByCallCount(call_count_);
  }

  // Returns true iff this expectation is over-saturated.
796
797
  bool IsOverSaturated() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
798
799
800
801
802
    g_gmock_mutex.AssertHeld();
    return cardinality().IsOverSaturatedByCallCount(call_count_);
  }

  // Returns true iff all pre-requisites of this expectation are satisfied.
803
804
  bool AllPrerequisitesAreSatisfied() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
805
806

  // Adds unsatisfied pre-requisites of this expectation to 'result'.
807
808
  void FindUnsatisfiedPrerequisites(ExpectationSet* result) const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
809
810

  // Returns the number this expectation has been invoked.
811
812
  int call_count() const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
813
814
815
816
817
    g_gmock_mutex.AssertHeld();
    return call_count_;
  }

  // Increments the number this expectation has been invoked.
818
819
  void IncrementCallCount()
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
820
821
822
823
    g_gmock_mutex.AssertHeld();
    call_count_++;
  }

824
825
826
827
  // 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.
828
829
  void CheckActionCountIfNotDone() const
      GTEST_LOCK_EXCLUDED_(mutex_);
830

831
832
833
834
  friend class ::testing::Sequence;
  friend class ::testing::internal::ExpectationTester;

  template <typename Function>
835
  friend class TypedExpectation;
836

837
838
839
  // Implements the .Times() clause.
  void UntypedTimes(const Cardinality& a_cardinality);

840
841
  // This group of fields are part of the spec and won't change after
  // an EXPECT_CALL() statement finishes.
842
843
844
  const char* file_;          // The file that contains the expectation.
  int line_;                  // The line number of the expectation.
  const string source_text_;  // The EXPECT_CALL(...) source text.
845
846
847
  // True iff the cardinality is specified explicitly.
  bool cardinality_specified_;
  Cardinality cardinality_;            // The cardinality of the expectation.
848
849
850
851
852
853
854
  // The immediate pre-requisites (i.e. expectations that must be
  // satisfied before this expectation can be matched) of this
  // expectation.  We use linked_ptr in the set because we want an
  // 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_;
855
856
857
858
859

  // 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.
860
861
862
863
864
865
866
  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_.
867
868

  GTEST_DISALLOW_ASSIGN_(ExpectationBase);
869
870
871
872
};  // class ExpectationBase

// Impements an expectation for the given function type.
template <typename F>
873
class TypedExpectation : public ExpectationBase {
874
875
876
877
878
 public:
  typedef typename Function<F>::ArgumentTuple ArgumentTuple;
  typedef typename Function<F>::ArgumentMatcherTuple ArgumentMatcherTuple;
  typedef typename Function<F>::Result Result;

879
  TypedExpectation(FunctionMockerBase<F>* owner,
880
                   const char* a_file, int a_line, const string& a_source_text,
881
                   const ArgumentMatcherTuple& m)
882
      : ExpectationBase(a_file, a_line, a_source_text),
883
884
        owner_(owner),
        matchers_(m),
885
886
887
888
889
        // By default, extra_matcher_ should match anything.  However,
        // we cannot initialize it with _ as that triggers a compiler
        // bug in Symbian's C++ compiler (cannot decide between two
        // overloaded constructors of Matcher<const ArgumentTuple&>).
        extra_matcher_(A<const ArgumentTuple&>()),
890
        repeated_action_(DoDefault()) {}
891

892
  virtual ~TypedExpectation() {
893
894
895
    // Check the validity of the action count if it hasn't been done
    // yet (for example, if the expectation was never used).
    CheckActionCountIfNotDone();
896
897
898
899
    for (UntypedActions::const_iterator it = untyped_actions_.begin();
         it != untyped_actions_.end(); ++it) {
      delete static_cast<const Action<F>*>(*it);
    }
900
901
  }

902
  // Implements the .With() clause.
903
  TypedExpectation& With(const Matcher<const ArgumentTuple&>& m) {
904
    if (last_clause_ == kWith) {
905
      ExpectSpecProperty(false,
906
                         ".With() cannot appear "
907
908
                         "more than once in an EXPECT_CALL().");
    } else {
909
910
      ExpectSpecProperty(last_clause_ < kWith,
                         ".With() must be the first "
911
912
                         "clause in an EXPECT_CALL().");
    }
913
    last_clause_ = kWith;
914
915

    extra_matcher_ = m;
916
    extra_matcher_specified_ = true;
917
918
919
920
    return *this;
  }

  // Implements the .Times() clause.
921
  TypedExpectation& Times(const Cardinality& a_cardinality) {
922
    ExpectationBase::UntypedTimes(a_cardinality);
923
924
925
926
    return *this;
  }

  // Implements the .Times() clause.
927
  TypedExpectation& Times(int n) {
928
929
930
931
    return Times(Exactly(n));
  }

  // Implements the .InSequence() clause.
932
  TypedExpectation& InSequence(const Sequence& s) {
933
    ExpectSpecProperty(last_clause_ <= kInSequence,
934
935
                       ".InSequence() cannot appear after .After(),"
                       " .WillOnce(), .WillRepeatedly(), or "
936
                       ".RetiresOnSaturation().");
937
    last_clause_ = kInSequence;
938

939
    s.AddExpectation(GetHandle());
940
941
    return *this;
  }
942
  TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2) {
943
944
    return InSequence(s1).InSequence(s2);
  }
945
946
  TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2,
                               const Sequence& s3) {
947
948
    return InSequence(s1, s2).InSequence(s3);
  }
949
950
  TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2,
                               const Sequence& s3, const Sequence& s4) {
951
952
    return InSequence(s1, s2, s3).InSequence(s4);
  }
953
954
955
  TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2,
                               const Sequence& s3, const Sequence& s4,
                               const Sequence& s5) {
956
957
958
    return InSequence(s1, s2, s3, s4).InSequence(s5);
  }

959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
  // 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);
  }

989
  // Implements the .WillOnce() clause.
990
  TypedExpectation& WillOnce(const Action<F>& action) {
991
    ExpectSpecProperty(last_clause_ <= kWillOnce,
992
993
                       ".WillOnce() cannot appear after "
                       ".WillRepeatedly() or .RetiresOnSaturation().");
994
    last_clause_ = kWillOnce;
995

996
    untyped_actions_.push_back(new Action<F>(action));
997
    if (!cardinality_specified()) {
998
      set_cardinality(Exactly(static_cast<int>(untyped_actions_.size())));
999
1000
1001
1002
1003
    }
    return *this;
  }

  // Implements the .WillRepeatedly() clause.
1004
  TypedExpectation& WillRepeatedly(const Action<F>& action) {
1005
    if (last_clause_ == kWillRepeatedly) {
1006
1007
1008
1009
      ExpectSpecProperty(false,
                         ".WillRepeatedly() cannot appear "
                         "more than once in an EXPECT_CALL().");
    } else {
1010
      ExpectSpecProperty(last_clause_ < kWillRepeatedly,
1011
1012
1013
                         ".WillRepeatedly() cannot appear "
                         "after .RetiresOnSaturation().");
    }
1014
    last_clause_ = kWillRepeatedly;
1015
1016
1017
1018
    repeated_action_specified_ = true;

    repeated_action_ = action;
    if (!cardinality_specified()) {
1019
      set_cardinality(AtLeast(static_cast<int>(untyped_actions_.size())));
1020
1021
1022
1023
1024
1025
1026
1027
1028
    }

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

  // Implements the .RetiresOnSaturation() clause.
1029
  TypedExpectation& RetiresOnSaturation() {
1030
    ExpectSpecProperty(last_clause_ < kRetiresOnSaturation,
1031
1032
                       ".RetiresOnSaturation() cannot appear "
                       "more than once.");
1033
    last_clause_ = kRetiresOnSaturation;
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
    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_;
  }

1048
  // Returns the matcher specified by the .With() clause.
1049
1050
1051
1052
1053
1054
1055
  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_; }

1056
1057
1058
  // If this mock method has an extra matcher (i.e. .With(matcher)),
  // describes it to the ostream.
  virtual void MaybeDescribeExtraMatcherTo(::std::ostream* os) {
1059
1060
1061
1062
1063
1064
1065
    if (extra_matcher_specified_) {
      *os << "    Expected args: ";
      extra_matcher_.DescribeTo(os);
      *os << "\n";
    }
  }

1066
1067
1068
1069
 private:
  template <typename Function>
  friend class FunctionMockerBase;

1070
1071
1072
1073
1074
1075
  // Returns an Expectation object that references and co-owns this
  // expectation.
  virtual Expectation GetHandle() {
    return owner_->GetHandleOf(this);
  }

1076
1077
1078
1079
1080
  // 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.
1081
1082
  bool Matches(const ArgumentTuple& args) const
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1083
1084
1085
1086
1087
    g_gmock_mutex.AssertHeld();
    return TupleMatches(matchers_, args) && extra_matcher_.Matches(args);
  }

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

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

1157
    const int action_count = static_cast<int>(untyped_actions_.size());
1158
1159
1160
1161
1162
1163
    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);
1164
      ss << "Actions ran out in " << source_text() << "...\n"
1165
1166
1167
1168
         << "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
1169
      Log(kWarning, ss.str(), 1);
1170
1171
    }

1172
1173
1174
    return count <= action_count ?
        *static_cast<const Action<F>*>(untyped_actions_[count - 1]) :
        repeated_action();
1175
1176
1177
1178
1179
1180
1181
  }

  // 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
1182
1183
  // IncrementCallCount().  A return value of NULL means the default
  // action.
1184
1185
1186
1187
1188
1189
  const Action<F>* GetActionForArguments(
      const FunctionMockerBase<F>* mocker,
      const ArgumentTuple& args,
      ::std::ostream* what,
      ::std::ostream* why)
          GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1190
1191
1192
1193
1194
1195
1196
1197
    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);

1198
1199
1200
1201
      // TODO(wan@google.com): allow the user to control whether
      // unexpected calls should fail immediately or continue using a
      // flag --gmock_unexpected_calls_are_fatal.
      return NULL;
1202
1203
1204
1205
1206
    }

    IncrementCallCount();
    RetireAllPreRequisites();

1207
    if (retires_on_saturation_ && IsSaturated()) {
1208
1209
1210
1211
      Retire();
    }

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

  // All the fields below won't change once the EXPECT_CALL()
  // statement finishes.
  FunctionMockerBase<F>* const owner_;
  ArgumentMatcherTuple matchers_;
  Matcher<const ArgumentTuple&> extra_matcher_;
  Action<F> repeated_action_;
1222
1223

  GTEST_DISALLOW_COPY_AND_ASSIGN_(TypedExpectation);
1224
};  // class TypedExpectation
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235

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

1236
// Logs a message including file and line number information.
1237
1238
1239
GTEST_API_ void LogWithLocation(testing::internal::LogSeverity severity,
                                const char* file, int line,
                                const string& message);
1240

1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
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.
  explicit MockSpec(internal::FunctionMockerBase<F>* function_mocker)
      : function_mocker_(function_mocker) {}

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

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

 private:
  template <typename Function>
  friend class internal::FunctionMocker;

  void SetMatchers(const ArgumentMatcherTuple& matchers) {
    matchers_ = matchers;
  }

  // The function mocker that owns this spec.
  internal::FunctionMockerBase<F>* const function_mocker_;
  // The argument matchers specified in the spec.
  ArgumentMatcherTuple matchers_;
1284
1285

  GTEST_DISALLOW_ASSIGN_(MockSpec);
1286
1287
1288
1289
1290
1291
1292
1293
};  // class MockSpec

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

#ifdef _MSC_VER
1294
1295
# pragma warning(push)          // Saves the current warning state.
# pragma warning(disable:4355)  // Temporarily disables warning 4355.
1296
1297
#endif  // _MSV_VER

1298
1299
1300
1301
1302
1303
// 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
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
// 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.
1316
template <typename T>
1317
class ActionResultHolder : public UntypedActionResultHolderBase {
1318
 public:
1319
  explicit ActionResultHolder(T a_value) : value_(a_value) {}
1320
1321
1322
1323

  // The compiler-generated copy constructor and assignment operator
  // are exactly what we need, so we don't need to define them.

1324
1325
1326
1327
1328
1329
  // Returns the held value and deletes this object.
  T GetValueAndDelete() const {
    T retval(value_);
    delete this;
    return retval;
  }
1330
1331

  // Prints the held value as an action's result to os.
1332
  virtual void PrintAsActionResult(::std::ostream* os) const {
1333
    *os << "\n          Returns: ";
vladlosev's avatar
vladlosev committed
1334
    // T may be a reference type, so we don't use UniversalPrint().
1335
1336
1337
1338
    UniversalPrinter<T>::Print(value_, os);
  }

  // Performs the given mock function's default action and returns the
1339
1340
1341
1342
1343
  // result in a new-ed ActionResultHolder.
  template <typename F>
  static ActionResultHolder* PerformDefaultAction(
      const FunctionMockerBase<F>* func_mocker,
      const typename Function<F>::ArgumentTuple& args,
1344
      const string& call_description) {
1345
    return new ActionResultHolder(
1346
1347
1348
        func_mocker->PerformDefaultAction(args, call_description));
  }

1349
  // Performs the given action and returns the result in a new-ed
1350
  // ActionResultHolder.
1351
1352
1353
1354
1355
  template <typename F>
  static ActionResultHolder*
  PerformAction(const Action<F>& action,
                const typename Function<F>::ArgumentTuple& args) {
    return new ActionResultHolder(action.Perform(args));
1356
1357
1358
1359
  }

 private:
  T value_;
1360
1361
1362

  // T could be a reference type, so = isn't supported.
  GTEST_DISALLOW_ASSIGN_(ActionResultHolder);
1363
1364
1365
1366
};

// Specialization for T = void.
template <>
1367
class ActionResultHolder<void> : public UntypedActionResultHolderBase {
1368
 public:
1369
1370
1371
1372
1373
1374
1375
1376
1377
  void GetValueAndDelete() const { delete this; }

  virtual void PrintAsActionResult(::std::ostream* /* os */) const {}

  // Performs the given mock function's default action and returns NULL;
  template <typename F>
  static ActionResultHolder* PerformDefaultAction(
      const FunctionMockerBase<F>* func_mocker,
      const typename Function<F>::ArgumentTuple& args,
1378
1379
      const string& call_description) {
    func_mocker->PerformDefaultAction(args, call_description);
1380
    return NULL;
1381
1382
  }

1383
1384
1385
1386
1387
  // Performs the given action and returns NULL.
  template <typename F>
  static ActionResultHolder* PerformAction(
      const Action<F>& action,
      const typename Function<F>::ArgumentTuple& args) {
1388
    action.Perform(args);
1389
    return NULL;
1390
1391
1392
  }
};

1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
// The base of the function mocker class for the given function type.
// We put the methods in this class instead of its child to avoid code
// bloat.
template <typename F>
class FunctionMockerBase : public UntypedFunctionMockerBase {
 public:
  typedef typename Function<F>::Result Result;
  typedef typename Function<F>::ArgumentTuple ArgumentTuple;
  typedef typename Function<F>::ArgumentMatcherTuple ArgumentMatcherTuple;

1403
  FunctionMockerBase() : current_spec_(this) {}
1404
1405
1406
1407

  // 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.
1408
1409
  virtual ~FunctionMockerBase()
        GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1410
1411
1412
    MutexLock l(&g_gmock_mutex);
    VerifyAndClearExpectationsLocked();
    Mock::UnregisterLocked(this);
1413
    ClearDefaultActionsLocked();
1414
1415
1416
1417
1418
  }

  // Returns the ON_CALL spec that matches this mock function with the
  // given arguments; returns NULL if no matching ON_CALL is found.
  // L = *
1419
  const OnCallSpec<F>* FindOnCallSpec(
1420
      const ArgumentTuple& args) const {
1421
1422
1423
1424
1425
1426
    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;
1427
1428
1429
1430
1431
    }

    return NULL;
  }

1432
1433
1434
1435
1436
1437
  // 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.
1438
  // L = *
1439
1440
  Result PerformDefaultAction(const ArgumentTuple& args,
                              const string& call_description) const {
1441
1442
    const OnCallSpec<F>* const spec =
        this->FindOnCallSpec(args);
1443
1444
1445
    if (spec != NULL) {
      return spec->GetAction().Perform(args);
    }
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
    const string message = call_description +
        "\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
1456
    return DefaultValue<Result>::Get();
1457
1458
  }

1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
  // 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 = *
  virtual UntypedActionResultHolderBase* UntypedPerformDefaultAction(
      const void* untyped_args,  // must point to an ArgumentTuple
      const string& call_description) const {
    const ArgumentTuple& args =
        *static_cast<const ArgumentTuple*>(untyped_args);
    return ResultHolder::PerformDefaultAction(this, args, call_description);
1470
1471
  }

1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
  // Performs the given action with the given arguments and returns
  // the action's result.  The caller is responsible for deleting the
  // result.
  // L = *
  virtual UntypedActionResultHolderBase* UntypedPerformAction(
      const void* untyped_action, const void* untyped_args) const {
    // 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);
    const ArgumentTuple& args =
        *static_cast<const ArgumentTuple*>(untyped_args);
    return ResultHolder::PerformAction(action, args);
  }

  // Implements UntypedFunctionMockerBase::ClearDefaultActionsLocked():
  // clears the ON_CALL()s set on this mock function.
1488
1489
  virtual void ClearDefaultActionsLocked()
      GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1490
    g_gmock_mutex.AssertHeld();
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502

    // 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();
1503
    for (UntypedOnCallSpecs::const_iterator it =
1504
1505
             specs_to_delete.begin();
         it != specs_to_delete.end(); ++it) {
1506
      delete static_cast<const OnCallSpec<F>*>(*it);
1507
    }
1508
1509
1510
1511

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

1514
1515
1516
1517
 protected:
  template <typename Function>
  friend class MockSpec;

1518
1519
  typedef ActionResultHolder<Result> ResultHolder;

1520
1521
1522
  // Returns the result of invoking this mock function with the given
  // arguments.  This function can be safely called from multiple
  // threads concurrently.
1523
1524
  Result InvokeWith(const ArgumentTuple& args)
        GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1525
1526
1527
    return static_cast<const ResultHolder*>(
        this->UntypedInvokeWith(&args))->GetValueAndDelete();
  }
1528
1529

  // Adds and returns a default action spec for this mock function.
1530
  OnCallSpec<F>& AddNewOnCallSpec(
1531
      const char* file, int line,
1532
1533
      const ArgumentMatcherTuple& m)
          GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1534
    Mock::RegisterUseByOnCallOrExpectCall(MockObject(), file, line);
1535
1536
1537
    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;
1538
1539
1540
  }

  // Adds and returns an expectation spec for this mock function.
1541
  TypedExpectation<F>& AddNewExpectation(
1542
1543
1544
      const char* file,
      int line,
      const string& source_text,
1545
1546
      const ArgumentMatcherTuple& m)
          GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1547
    Mock::RegisterUseByOnCallOrExpectCall(MockObject(), file, line);
1548
1549
1550
1551
    TypedExpectation<F>* const expectation =
        new TypedExpectation<F>(this, file, line, source_text, m);
    const linked_ptr<ExpectationBase> untyped_expectation(expectation);
    untyped_expectations_.push_back(untyped_expectation);
1552
1553
1554
1555

    // Adds this expectation into the implicit sequence if there is one.
    Sequence* const implicit_sequence = g_gmock_implicit_sequence.get();
    if (implicit_sequence != NULL) {
1556
      implicit_sequence->AddExpectation(Expectation(untyped_expectation));
1557
1558
1559
1560
1561
1562
1563
1564
    }

    return *expectation;
  }

  // The current spec (either default action spec or expectation spec)
  // being described on this function mocker.
  MockSpec<F>& current_spec() { return current_spec_; }
1565

1566
 private:
1567
  template <typename Func> friend class TypedExpectation;
1568

1569
  // Some utilities needed for implementing UntypedInvokeWith().
1570
1571
1572
1573
1574
1575

  // Describes what default action will be performed for the given
  // arguments.
  // L = *
  void DescribeDefaultActionTo(const ArgumentTuple& args,
                               ::std::ostream* os) const {
1576
    const OnCallSpec<F>* const spec = FindOnCallSpec(args);
1577
1578
1579
1580
1581
1582
1583

    if (spec == NULL) {
      *os << (internal::type_equals<Result, void>::value ?
              "returning directly.\n" :
              "returning default value.\n");
    } else {
      *os << "taking default action specified at:\n"
1584
          << FormatFileLocation(spec->file(), spec->line()) << "\n";
1585
1586
1587
1588
1589
1590
    }
  }

  // Writes a message that the call is uninteresting (i.e. neither
  // explicitly expected nor explicitly unexpected) to the given
  // ostream.
1591
1592
1593
1594
  virtual void UntypedDescribeUninterestingCall(
      const void* untyped_args,
      ::std::ostream* os) const
          GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1595
1596
    const ArgumentTuple& args =
        *static_cast<const ArgumentTuple*>(untyped_args);
1597
1598
1599
    *os << "Uninteresting mock function call - ";
    DescribeDefaultActionTo(args, os);
    *os << "    Function call: " << Name();
vladlosev's avatar
vladlosev committed
1600
    UniversalPrint(args, os);
1601
1602
  }

1603
1604
1605
1606
1607
1608
1609
  // 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.
  //
1610
1611
1612
1613
1614
1615
1616
1617
1618
  // 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.
1619
1620
1621
  virtual const ExpectationBase* UntypedFindMatchingExpectation(
      const void* untyped_args,
      const void** untyped_action, bool* is_excessive,
1622
1623
      ::std::ostream* what, ::std::ostream* why)
          GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1624
1625
    const ArgumentTuple& args =
        *static_cast<const ArgumentTuple*>(untyped_args);
1626
    MutexLock l(&g_gmock_mutex);
1627
1628
    TypedExpectation<F>* exp = this->FindMatchingExpectationLocked(args);
    if (exp == NULL) {  // A match wasn't found.
1629
      this->FormatUnexpectedCallMessageLocked(args, what, why);
1630
      return NULL;
1631
1632
1633
1634
1635
    }

    // This line must be done before calling GetActionForArguments(),
    // which will increment the call count for *exp and thus affect
    // its saturation status.
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
    *is_excessive = exp->IsSaturated();
    const Action<F>* action = exp->GetActionForArguments(this, args, what, why);
    if (action != NULL && action->IsDoDefault())
      action = NULL;  // Normalize "do default" to NULL.
    *untyped_action = action;
    return exp;
  }

  // Prints the given function arguments to the ostream.
  virtual void UntypedPrintArgs(const void* untyped_args,
                                ::std::ostream* os) const {
    const ArgumentTuple& args =
        *static_cast<const ArgumentTuple*>(untyped_args);
    UniversalPrint(args, os);
1650
1651
1652
1653
  }

  // Returns the expectation that matches the arguments, or NULL if no
  // expectation matches them.
1654
  TypedExpectation<F>* FindMatchingExpectationLocked(
1655
1656
      const ArgumentTuple& args) const
          GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1657
    g_gmock_mutex.AssertHeld();
1658
1659
1660
1661
1662
    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());
1663
1664
1665
1666
1667
1668
1669
1670
      if (exp->ShouldHandleArguments(args)) {
        return exp;
      }
    }
    return NULL;
  }

  // Returns a message that the arguments don't match any expectation.
1671
1672
1673
1674
1675
  void FormatUnexpectedCallMessageLocked(
      const ArgumentTuple& args,
      ::std::ostream* os,
      ::std::ostream* why) const
          GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1676
1677
1678
1679
1680
1681
1682
1683
    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.
1684
1685
1686
1687
  void PrintTriedExpectationsLocked(
      const ArgumentTuple& args,
      ::std::ostream* why) const
          GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1688
    g_gmock_mutex.AssertHeld();
1689
    const int count = static_cast<int>(untyped_expectations_.size());
1690
1691
1692
1693
1694
    *why << "Google Mock tried the following " << count << " "
         << (count == 1 ? "expectation, but it didn't match" :
             "expectations, but none matched")
         << ":\n";
    for (int i = 0; i < count; i++) {
1695
1696
      TypedExpectation<F>* const expectation =
          static_cast<TypedExpectation<F>*>(untyped_expectations_[i].get());
1697
      *why << "\n";
1698
      expectation->DescribeLocationTo(why);
1699
      if (count > 1) {
1700
        *why << "tried expectation #" << i << ": ";
1701
      }
1702
1703
1704
      *why << expectation->source_text() << "...\n";
      expectation->ExplainMatchResultTo(args, why);
      expectation->DescribeCallCountTo(why);
1705
1706
1707
1708
1709
1710
1711
    }
  }

  // The current spec (either default action spec or expectation spec)
  // being described on this function mocker.
  MockSpec<F> current_spec_;

1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
  // 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, he should implement his own copy
  // operation, for example:
  //
  //   class MockFoo : public Foo {
  //    public:
  //     // Defines a copy constructor explicitly.
  //     MockFoo(const MockFoo& src) {}
  //     ...
  //   };
  GTEST_DISALLOW_COPY_AND_ASSIGN_(FunctionMockerBase);
1725
1726
1727
};  // class FunctionMockerBase

#ifdef _MSC_VER
1728
# pragma warning(pop)  // Restores the warning state.
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
#endif  // _MSV_VER

// Implements methods of FunctionMockerBase.

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

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

}  // namespace internal

// 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; }

1768
1769
1770
1771
// Constructs an Expectation object that references and co-owns exp.
inline Expectation::Expectation(internal::ExpectationBase& exp)  // NOLINT
    : expectation_base_(exp.GetHandle().expectation_base()) {}

1772
1773
1774
1775
1776
1777
}  // namespace testing

// 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.
1778
#define GMOCK_ON_CALL_IMPL_(obj, call) \
1779
1780
    ((obj).gmock_##call).InternalDefaultActionSetAt(__FILE__, __LINE__, \
                                                    #obj, #call)
1781
#define ON_CALL(obj, call) GMOCK_ON_CALL_IMPL_(obj, call)
1782

1783
#define GMOCK_EXPECT_CALL_IMPL_(obj, call) \
1784
    ((obj).gmock_##call).InternalExpectedAt(__FILE__, __LINE__, #obj, #call)
1785
#define EXPECT_CALL(obj, call) GMOCK_EXPECT_CALL_IMPL_(obj, call)
1786
1787

#endif  // GMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_