gmock-matchers.h 159 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

// Google Mock - a framework for writing C++ mock classes.
//
// This file implements some commonly used argument matchers.  More
// matchers can be defined by the user implementing the
// MatcherInterface<T> interface if necessary.
durandal's avatar
durandal committed
36
37
38
//
// See googletest/include/gtest/gtest-matchers.h for the definition of class
// Matcher, class MatcherInterface, and others.
39

Gennadiy Civil's avatar
 
Gennadiy Civil committed
40
41
// GOOGLETEST_CM0002 DO NOT DELETE

42
43
44
#ifndef GMOCK_INCLUDE_GMOCK_GMOCK_MATCHERS_H_
#define GMOCK_INCLUDE_GMOCK_GMOCK_MATCHERS_H_

45
#include <math.h>
zhanyong.wan's avatar
zhanyong.wan committed
46
#include <algorithm>
Abseil Team's avatar
Abseil Team committed
47
#include <initializer_list>
48
#include <iterator>
49
#include <limits>
misterg's avatar
misterg committed
50
#include <memory>
51
52
53
#include <ostream>  // NOLINT
#include <sstream>
#include <string>
Abseil Team's avatar
Abseil Team committed
54
#include <type_traits>
zhanyong.wan's avatar
zhanyong.wan committed
55
#include <utility>
56
#include <vector>
57
58
#include "gmock/internal/gmock-internal-utils.h"
#include "gmock/internal/gmock-port.h"
misterg's avatar
misterg committed
59
#include "gtest/gtest.h"
60

misterg's avatar
misterg committed
61
62
63
64
GTEST_DISABLE_MSC_WARNINGS_PUSH_(
    4251 5046 /* class A needs to have dll-interface to be used by clients of
                 class B */
    /* Symbol involving type with internal linkage not defined */)
misterg's avatar
misterg committed
65

66
67
68
69
70
71
72
73
74
75
76
77
78
79
namespace testing {

// To implement a matcher Foo for type T, define:
//   1. a class FooMatcherImpl that implements the
//      MatcherInterface<T> interface, and
//   2. a factory function that creates a Matcher<T> object from a
//      FooMatcherImpl*.
//
// The two-level delegation design makes it possible to allow a user
// to write "v" instead of "Eq(v)" where a Matcher is expected, which
// is impossible if we pass matchers by pointers.  It also eases
// ownership management as Matcher objects can now be copied like
// plain values.

80
81
82
83
84
85
// A match result listener that stores the explanation in a string.
class StringMatchResultListener : public MatchResultListener {
 public:
  StringMatchResultListener() : MatchResultListener(&ss_) {}

  // Returns the explanation accumulated so far.
86
  std::string str() const { return ss_.str(); }
87
88
89
90
91
92
93
94
95
96

  // Clears the explanation accumulated so far.
  void Clear() { ss_.str(""); }

 private:
  ::std::stringstream ss_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(StringMatchResultListener);
};

97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
// Anything inside the 'internal' namespace IS INTERNAL IMPLEMENTATION
// and MUST NOT BE USED IN USER CODE!!!
namespace internal {

// The MatcherCastImpl class template is a helper for implementing
// MatcherCast().  We need this helper in order to partially
// specialize the implementation of MatcherCast() (C++ allows
// class/struct templates to be partially specialized, but not
// function templates.).

// This general version is used when MatcherCast()'s argument is a
// polymorphic matcher (i.e. something that can be converted to a
// Matcher but is not one yet; for example, Eq(value)) or a value (for
// example, "hello").
template <typename T, typename M>
class MatcherCastImpl {
 public:
114
  static Matcher<T> Cast(const M& polymorphic_matcher_or_value) {
Gennadiy Civil's avatar
Gennadiy Civil committed
115
    // M can be a polymorphic matcher, in which case we want to use
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
    // its conversion operator to create Matcher<T>.  Or it can be a value
    // that should be passed to the Matcher<T>'s constructor.
    //
    // We can't call Matcher<T>(polymorphic_matcher_or_value) when M is a
    // polymorphic matcher because it'll be ambiguous if T has an implicit
    // constructor from M (this usually happens when T has an implicit
    // constructor from any type).
    //
    // It won't work to unconditionally implict_cast
    // polymorphic_matcher_or_value to Matcher<T> because it won't trigger
    // a user-defined conversion from M to T if one exists (assuming M is
    // a value).
    return CastImpl(
        polymorphic_matcher_or_value,
        BooleanConstant<
Gennadiy Civil's avatar
 
Gennadiy Civil committed
131
132
133
            internal::ImplicitlyConvertible<M, Matcher<T> >::value>(),
        BooleanConstant<
            internal::ImplicitlyConvertible<M, T>::value>());
134
135
136
  }

 private:
Gennadiy Civil's avatar
 
Gennadiy Civil committed
137
  template <bool Ignore>
138
  static Matcher<T> CastImpl(const M& polymorphic_matcher_or_value,
Gennadiy Civil's avatar
 
Gennadiy Civil committed
139
140
                             BooleanConstant<true> /* convertible_to_matcher */,
                             BooleanConstant<Ignore>) {
141
    // M is implicitly convertible to Matcher<T>, which means that either
Gennadiy Civil's avatar
 
Gennadiy Civil committed
142
    // M is a polymorphic matcher or Matcher<T> has an implicit constructor
143
144
145
146
147
148
149
150
    // from M.  In both cases using the implicit conversion will produce a
    // matcher.
    //
    // Even if T has an implicit constructor from M, it won't be called because
    // creating Matcher<T> would require a chain of two user-defined conversions
    // (first to create T from M and then to create Matcher<T> from T).
    return polymorphic_matcher_or_value;
  }
Gennadiy Civil's avatar
 
Gennadiy Civil committed
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

  // M can't be implicitly converted to Matcher<T>, so M isn't a polymorphic
  // matcher. It's a value of a type implicitly convertible to T. Use direct
  // initialization to create a matcher.
  static Matcher<T> CastImpl(
      const M& value, BooleanConstant<false> /* convertible_to_matcher */,
      BooleanConstant<true> /* convertible_to_T */) {
    return Matcher<T>(ImplicitCast_<T>(value));
  }

  // M can't be implicitly converted to either Matcher<T> or T. Attempt to use
  // polymorphic matcher Eq(value) in this case.
  //
  // Note that we first attempt to perform an implicit cast on the value and
  // only fall back to the polymorphic Eq() matcher afterwards because the
  // latter calls bool operator==(const Lhs& lhs, const Rhs& rhs) in the end
  // which might be undefined even when Rhs is implicitly convertible to Lhs
  // (e.g. std::pair<const int, int> vs. std::pair<int, int>).
  //
  // We don't define this method inline as we need the declaration of Eq().
  static Matcher<T> CastImpl(
      const M& value, BooleanConstant<false> /* convertible_to_matcher */,
      BooleanConstant<false> /* convertible_to_T */);
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
};

// This more specialized version is used when MatcherCast()'s argument
// is already a Matcher.  This only compiles when type T can be
// statically converted to type U.
template <typename T, typename U>
class MatcherCastImpl<T, Matcher<U> > {
 public:
  static Matcher<T> Cast(const Matcher<U>& source_matcher) {
    return Matcher<T>(new Impl(source_matcher));
  }

 private:
  class Impl : public MatcherInterface<T> {
   public:
    explicit Impl(const Matcher<U>& source_matcher)
        : source_matcher_(source_matcher) {}

    // We delegate the matching logic to the source matcher.
Abseil Team's avatar
Abseil Team committed
193
    bool MatchAndExplain(T x, MatchResultListener* listener) const override {
Gennadiy Civil's avatar
Gennadiy Civil committed
194
195
196
197
198
199
200
201
202
203
204
205
206
207
      using FromType = typename std::remove_cv<typename std::remove_pointer<
          typename std::remove_reference<T>::type>::type>::type;
      using ToType = typename std::remove_cv<typename std::remove_pointer<
          typename std::remove_reference<U>::type>::type>::type;
      // Do not allow implicitly converting base*/& to derived*/&.
      static_assert(
          // Do not trigger if only one of them is a pointer. That implies a
          // regular conversion and not a down_cast.
          (std::is_pointer<typename std::remove_reference<T>::type>::value !=
           std::is_pointer<typename std::remove_reference<U>::type>::value) ||
              std::is_same<FromType, ToType>::value ||
              !std::is_base_of<FromType, ToType>::value,
          "Can't implicitly convert from <base> to <derived>");

208
209
210
      return source_matcher_.MatchAndExplain(static_cast<U>(x), listener);
    }

Abseil Team's avatar
Abseil Team committed
211
    void DescribeTo(::std::ostream* os) const override {
212
213
214
      source_matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
215
    void DescribeNegationTo(::std::ostream* os) const override {
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
      source_matcher_.DescribeNegationTo(os);
    }

   private:
    const Matcher<U> source_matcher_;

    GTEST_DISALLOW_ASSIGN_(Impl);
  };
};

// This even more specialized version is used for efficiently casting
// a matcher to its own type.
template <typename T>
class MatcherCastImpl<T, Matcher<T> > {
 public:
  static Matcher<T> Cast(const Matcher<T>& matcher) { return matcher; }
};

}  // namespace internal

236
237
238
239
240
// In order to be safe and clear, casting between different matcher
// types is done explicitly via MatcherCast<T>(m), which takes a
// matcher m and returns a Matcher<T>.  It compiles only when T can be
// statically converted to the argument type of m.
template <typename T, typename M>
241
inline Matcher<T> MatcherCast(const M& matcher) {
242
243
  return internal::MatcherCastImpl<T, M>::Cast(matcher);
}
244

245
246
// Implements SafeMatcherCast().
//
Abseil Team's avatar
Abseil Team committed
247
248
// FIXME: The intermediate SafeMatcherCastImpl class was introduced as a
// workaround for a compiler bug, and can now be removed.
249
250
251
template <typename T>
class SafeMatcherCastImpl {
 public:
252
253
  // This overload handles polymorphic matchers and values only since
  // monomorphic matchers are handled by the next one.
254
  template <typename M>
255
  static inline Matcher<T> Cast(const M& polymorphic_matcher_or_value) {
256
    return internal::MatcherCastImpl<T, M>::Cast(polymorphic_matcher_or_value);
257
  }
258

259
260
261
262
263
264
265
266
267
268
269
270
  // This overload handles monomorphic matchers.
  //
  // In general, if type T can be implicitly converted to type U, we can
  // safely convert a Matcher<U> to a Matcher<T> (i.e. Matcher is
  // contravariant): just keep a copy of the original Matcher<U>, convert the
  // argument from type T to U, and then pass it to the underlying Matcher<U>.
  // The only exception is when U is a reference and T is not, as the
  // underlying Matcher<U> may be interested in the argument's address, which
  // is not preserved in the conversion from T to U.
  template <typename U>
  static inline Matcher<T> Cast(const Matcher<U>& matcher) {
    // Enforce that T can be implicitly converted to U.
271
    GTEST_COMPILE_ASSERT_((internal::ImplicitlyConvertible<T, U>::value),
272
273
274
                          T_must_be_implicitly_convertible_to_U);
    // Enforce that we are not converting a non-reference type T to a reference
    // type U.
275
    GTEST_COMPILE_ASSERT_(
276
        internal::is_reference<T>::value || !internal::is_reference<U>::value,
277
        cannot_convert_non_reference_arg_to_reference);
278
279
    // In case both T and U are arithmetic types, enforce that the
    // conversion is not lossy.
zhanyong.wan's avatar
zhanyong.wan committed
280
281
    typedef GTEST_REMOVE_REFERENCE_AND_CONST_(T) RawT;
    typedef GTEST_REMOVE_REFERENCE_AND_CONST_(U) RawU;
282
283
    const bool kTIsOther = GMOCK_KIND_OF_(RawT) == internal::kOther;
    const bool kUIsOther = GMOCK_KIND_OF_(RawU) == internal::kOther;
284
    GTEST_COMPILE_ASSERT_(
285
286
287
288
289
290
291
292
293
294
        kTIsOther || kUIsOther ||
        (internal::LosslessArithmeticConvertible<RawT, RawU>::value),
        conversion_of_arithmetic_types_must_be_lossless);
    return MatcherCast<T>(matcher);
  }
};

template <typename T, typename M>
inline Matcher<T> SafeMatcherCast(const M& polymorphic_matcher) {
  return SafeMatcherCastImpl<T>::Cast(polymorphic_matcher);
295
296
}

297
298
299
300
301
302
303
304
// A<T>() returns a matcher that matches any value of type T.
template <typename T>
Matcher<T> A();

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

305
// If the explanation is not empty, prints it to the ostream.
306
inline void PrintIfNotEmpty(const std::string& explanation,
307
                            ::std::ostream* os) {
308
  if (explanation != "" && os != nullptr) {
309
    *os << ", " << explanation;
310
311
312
  }
}

313
314
315
// Returns true if the given type name is easy to read by a human.
// This is used to decide whether printing the type of a value might
// be helpful.
316
inline bool IsReadableTypeName(const std::string& type_name) {
317
318
319
  // We consider a type name readable if it's short or doesn't contain
  // a template or function type.
  return (type_name.length() <= 20 ||
320
          type_name.find_first_of("<(") == std::string::npos);
321
322
}

323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
// Matches the value against the given matcher, prints the value and explains
// the match result to the listener. Returns the match result.
// 'listener' must not be NULL.
// Value cannot be passed by const reference, because some matchers take a
// non-const argument.
template <typename Value, typename T>
bool MatchPrintAndExplain(Value& value, const Matcher<T>& matcher,
                          MatchResultListener* listener) {
  if (!listener->IsInterested()) {
    // If the listener is not interested, we do not need to construct the
    // inner explanation.
    return matcher.Matches(value);
  }

  StringMatchResultListener inner_listener;
  const bool match = matcher.MatchAndExplain(value, &inner_listener);

  UniversalPrint(value, listener->stream());
341
#if GTEST_HAS_RTTI
342
  const std::string& type_name = GetTypeName<Value>();
343
344
345
  if (IsReadableTypeName(type_name))
    *listener->stream() << " (of type " << type_name << ")";
#endif
346
  PrintIfNotEmpty(inner_listener.str(), listener->stream());
347
348
349
350

  return match;
}

351
352
353
354
355
356
357
358
359
360
361
// An internal helper class for doing compile-time loop on a tuple's
// fields.
template <size_t N>
class TuplePrefix {
 public:
  // TuplePrefix<N>::Matches(matcher_tuple, value_tuple) returns true
  // iff the first N fields of matcher_tuple matches the first N
  // fields of value_tuple, respectively.
  template <typename MatcherTuple, typename ValueTuple>
  static bool Matches(const MatcherTuple& matcher_tuple,
                      const ValueTuple& value_tuple) {
Abseil Team's avatar
Abseil Team committed
362
363
    return TuplePrefix<N - 1>::Matches(matcher_tuple, value_tuple) &&
           std::get<N - 1>(matcher_tuple).Matches(std::get<N - 1>(value_tuple));
364
365
  }

366
  // TuplePrefix<N>::ExplainMatchFailuresTo(matchers, values, os)
367
368
369
370
  // describes failures in matching the first N fields of matchers
  // against the first N fields of values.  If there is no failure,
  // nothing will be streamed to os.
  template <typename MatcherTuple, typename ValueTuple>
371
372
373
  static void ExplainMatchFailuresTo(const MatcherTuple& matchers,
                                     const ValueTuple& values,
                                     ::std::ostream* os) {
374
    // First, describes failures in the first N - 1 fields.
375
    TuplePrefix<N - 1>::ExplainMatchFailuresTo(matchers, values, os);
376
377
378

    // Then describes the failure (if any) in the (N - 1)-th (0-based)
    // field.
Abseil Team's avatar
Abseil Team committed
379
380
381
    typename std::tuple_element<N - 1, MatcherTuple>::type matcher =
        std::get<N - 1>(matchers);
    typedef typename std::tuple_element<N - 1, ValueTuple>::type Value;
Abseil Team's avatar
Abseil Team committed
382
    const Value& value = std::get<N - 1>(values);
zhanyong.wan's avatar
zhanyong.wan committed
383
384
    StringMatchResultListener listener;
    if (!matcher.MatchAndExplain(value, &listener)) {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
385
      // FIXME: include in the message the name of the parameter
386
387
      // as used in MOCK_METHOD*() when possible.
      *os << "  Expected arg #" << N - 1 << ": ";
Abseil Team's avatar
Abseil Team committed
388
      std::get<N - 1>(matchers).DescribeTo(os);
389
390
391
392
      *os << "\n           Actual: ";
      // We remove the reference in type Value to prevent the
      // universal printer from printing the address of value, which
      // isn't interesting to the user most of the time.  The
393
      // matcher's MatchAndExplain() method handles the case when
394
      // the address is interesting.
395
396
      internal::UniversalPrint(value, os);
      PrintIfNotEmpty(listener.str(), os);
397
398
399
400
401
402
403
404
405
406
      *os << "\n";
    }
  }
};

// The base case.
template <>
class TuplePrefix<0> {
 public:
  template <typename MatcherTuple, typename ValueTuple>
407
408
  static bool Matches(const MatcherTuple& /* matcher_tuple */,
                      const ValueTuple& /* value_tuple */) {
409
410
411
412
    return true;
  }

  template <typename MatcherTuple, typename ValueTuple>
413
414
415
  static void ExplainMatchFailuresTo(const MatcherTuple& /* matchers */,
                                     const ValueTuple& /* values */,
                                     ::std::ostream* /* os */) {}
416
417
418
419
420
421
422
423
424
425
426
427
};

// TupleMatches(matcher_tuple, value_tuple) returns true iff all
// matchers in matcher_tuple match the corresponding fields in
// value_tuple.  It is a compiler error if matcher_tuple and
// value_tuple have different number of fields or incompatible field
// types.
template <typename MatcherTuple, typename ValueTuple>
bool TupleMatches(const MatcherTuple& matcher_tuple,
                  const ValueTuple& value_tuple) {
  // Makes sure that matcher_tuple and value_tuple have the same
  // number of fields.
Abseil Team's avatar
Abseil Team committed
428
429
  GTEST_COMPILE_ASSERT_(std::tuple_size<MatcherTuple>::value ==
                            std::tuple_size<ValueTuple>::value,
430
                        matcher_and_value_have_different_numbers_of_fields);
Abseil Team's avatar
Abseil Team committed
431
432
  return TuplePrefix<std::tuple_size<ValueTuple>::value>::Matches(matcher_tuple,
                                                                  value_tuple);
433
434
435
436
437
}

// Describes failures in matching matchers against values.  If there
// is no failure, nothing will be streamed to os.
template <typename MatcherTuple, typename ValueTuple>
438
439
440
void ExplainMatchFailureTupleTo(const MatcherTuple& matchers,
                                const ValueTuple& values,
                                ::std::ostream* os) {
Abseil Team's avatar
Abseil Team committed
441
  TuplePrefix<std::tuple_size<MatcherTuple>::value>::ExplainMatchFailuresTo(
442
443
444
      matchers, values, os);
}

445
446
447
448
449
450
451
// TransformTupleValues and its helper.
//
// TransformTupleValuesHelper hides the internal machinery that
// TransformTupleValues uses to implement a tuple traversal.
template <typename Tuple, typename Func, typename OutIter>
class TransformTupleValuesHelper {
 private:
Abseil Team's avatar
Abseil Team committed
452
  typedef ::std::tuple_size<Tuple> TupleSize;
453
454
455
456
457
458
459
460
461
462
463
464

 public:
  // For each member of tuple 't', taken in order, evaluates '*out++ = f(t)'.
  // Returns the final value of 'out' in case the caller needs it.
  static OutIter Run(Func f, const Tuple& t, OutIter out) {
    return IterateOverTuple<Tuple, TupleSize::value>()(f, t, out);
  }

 private:
  template <typename Tup, size_t kRemainingSize>
  struct IterateOverTuple {
    OutIter operator() (Func f, const Tup& t, OutIter out) const {
Abseil Team's avatar
Abseil Team committed
465
      *out++ = f(::std::get<TupleSize::value - kRemainingSize>(t));
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
      return IterateOverTuple<Tup, kRemainingSize - 1>()(f, t, out);
    }
  };
  template <typename Tup>
  struct IterateOverTuple<Tup, 0> {
    OutIter operator() (Func /* f */, const Tup& /* t */, OutIter out) const {
      return out;
    }
  };
};

// Successively invokes 'f(element)' on each element of the tuple 't',
// appending each result to the 'out' iterator. Returns the final value
// of 'out'.
template <typename Tuple, typename Func, typename OutIter>
OutIter TransformTupleValues(Func f, const Tuple& t, OutIter out) {
  return TransformTupleValuesHelper<Tuple, Func, OutIter>::Run(f, t, out);
}

485
486
// Implements A<T>().
template <typename T>
Abseil Team's avatar
Abseil Team committed
487
class AnyMatcherImpl : public MatcherInterface<const T&> {
488
 public:
Abseil Team's avatar
Abseil Team committed
489
  bool MatchAndExplain(const T& /* x */,
Abseil Team's avatar
Abseil Team committed
490
                       MatchResultListener* /* listener */) const override {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
491
492
    return true;
  }
Abseil Team's avatar
Abseil Team committed
493
494
  void DescribeTo(::std::ostream* os) const override { *os << "is anything"; }
  void DescribeNegationTo(::std::ostream* os) const override {
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
    // This is mostly for completeness' safe, as it's not very useful
    // to write Not(A<bool>()).  However we cannot completely rule out
    // such a possibility, and it doesn't hurt to be prepared.
    *os << "never matches";
  }
};

// Implements _, a matcher that matches any value of any
// type.  This is a polymorphic matcher, so we need a template type
// conversion operator to make it appearing as a Matcher<T> for any
// type T.
class AnythingMatcher {
 public:
  template <typename T>
  operator Matcher<T>() const { return A<T>(); }
};

512
// Implements the polymorphic IsNull() matcher, which matches any raw or smart
zhanyong.wan's avatar
zhanyong.wan committed
513
514
515
// pointer that is NULL.
class IsNullMatcher {
 public:
516
  template <typename Pointer>
517
518
  bool MatchAndExplain(const Pointer& p,
                       MatchResultListener* /* listener */) const {
519
    return p == nullptr;
520
  }
zhanyong.wan's avatar
zhanyong.wan committed
521
522
523

  void DescribeTo(::std::ostream* os) const { *os << "is NULL"; }
  void DescribeNegationTo(::std::ostream* os) const {
524
    *os << "isn't NULL";
zhanyong.wan's avatar
zhanyong.wan committed
525
526
527
  }
};

528
// Implements the polymorphic NotNull() matcher, which matches any raw or smart
529
530
531
// pointer that is not NULL.
class NotNullMatcher {
 public:
532
  template <typename Pointer>
533
534
  bool MatchAndExplain(const Pointer& p,
                       MatchResultListener* /* listener */) const {
535
    return p != nullptr;
536
  }
537

538
  void DescribeTo(::std::ostream* os) const { *os << "isn't NULL"; }
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
  void DescribeNegationTo(::std::ostream* os) const {
    *os << "is NULL";
  }
};

// Ref(variable) matches any argument that is a reference to
// 'variable'.  This matcher is polymorphic as it can match any
// super type of the type of 'variable'.
//
// The RefMatcher template class implements Ref(variable).  It can
// only be instantiated with a reference type.  This prevents a user
// from mistakenly using Ref(x) to match a non-reference function
// argument.  For example, the following will righteously cause a
// compiler error:
//
//   int n;
//   Matcher<int> m1 = Ref(n);   // This won't compile.
//   Matcher<int&> m2 = Ref(n);  // This will compile.
template <typename T>
class RefMatcher;

template <typename T>
class RefMatcher<T&> {
  // Google Mock is a generic framework and thus needs to support
  // mocking any function types, including those that take non-const
  // reference arguments.  Therefore the template parameter T (and
  // Super below) can be instantiated to either a const type or a
  // non-const type.
 public:
  // RefMatcher() takes a T& instead of const T&, as we want the
  // compiler to catch using Ref(const_value) as a matcher for a
  // non-const reference.
  explicit RefMatcher(T& x) : object_(x) {}  // NOLINT

  template <typename Super>
  operator Matcher<Super&>() const {
    // By passing object_ (type T&) to Impl(), which expects a Super&,
    // we make sure that Super is a super type of T.  In particular,
    // this catches using Ref(const_value) as a matcher for a
    // non-const reference, as you cannot implicitly convert a const
    // reference to a non-const reference.
    return MakeMatcher(new Impl<Super>(object_));
  }
582

583
584
585
586
587
588
 private:
  template <typename Super>
  class Impl : public MatcherInterface<Super&> {
   public:
    explicit Impl(Super& x) : object_(x) {}  // NOLINT

589
590
    // MatchAndExplain() takes a Super& (as opposed to const Super&)
    // in order to match the interface MatcherInterface<Super&>.
Abseil Team's avatar
Abseil Team committed
591
592
    bool MatchAndExplain(Super& x,
                         MatchResultListener* listener) const override {
593
      *listener << "which is located @" << static_cast<const void*>(&x);
zhanyong.wan's avatar
zhanyong.wan committed
594
595
      return &x == &object_;
    }
596

Abseil Team's avatar
Abseil Team committed
597
    void DescribeTo(::std::ostream* os) const override {
598
599
600
601
      *os << "references the variable ";
      UniversalPrinter<Super&>::Print(object_, os);
    }

Abseil Team's avatar
Abseil Team committed
602
    void DescribeNegationTo(::std::ostream* os) const override {
603
604
605
606
607
608
      *os << "does not reference the variable ";
      UniversalPrinter<Super&>::Print(object_, os);
    }

   private:
    const Super& object_;
609
610

    GTEST_DISALLOW_ASSIGN_(Impl);
611
612
613
  };

  T& object_;
614
615

  GTEST_DISALLOW_ASSIGN_(RefMatcher);
616
617
618
619
620
621
622
623
624
625
626
627
628
629
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
656
657
658
659
660
};

// Polymorphic helper functions for narrow and wide string matchers.
inline bool CaseInsensitiveCStringEquals(const char* lhs, const char* rhs) {
  return String::CaseInsensitiveCStringEquals(lhs, rhs);
}

inline bool CaseInsensitiveCStringEquals(const wchar_t* lhs,
                                         const wchar_t* rhs) {
  return String::CaseInsensitiveWideCStringEquals(lhs, rhs);
}

// String comparison for narrow or wide strings that can have embedded NUL
// characters.
template <typename StringType>
bool CaseInsensitiveStringEquals(const StringType& s1,
                                 const StringType& s2) {
  // Are the heads equal?
  if (!CaseInsensitiveCStringEquals(s1.c_str(), s2.c_str())) {
    return false;
  }

  // Skip the equal heads.
  const typename StringType::value_type nul = 0;
  const size_t i1 = s1.find(nul), i2 = s2.find(nul);

  // Are we at the end of either s1 or s2?
  if (i1 == StringType::npos || i2 == StringType::npos) {
    return i1 == i2;
  }

  // Are the tails equal?
  return CaseInsensitiveStringEquals(s1.substr(i1 + 1), s2.substr(i2 + 1));
}

// String matchers.

// Implements equality-based string matchers like StrEq, StrCaseNe, and etc.
template <typename StringType>
class StrEqualityMatcher {
 public:
  StrEqualityMatcher(const StringType& str, bool expect_eq,
                     bool case_sensitive)
      : string_(str), expect_eq_(expect_eq), case_sensitive_(case_sensitive) {}

Gennadiy Civil's avatar
 
Gennadiy Civil committed
661
662
663
664
665
666
667
668
669
670
#if GTEST_HAS_ABSL
  bool MatchAndExplain(const absl::string_view& s,
                       MatchResultListener* listener) const {
    // This should fail to compile if absl::string_view is used with wide
    // strings.
    const StringType& str = string(s);
    return MatchAndExplain(str, listener);
  }
#endif  // GTEST_HAS_ABSL

671
672
673
674
675
676
677
  // Accepts pointer types, particularly:
  //   const char*
  //   char*
  //   const wchar_t*
  //   wchar_t*
  template <typename CharType>
  bool MatchAndExplain(CharType* s, MatchResultListener* listener) const {
678
    if (s == nullptr) {
679
680
      return !expect_eq_;
    }
681
    return MatchAndExplain(StringType(s), listener);
682
683
  }

684
685
686
  // Matches anything that can convert to StringType.
  //
  // This is a template, not just a plain function with const StringType&,
Gennadiy Civil's avatar
 
Gennadiy Civil committed
687
  // because absl::string_view has some interfering non-explicit constructors.
688
689
  template <typename MatcheeStringType>
  bool MatchAndExplain(const MatcheeStringType& s,
690
                       MatchResultListener* /* listener */) const {
691
692
693
    const StringType& s2(s);
    const bool eq = case_sensitive_ ? s2 == string_ :
        CaseInsensitiveStringEquals(s2, string_);
694
695
696
697
698
699
700
701
702
703
    return expect_eq_ == eq;
  }

  void DescribeTo(::std::ostream* os) const {
    DescribeToHelper(expect_eq_, os);
  }

  void DescribeNegationTo(::std::ostream* os) const {
    DescribeToHelper(!expect_eq_, os);
  }
704

705
706
 private:
  void DescribeToHelper(bool expect_eq, ::std::ostream* os) const {
707
    *os << (expect_eq ? "is " : "isn't ");
708
709
710
711
    *os << "equal to ";
    if (!case_sensitive_) {
      *os << "(ignoring case) ";
    }
vladlosev's avatar
vladlosev committed
712
    UniversalPrint(string_, os);
713
714
715
716
717
  }

  const StringType string_;
  const bool expect_eq_;
  const bool case_sensitive_;
718
719

  GTEST_DISALLOW_ASSIGN_(StrEqualityMatcher);
720
721
722
723
724
725
726
727
728
729
730
};

// Implements the polymorphic HasSubstr(substring) matcher, which
// can be used as a Matcher<T> as long as T can be converted to a
// string.
template <typename StringType>
class HasSubstrMatcher {
 public:
  explicit HasSubstrMatcher(const StringType& substring)
      : substring_(substring) {}

Gennadiy Civil's avatar
 
Gennadiy Civil committed
731
732
733
734
735
736
737
738
739
740
#if GTEST_HAS_ABSL
  bool MatchAndExplain(const absl::string_view& s,
                       MatchResultListener* listener) const {
    // This should fail to compile if absl::string_view is used with wide
    // strings.
    const StringType& str = string(s);
    return MatchAndExplain(str, listener);
  }
#endif  // GTEST_HAS_ABSL

741
742
743
744
745
746
747
  // Accepts pointer types, particularly:
  //   const char*
  //   char*
  //   const wchar_t*
  //   wchar_t*
  template <typename CharType>
  bool MatchAndExplain(CharType* s, MatchResultListener* listener) const {
748
    return s != nullptr && MatchAndExplain(StringType(s), listener);
749
750
  }

751
752
753
  // Matches anything that can convert to StringType.
  //
  // This is a template, not just a plain function with const StringType&,
Gennadiy Civil's avatar
 
Gennadiy Civil committed
754
  // because absl::string_view has some interfering non-explicit constructors.
755
756
  template <typename MatcheeStringType>
  bool MatchAndExplain(const MatcheeStringType& s,
757
                       MatchResultListener* /* listener */) const {
758
759
    const StringType& s2(s);
    return s2.find(substring_) != StringType::npos;
760
761
762
763
764
  }

  // Describes what this matcher matches.
  void DescribeTo(::std::ostream* os) const {
    *os << "has substring ";
vladlosev's avatar
vladlosev committed
765
    UniversalPrint(substring_, os);
766
767
768
769
  }

  void DescribeNegationTo(::std::ostream* os) const {
    *os << "has no substring ";
vladlosev's avatar
vladlosev committed
770
    UniversalPrint(substring_, os);
771
  }
772

773
774
 private:
  const StringType substring_;
775
776

  GTEST_DISALLOW_ASSIGN_(HasSubstrMatcher);
777
778
779
780
781
782
783
784
785
786
787
};

// Implements the polymorphic StartsWith(substring) matcher, which
// can be used as a Matcher<T> as long as T can be converted to a
// string.
template <typename StringType>
class StartsWithMatcher {
 public:
  explicit StartsWithMatcher(const StringType& prefix) : prefix_(prefix) {
  }

Gennadiy Civil's avatar
 
Gennadiy Civil committed
788
789
790
791
792
793
794
795
796
797
#if GTEST_HAS_ABSL
  bool MatchAndExplain(const absl::string_view& s,
                       MatchResultListener* listener) const {
    // This should fail to compile if absl::string_view is used with wide
    // strings.
    const StringType& str = string(s);
    return MatchAndExplain(str, listener);
  }
#endif  // GTEST_HAS_ABSL

798
799
800
801
802
803
804
  // Accepts pointer types, particularly:
  //   const char*
  //   char*
  //   const wchar_t*
  //   wchar_t*
  template <typename CharType>
  bool MatchAndExplain(CharType* s, MatchResultListener* listener) const {
805
    return s != nullptr && MatchAndExplain(StringType(s), listener);
806
807
  }

808
809
810
  // Matches anything that can convert to StringType.
  //
  // This is a template, not just a plain function with const StringType&,
Gennadiy Civil's avatar
 
Gennadiy Civil committed
811
  // because absl::string_view has some interfering non-explicit constructors.
812
813
  template <typename MatcheeStringType>
  bool MatchAndExplain(const MatcheeStringType& s,
814
                       MatchResultListener* /* listener */) const {
815
816
817
    const StringType& s2(s);
    return s2.length() >= prefix_.length() &&
        s2.substr(0, prefix_.length()) == prefix_;
818
819
820
821
  }

  void DescribeTo(::std::ostream* os) const {
    *os << "starts with ";
vladlosev's avatar
vladlosev committed
822
    UniversalPrint(prefix_, os);
823
824
825
826
  }

  void DescribeNegationTo(::std::ostream* os) const {
    *os << "doesn't start with ";
vladlosev's avatar
vladlosev committed
827
    UniversalPrint(prefix_, os);
828
  }
829

830
831
 private:
  const StringType prefix_;
832
833

  GTEST_DISALLOW_ASSIGN_(StartsWithMatcher);
834
835
836
837
838
839
840
841
842
843
};

// Implements the polymorphic EndsWith(substring) matcher, which
// can be used as a Matcher<T> as long as T can be converted to a
// string.
template <typename StringType>
class EndsWithMatcher {
 public:
  explicit EndsWithMatcher(const StringType& suffix) : suffix_(suffix) {}

Gennadiy Civil's avatar
 
Gennadiy Civil committed
844
845
846
847
848
849
850
851
852
853
#if GTEST_HAS_ABSL
  bool MatchAndExplain(const absl::string_view& s,
                       MatchResultListener* listener) const {
    // This should fail to compile if absl::string_view is used with wide
    // strings.
    const StringType& str = string(s);
    return MatchAndExplain(str, listener);
  }
#endif  // GTEST_HAS_ABSL

854
855
856
857
858
859
860
  // Accepts pointer types, particularly:
  //   const char*
  //   char*
  //   const wchar_t*
  //   wchar_t*
  template <typename CharType>
  bool MatchAndExplain(CharType* s, MatchResultListener* listener) const {
861
    return s != nullptr && MatchAndExplain(StringType(s), listener);
862
863
  }

864
865
866
  // Matches anything that can convert to StringType.
  //
  // This is a template, not just a plain function with const StringType&,
Gennadiy Civil's avatar
 
Gennadiy Civil committed
867
  // because absl::string_view has some interfering non-explicit constructors.
868
869
  template <typename MatcheeStringType>
  bool MatchAndExplain(const MatcheeStringType& s,
870
                       MatchResultListener* /* listener */) const {
871
872
873
    const StringType& s2(s);
    return s2.length() >= suffix_.length() &&
        s2.substr(s2.length() - suffix_.length()) == suffix_;
874
875
876
877
  }

  void DescribeTo(::std::ostream* os) const {
    *os << "ends with ";
vladlosev's avatar
vladlosev committed
878
    UniversalPrint(suffix_, os);
879
880
881
882
  }

  void DescribeNegationTo(::std::ostream* os) const {
    *os << "doesn't end with ";
vladlosev's avatar
vladlosev committed
883
    UniversalPrint(suffix_, os);
884
  }
885

886
887
 private:
  const StringType suffix_;
888
889

  GTEST_DISALLOW_ASSIGN_(EndsWithMatcher);
890
891
892
893
894
895
896
};

// Implements a matcher that compares the two fields of a 2-tuple
// using one of the ==, <=, <, etc, operators.  The two fields being
// compared don't have to have the same type.
//
// The matcher defined here is polymorphic (for example, Eq() can be
Abseil Team's avatar
Abseil Team committed
897
// used to match a std::tuple<int, short>, a std::tuple<const long&, double>,
898
899
// etc).  Therefore we use a template type conversion operator in the
// implementation.
900
901
902
903
template <typename D, typename Op>
class PairMatchBase {
 public:
  template <typename T1, typename T2>
Abseil Team's avatar
Abseil Team committed
904
905
  operator Matcher<::std::tuple<T1, T2>>() const {
    return MakeMatcher(new Impl<::std::tuple<T1, T2>>);
906
907
  }
  template <typename T1, typename T2>
Abseil Team's avatar
Abseil Team committed
908
909
  operator Matcher<const ::std::tuple<T1, T2>&>() const {
    return MakeMatcher(new Impl<const ::std::tuple<T1, T2>&>);
910
911
912
913
914
  }

 private:
  static ::std::ostream& GetDesc(::std::ostream& os) {  // NOLINT
    return os << D::Desc();
915
916
  }

917
918
919
  template <typename Tuple>
  class Impl : public MatcherInterface<Tuple> {
   public:
Abseil Team's avatar
Abseil Team committed
920
921
    bool MatchAndExplain(Tuple args,
                         MatchResultListener* /* listener */) const override {
Abseil Team's avatar
Abseil Team committed
922
      return Op()(::std::get<0>(args), ::std::get<1>(args));
923
    }
Abseil Team's avatar
Abseil Team committed
924
    void DescribeTo(::std::ostream* os) const override {
925
926
      *os << "are " << GetDesc;
    }
Abseil Team's avatar
Abseil Team committed
927
    void DescribeNegationTo(::std::ostream* os) const override {
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
      *os << "aren't " << GetDesc;
    }
  };
};

class Eq2Matcher : public PairMatchBase<Eq2Matcher, AnyEq> {
 public:
  static const char* Desc() { return "an equal pair"; }
};
class Ne2Matcher : public PairMatchBase<Ne2Matcher, AnyNe> {
 public:
  static const char* Desc() { return "an unequal pair"; }
};
class Lt2Matcher : public PairMatchBase<Lt2Matcher, AnyLt> {
 public:
  static const char* Desc() { return "a pair where the first < the second"; }
};
class Gt2Matcher : public PairMatchBase<Gt2Matcher, AnyGt> {
 public:
  static const char* Desc() { return "a pair where the first > the second"; }
};
class Le2Matcher : public PairMatchBase<Le2Matcher, AnyLe> {
 public:
  static const char* Desc() { return "a pair where the first <= the second"; }
};
class Ge2Matcher : public PairMatchBase<Ge2Matcher, AnyGe> {
 public:
  static const char* Desc() { return "a pair where the first >= the second"; }
};
957

958
959
960
961
962
// Implements the Not(...) matcher for a particular argument type T.
// We do not nest it inside the NotMatcher class template, as that
// will prevent different instantiations of NotMatcher from sharing
// the same NotMatcherImpl<T> class.
template <typename T>
Abseil Team's avatar
Abseil Team committed
963
class NotMatcherImpl : public MatcherInterface<const T&> {
964
965
966
967
 public:
  explicit NotMatcherImpl(const Matcher<T>& matcher)
      : matcher_(matcher) {}

Abseil Team's avatar
Abseil Team committed
968
  bool MatchAndExplain(const T& x,
Abseil Team's avatar
Abseil Team committed
969
                       MatchResultListener* listener) const override {
zhanyong.wan's avatar
zhanyong.wan committed
970
    return !matcher_.MatchAndExplain(x, listener);
971
972
  }

Abseil Team's avatar
Abseil Team committed
973
  void DescribeTo(::std::ostream* os) const override {
974
975
976
    matcher_.DescribeNegationTo(os);
  }

Abseil Team's avatar
Abseil Team committed
977
  void DescribeNegationTo(::std::ostream* os) const override {
978
979
980
981
982
    matcher_.DescribeTo(os);
  }

 private:
  const Matcher<T> matcher_;
983
984

  GTEST_DISALLOW_ASSIGN_(NotMatcherImpl);
985
986
};

987
988
989
990
991
992
993
994
995
996
997
// Implements the Not(m) matcher, which matches a value that doesn't
// match matcher m.
template <typename InnerMatcher>
class NotMatcher {
 public:
  explicit NotMatcher(InnerMatcher matcher) : matcher_(matcher) {}

  // This template type conversion operator allows Not(m) to be used
  // to match any type m can match.
  template <typename T>
  operator Matcher<T>() const {
998
    return Matcher<T>(new NotMatcherImpl<T>(SafeMatcherCast<T>(matcher_)));
999
  }
1000

1001
 private:
1002
  InnerMatcher matcher_;
1003
1004

  GTEST_DISALLOW_ASSIGN_(NotMatcher);
1005
};
1006

1007
1008
1009
1010
1011
// Implements the AllOf(m1, m2) matcher for a particular argument type
// T. We do not nest it inside the BothOfMatcher class template, as
// that will prevent different instantiations of BothOfMatcher from
// sharing the same BothOfMatcherImpl<T> class.
template <typename T>
Abseil Team's avatar
Abseil Team committed
1012
class AllOfMatcherImpl : public MatcherInterface<const T&> {
1013
 public:
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1014
  explicit AllOfMatcherImpl(std::vector<Matcher<T> > matchers)
Abseil Team's avatar
Abseil Team committed
1015
      : matchers_(std::move(matchers)) {}
1016

Abseil Team's avatar
Abseil Team committed
1017
  void DescribeTo(::std::ostream* os) const override {
1018
    *os << "(";
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1019
1020
1021
1022
    for (size_t i = 0; i < matchers_.size(); ++i) {
      if (i != 0) *os << ") and (";
      matchers_[i].DescribeTo(os);
    }
1023
1024
    *os << ")";
  }
1025

Abseil Team's avatar
Abseil Team committed
1026
  void DescribeNegationTo(::std::ostream* os) const override {
1027
    *os << "(";
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1028
1029
1030
1031
    for (size_t i = 0; i < matchers_.size(); ++i) {
      if (i != 0) *os << ") or (";
      matchers_[i].DescribeNegationTo(os);
    }
1032
    *os << ")";
1033
  }
1034

Abseil Team's avatar
Abseil Team committed
1035
  bool MatchAndExplain(const T& x,
Abseil Team's avatar
Abseil Team committed
1036
                       MatchResultListener* listener) const override {
zhanyong.wan's avatar
zhanyong.wan committed
1037
1038
    // If either matcher1_ or matcher2_ doesn't match x, we only need
    // to explain why one of them fails.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
    std::string all_match_result;

    for (size_t i = 0; i < matchers_.size(); ++i) {
      StringMatchResultListener slistener;
      if (matchers_[i].MatchAndExplain(x, &slistener)) {
        if (all_match_result.empty()) {
          all_match_result = slistener.str();
        } else {
          std::string result = slistener.str();
          if (!result.empty()) {
            all_match_result += ", and ";
            all_match_result += result;
          }
        }
      } else {
        *listener << slistener.str();
        return false;
      }
zhanyong.wan's avatar
zhanyong.wan committed
1057
    }
1058

zhanyong.wan's avatar
zhanyong.wan committed
1059
    // Otherwise we need to explain why *both* of them match.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1060
    *listener << all_match_result;
zhanyong.wan's avatar
zhanyong.wan committed
1061
    return true;
1062
  }
1063

1064
 private:
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1065
  const std::vector<Matcher<T> > matchers_;
1066

Gennadiy Civil's avatar
 
Gennadiy Civil committed
1067
  GTEST_DISALLOW_ASSIGN_(AllOfMatcherImpl);
1068
1069
};

1070
1071
1072
1073
1074
1075
1076
1077
// VariadicMatcher is used for the variadic implementation of
// AllOf(m_1, m_2, ...) and AnyOf(m_1, m_2, ...).
// CombiningMatcher<T> is used to recursively combine the provided matchers
// (of type Args...).
template <template <typename T> class CombiningMatcher, typename... Args>
class VariadicMatcher {
 public:
  VariadicMatcher(const Args&... matchers)  // NOLINT
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1078
1079
1080
      : matchers_(matchers...) {
    static_assert(sizeof...(Args) > 0, "Must have at least one matcher.");
  }
1081
1082
1083
1084
1085
1086

  // This template type conversion operator allows an
  // VariadicMatcher<Matcher1, Matcher2...> object to match any type that
  // all of the provided matchers (Matcher1, Matcher2, ...) can match.
  template <typename T>
  operator Matcher<T>() const {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1087
1088
    std::vector<Matcher<T> > values;
    CreateVariadicMatcher<T>(&values, std::integral_constant<size_t, 0>());
Abseil Team's avatar
Abseil Team committed
1089
    return Matcher<T>(new CombiningMatcher<T>(std::move(values)));
1090
1091
1092
  }

 private:
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
  template <typename T, size_t I>
  void CreateVariadicMatcher(std::vector<Matcher<T> >* values,
                             std::integral_constant<size_t, I>) const {
    values->push_back(SafeMatcherCast<T>(std::get<I>(matchers_)));
    CreateVariadicMatcher<T>(values, std::integral_constant<size_t, I + 1>());
  }

  template <typename T>
  void CreateVariadicMatcher(
      std::vector<Matcher<T> >*,
      std::integral_constant<size_t, sizeof...(Args)>) const {}
1104

Abseil Team's avatar
Abseil Team committed
1105
  std::tuple<Args...> matchers_;
1106
1107
1108
1109
1110

  GTEST_DISALLOW_ASSIGN_(VariadicMatcher);
};

template <typename... Args>
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1111
using AllOfMatcher = VariadicMatcher<AllOfMatcherImpl, Args...>;
1112

1113
1114
1115
1116
1117
// Implements the AnyOf(m1, m2) matcher for a particular argument type
// T.  We do not nest it inside the AnyOfMatcher class template, as
// that will prevent different instantiations of AnyOfMatcher from
// sharing the same EitherOfMatcherImpl<T> class.
template <typename T>
Abseil Team's avatar
Abseil Team committed
1118
class AnyOfMatcherImpl : public MatcherInterface<const T&> {
1119
 public:
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1120
  explicit AnyOfMatcherImpl(std::vector<Matcher<T> > matchers)
Abseil Team's avatar
Abseil Team committed
1121
      : matchers_(std::move(matchers)) {}
1122

Abseil Team's avatar
Abseil Team committed
1123
  void DescribeTo(::std::ostream* os) const override {
1124
    *os << "(";
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1125
1126
1127
1128
    for (size_t i = 0; i < matchers_.size(); ++i) {
      if (i != 0) *os << ") or (";
      matchers_[i].DescribeTo(os);
    }
1129
1130
    *os << ")";
  }
1131

Abseil Team's avatar
Abseil Team committed
1132
  void DescribeNegationTo(::std::ostream* os) const override {
1133
    *os << "(";
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1134
1135
1136
1137
    for (size_t i = 0; i < matchers_.size(); ++i) {
      if (i != 0) *os << ") and (";
      matchers_[i].DescribeNegationTo(os);
    }
1138
    *os << ")";
1139
1140
  }

Abseil Team's avatar
Abseil Team committed
1141
  bool MatchAndExplain(const T& x,
Abseil Team's avatar
Abseil Team committed
1142
                       MatchResultListener* listener) const override {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1143
1144
    std::string no_match_result;

zhanyong.wan's avatar
zhanyong.wan committed
1145
1146
    // If either matcher1_ or matcher2_ matches x, we just need to
    // explain why *one* of them matches.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
    for (size_t i = 0; i < matchers_.size(); ++i) {
      StringMatchResultListener slistener;
      if (matchers_[i].MatchAndExplain(x, &slistener)) {
        *listener << slistener.str();
        return true;
      } else {
        if (no_match_result.empty()) {
          no_match_result = slistener.str();
        } else {
          std::string result = slistener.str();
          if (!result.empty()) {
            no_match_result += ", and ";
            no_match_result += result;
          }
        }
      }
zhanyong.wan's avatar
zhanyong.wan committed
1163
    }
1164

zhanyong.wan's avatar
zhanyong.wan committed
1165
    // Otherwise we need to explain why *both* of them fail.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1166
    *listener << no_match_result;
zhanyong.wan's avatar
zhanyong.wan committed
1167
    return false;
1168
  }
1169

1170
 private:
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1171
  const std::vector<Matcher<T> > matchers_;
1172

Gennadiy Civil's avatar
 
Gennadiy Civil committed
1173
  GTEST_DISALLOW_ASSIGN_(AnyOfMatcherImpl);
1174
1175
};

1176
1177
// AnyOfMatcher is used for the variadic implementation of AnyOf(m_1, m_2, ...).
template <typename... Args>
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1178
using AnyOfMatcher = VariadicMatcher<AnyOfMatcherImpl, Args...>;
1179

1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
// Used for implementing Truly(pred), which turns a predicate into a
// matcher.
template <typename Predicate>
class TrulyMatcher {
 public:
  explicit TrulyMatcher(Predicate pred) : predicate_(pred) {}

  // This method template allows Truly(pred) to be used as a matcher
  // for type T where T is the argument type of predicate 'pred'.  The
  // argument is passed by reference as the predicate may be
  // interested in the address of the argument.
  template <typename T>
1192
1193
  bool MatchAndExplain(T& x,  // NOLINT
                       MatchResultListener* /* listener */) const {
1194
1195
1196
1197
1198
1199
1200
1201
1202
    // Without the if-statement, MSVC sometimes warns about converting
    // a value to bool (warning 4800).
    //
    // We cannot write 'return !!predicate_(x);' as that doesn't work
    // when predicate_(x) returns a class convertible to bool but
    // having no operator!().
    if (predicate_(x))
      return true;
    return false;
1203
1204
1205
1206
1207
1208
1209
1210
1211
  }

  void DescribeTo(::std::ostream* os) const {
    *os << "satisfies the given predicate";
  }

  void DescribeNegationTo(::std::ostream* os) const {
    *os << "doesn't satisfy the given predicate";
  }
1212

1213
1214
 private:
  Predicate predicate_;
1215
1216

  GTEST_DISALLOW_ASSIGN_(TrulyMatcher);
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
};

// Used for implementing Matches(matcher), which turns a matcher into
// a predicate.
template <typename M>
class MatcherAsPredicate {
 public:
  explicit MatcherAsPredicate(M matcher) : matcher_(matcher) {}

  // This template operator() allows Matches(m) to be used as a
  // predicate on type T where m is a matcher on type T.
  //
  // The argument x is passed by reference instead of by value, as
  // some matcher may be interested in its address (e.g. as in
  // Matches(Ref(n))(x)).
  template <typename T>
  bool operator()(const T& x) const {
    // We let matcher_ commit to a particular type here instead of
    // when the MatcherAsPredicate object was constructed.  This
    // allows us to write Matches(m) where m is a polymorphic matcher
    // (e.g. Eq(5)).
    //
    // If we write Matcher<T>(matcher_).Matches(x) here, it won't
    // compile when matcher_ has type Matcher<const T&>; if we write
    // Matcher<const T&>(matcher_).Matches(x) here, it won't compile
    // when matcher_ has type Matcher<T>; if we just write
    // matcher_.Matches(x), it won't compile when matcher_ is
    // polymorphic, e.g. Eq(5).
    //
    // MatcherCast<const T&>() is necessary for making the code work
    // in all of the above situations.
    return MatcherCast<const T&>(matcher_).Matches(x);
  }
1250

1251
1252
 private:
  M matcher_;
1253
1254

  GTEST_DISALLOW_ASSIGN_(MatcherAsPredicate);
1255
1256
1257
1258
1259
1260
1261
};

// For implementing ASSERT_THAT() and EXPECT_THAT().  The template
// argument M must be a type that can be converted to a matcher.
template <typename M>
class PredicateFormatterFromMatcher {
 public:
Abseil Team's avatar
Abseil Team committed
1262
  explicit PredicateFormatterFromMatcher(M m) : matcher_(std::move(m)) {}
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274

  // This template () operator allows a PredicateFormatterFromMatcher
  // object to act as a predicate-formatter suitable for using with
  // Google Test's EXPECT_PRED_FORMAT1() macro.
  template <typename T>
  AssertionResult operator()(const char* value_text, const T& x) const {
    // We convert matcher_ to a Matcher<const T&> *now* instead of
    // when the PredicateFormatterFromMatcher object was constructed,
    // as matcher_ may be polymorphic (e.g. NotNull()) and we won't
    // know which type to instantiate it to until we actually see the
    // type of x here.
    //
1275
    // We write SafeMatcherCast<const T&>(matcher_) instead of
1276
1277
    // Matcher<const T&>(matcher_), as the latter won't compile when
    // matcher_ has type Matcher<T> (e.g. An<int>()).
1278
1279
1280
    // We don't write MatcherCast<const T&> either, as that allows
    // potentially unsafe downcasting of the matcher argument.
    const Matcher<const T&> matcher = SafeMatcherCast<const T&>(matcher_);
Abseil Team's avatar
Abseil Team committed
1281
1282
1283
1284

    // The expected path here is that the matcher should match (i.e. that most
    // tests pass) so optimize for this case.
    if (matcher.Matches(x)) {
1285
      return AssertionSuccess();
Abseil Team's avatar
Abseil Team committed
1286
    }
1287
1288
1289
1290
1291

    ::std::stringstream ss;
    ss << "Value of: " << value_text << "\n"
       << "Expected: ";
    matcher.DescribeTo(&ss);
Abseil Team's avatar
Abseil Team committed
1292
1293
1294
1295
1296
1297
1298

    // Rerun the matcher to "PrintAndExain" the failure.
    StringMatchResultListener listener;
    if (MatchPrintAndExplain(x, matcher, &listener)) {
      ss << "\n  The matcher failed on the initial attempt; but passed when "
            "rerun to generate the explanation.";
    }
1299
1300
    ss << "\n  Actual: " << listener.str();
    return AssertionFailure() << ss.str();
1301
  }
1302

1303
1304
 private:
  const M matcher_;
1305
1306

  GTEST_DISALLOW_ASSIGN_(PredicateFormatterFromMatcher);
1307
1308
1309
1310
1311
};

// A helper function for converting a matcher to a predicate-formatter
// without the user needing to explicitly write the type.  This is
// used for implementing ASSERT_THAT() and EXPECT_THAT().
1312
// Implementation detail: 'matcher' is received by-value to force decaying.
1313
1314
template <typename M>
inline PredicateFormatterFromMatcher<M>
1315
MakePredicateFormatterFromMatcher(M matcher) {
Abseil Team's avatar
Abseil Team committed
1316
  return PredicateFormatterFromMatcher<M>(std::move(matcher));
1317
1318
}

1319
1320
1321
1322
// Implements the polymorphic floating point equality matcher, which matches
// two float values using ULP-based approximation or, optionally, a
// user-specified epsilon.  The template is meant to be instantiated with
// FloatType being either float or double.
1323
1324
1325
1326
template <typename FloatType>
class FloatingEqMatcher {
 public:
  // Constructor for FloatingEqMatcher.
1327
  // The matcher's input will be compared with expected.  The matcher treats two
1328
  // NANs as equal if nan_eq_nan is true.  Otherwise, under IEEE standards,
1329
1330
1331
  // equality comparisons between NANs will always return false.  We specify a
  // negative max_abs_error_ term to indicate that ULP-based approximation will
  // be used for comparison.
1332
1333
  FloatingEqMatcher(FloatType expected, bool nan_eq_nan) :
    expected_(expected), nan_eq_nan_(nan_eq_nan), max_abs_error_(-1) {
1334
1335
1336
1337
1338
  }

  // Constructor that supports a user-specified max_abs_error that will be used
  // for comparison instead of ULP-based approximation.  The max absolute
  // should be non-negative.
1339
1340
1341
1342
1343
  FloatingEqMatcher(FloatType expected, bool nan_eq_nan,
                    FloatType max_abs_error)
      : expected_(expected),
        nan_eq_nan_(nan_eq_nan),
        max_abs_error_(max_abs_error) {
1344
1345
1346
    GTEST_CHECK_(max_abs_error >= 0)
        << ", where max_abs_error is" << max_abs_error;
  }
1347
1348
1349
1350
1351

  // Implements floating point equality matcher as a Matcher<T>.
  template <typename T>
  class Impl : public MatcherInterface<T> {
   public:
1352
1353
1354
1355
    Impl(FloatType expected, bool nan_eq_nan, FloatType max_abs_error)
        : expected_(expected),
          nan_eq_nan_(nan_eq_nan),
          max_abs_error_(max_abs_error) {}
1356

Abseil Team's avatar
Abseil Team committed
1357
1358
    bool MatchAndExplain(T value,
                         MatchResultListener* listener) const override {
1359
      const FloatingPoint<FloatType> actual(value), expected(expected_);
1360
1361

      // Compares NaNs first, if nan_eq_nan_ is true.
1362
1363
      if (actual.is_nan() || expected.is_nan()) {
        if (actual.is_nan() && expected.is_nan()) {
1364
1365
1366
1367
1368
1369
1370
          return nan_eq_nan_;
        }
        // One is nan; the other is not nan.
        return false;
      }
      if (HasMaxAbsError()) {
        // We perform an equality check so that inf will match inf, regardless
1371
        // of error bounds.  If the result of value - expected_ would result in
1372
1373
        // overflow or if either value is inf, the default result is infinity,
        // which should only match if max_abs_error_ is also infinity.
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
        if (value == expected_) {
          return true;
        }

        const FloatType diff = value - expected_;
        if (fabs(diff) <= max_abs_error_) {
          return true;
        }

        if (listener->IsInterested()) {
          *listener << "which is " << diff << " from " << expected_;
        }
        return false;
1387
      } else {
1388
        return actual.AlmostEquals(expected);
1389
1390
1391
      }
    }

Abseil Team's avatar
Abseil Team committed
1392
    void DescribeTo(::std::ostream* os) const override {
1393
1394
1395
1396
1397
      // os->precision() returns the previously set precision, which we
      // store to restore the ostream to its original configuration
      // after outputting.
      const ::std::streamsize old_precision = os->precision(
          ::std::numeric_limits<FloatType>::digits10 + 2);
1398
      if (FloatingPoint<FloatType>(expected_).is_nan()) {
1399
1400
1401
1402
1403
1404
        if (nan_eq_nan_) {
          *os << "is NaN";
        } else {
          *os << "never matches";
        }
      } else {
1405
        *os << "is approximately " << expected_;
1406
1407
1408
        if (HasMaxAbsError()) {
          *os << " (absolute error <= " << max_abs_error_ << ")";
        }
1409
1410
1411
1412
      }
      os->precision(old_precision);
    }

Abseil Team's avatar
Abseil Team committed
1413
    void DescribeNegationTo(::std::ostream* os) const override {
1414
1415
1416
      // As before, get original precision.
      const ::std::streamsize old_precision = os->precision(
          ::std::numeric_limits<FloatType>::digits10 + 2);
1417
      if (FloatingPoint<FloatType>(expected_).is_nan()) {
1418
        if (nan_eq_nan_) {
1419
          *os << "isn't NaN";
1420
1421
1422
1423
        } else {
          *os << "is anything";
        }
      } else {
1424
        *os << "isn't approximately " << expected_;
1425
1426
1427
        if (HasMaxAbsError()) {
          *os << " (absolute error > " << max_abs_error_ << ")";
        }
1428
1429
1430
1431
1432
1433
      }
      // Restore original precision.
      os->precision(old_precision);
    }

   private:
1434
1435
1436
1437
    bool HasMaxAbsError() const {
      return max_abs_error_ >= 0;
    }

1438
    const FloatType expected_;
1439
    const bool nan_eq_nan_;
1440
1441
    // max_abs_error will be used for value comparison when >= 0.
    const FloatType max_abs_error_;
1442
1443

    GTEST_DISALLOW_ASSIGN_(Impl);
1444
1445
  };

1446
1447
  // The following 3 type conversion operators allow FloatEq(expected) and
  // NanSensitiveFloatEq(expected) to be used as a Matcher<float>, a
1448
1449
1450
1451
1452
  // Matcher<const float&>, or a Matcher<float&>, but nothing else.
  // (While Google's C++ coding style doesn't allow arguments passed
  // by non-const reference, we may see them in code not conforming to
  // the style.  Therefore Google Mock needs to support them.)
  operator Matcher<FloatType>() const {
1453
1454
    return MakeMatcher(
        new Impl<FloatType>(expected_, nan_eq_nan_, max_abs_error_));
1455
1456
1457
  }

  operator Matcher<const FloatType&>() const {
1458
    return MakeMatcher(
1459
        new Impl<const FloatType&>(expected_, nan_eq_nan_, max_abs_error_));
1460
1461
1462
  }

  operator Matcher<FloatType&>() const {
1463
1464
    return MakeMatcher(
        new Impl<FloatType&>(expected_, nan_eq_nan_, max_abs_error_));
1465
  }
1466

1467
 private:
1468
  const FloatType expected_;
1469
  const bool nan_eq_nan_;
1470
1471
  // max_abs_error will be used for value comparison when >= 0.
  const FloatType max_abs_error_;
1472
1473

  GTEST_DISALLOW_ASSIGN_(FloatingEqMatcher);
1474
1475
};

Gennadiy Civil's avatar
 
Gennadiy Civil committed
1476
1477
1478
1479
1480
1481
1482
1483
// A 2-tuple ("binary") wrapper around FloatingEqMatcher:
// FloatingEq2Matcher() matches (x, y) by matching FloatingEqMatcher(x, false)
// against y, and FloatingEq2Matcher(e) matches FloatingEqMatcher(x, false, e)
// against y. The former implements "Eq", the latter "Near". At present, there
// is no version that compares NaNs as equal.
template <typename FloatType>
class FloatingEq2Matcher {
 public:
1484
  FloatingEq2Matcher() { Init(-1, false); }
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1485

1486
  explicit FloatingEq2Matcher(bool nan_eq_nan) { Init(-1, nan_eq_nan); }
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1487

1488
1489
1490
  explicit FloatingEq2Matcher(FloatType max_abs_error) {
    Init(max_abs_error, false);
  }
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1491

1492
1493
1494
  FloatingEq2Matcher(FloatType max_abs_error, bool nan_eq_nan) {
    Init(max_abs_error, nan_eq_nan);
  }
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1495
1496

  template <typename T1, typename T2>
Abseil Team's avatar
Abseil Team committed
1497
  operator Matcher<::std::tuple<T1, T2>>() const {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1498
    return MakeMatcher(
Abseil Team's avatar
Abseil Team committed
1499
        new Impl<::std::tuple<T1, T2>>(max_abs_error_, nan_eq_nan_));
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1500
1501
  }
  template <typename T1, typename T2>
Abseil Team's avatar
Abseil Team committed
1502
  operator Matcher<const ::std::tuple<T1, T2>&>() const {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1503
    return MakeMatcher(
Abseil Team's avatar
Abseil Team committed
1504
        new Impl<const ::std::tuple<T1, T2>&>(max_abs_error_, nan_eq_nan_));
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
  }

 private:
  static ::std::ostream& GetDesc(::std::ostream& os) {  // NOLINT
    return os << "an almost-equal pair";
  }

  template <typename Tuple>
  class Impl : public MatcherInterface<Tuple> {
   public:
    Impl(FloatType max_abs_error, bool nan_eq_nan) :
        max_abs_error_(max_abs_error),
        nan_eq_nan_(nan_eq_nan) {}

Abseil Team's avatar
Abseil Team committed
1519
1520
    bool MatchAndExplain(Tuple args,
                         MatchResultListener* listener) const override {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1521
      if (max_abs_error_ == -1) {
Abseil Team's avatar
Abseil Team committed
1522
1523
1524
        FloatingEqMatcher<FloatType> fm(::std::get<0>(args), nan_eq_nan_);
        return static_cast<Matcher<FloatType>>(fm).MatchAndExplain(
            ::std::get<1>(args), listener);
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1525
      } else {
Abseil Team's avatar
Abseil Team committed
1526
        FloatingEqMatcher<FloatType> fm(::std::get<0>(args), nan_eq_nan_,
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1527
                                        max_abs_error_);
Abseil Team's avatar
Abseil Team committed
1528
1529
        return static_cast<Matcher<FloatType>>(fm).MatchAndExplain(
            ::std::get<1>(args), listener);
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1530
1531
      }
    }
Abseil Team's avatar
Abseil Team committed
1532
    void DescribeTo(::std::ostream* os) const override {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1533
1534
      *os << "are " << GetDesc;
    }
Abseil Team's avatar
Abseil Team committed
1535
    void DescribeNegationTo(::std::ostream* os) const override {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1536
1537
1538
1539
1540
1541
1542
1543
      *os << "aren't " << GetDesc;
    }

   private:
    FloatType max_abs_error_;
    const bool nan_eq_nan_;
  };

1544
1545
1546
1547
  void Init(FloatType max_abs_error_val, bool nan_eq_nan_val) {
    max_abs_error_ = max_abs_error_val;
    nan_eq_nan_ = nan_eq_nan_val;
  }
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1548
  FloatType max_abs_error_;
1549
  bool nan_eq_nan_;
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1550
1551
};

1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
// Implements the Pointee(m) matcher for matching a pointer whose
// pointee matches matcher m.  The pointer can be either raw or smart.
template <typename InnerMatcher>
class PointeeMatcher {
 public:
  explicit PointeeMatcher(const InnerMatcher& matcher) : matcher_(matcher) {}

  // This type conversion operator template allows Pointee(m) to be
  // used as a matcher for any pointer type whose pointee type is
  // compatible with the inner matcher, where type Pointer can be
  // either a raw pointer or a smart pointer.
  //
  // The reason we do this instead of relying on
  // MakePolymorphicMatcher() is that the latter is not flexible
  // enough for implementing the DescribeTo() method of Pointee().
  template <typename Pointer>
  operator Matcher<Pointer>() const {
Abseil Team's avatar
Abseil Team committed
1569
    return Matcher<Pointer>(new Impl<const Pointer&>(matcher_));
1570
  }
1571

1572
1573
1574
1575
1576
 private:
  // The monomorphic implementation that works for a particular pointer type.
  template <typename Pointer>
  class Impl : public MatcherInterface<Pointer> {
   public:
1577
1578
    typedef typename PointeeOf<GTEST_REMOVE_CONST_(  // NOLINT
        GTEST_REMOVE_REFERENCE_(Pointer))>::type Pointee;
1579
1580
1581
1582

    explicit Impl(const InnerMatcher& matcher)
        : matcher_(MatcherCast<const Pointee&>(matcher)) {}

Abseil Team's avatar
Abseil Team committed
1583
    void DescribeTo(::std::ostream* os) const override {
1584
1585
1586
1587
      *os << "points to a value that ";
      matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
1588
    void DescribeNegationTo(::std::ostream* os) const override {
1589
1590
1591
1592
      *os << "does not point to a value that ";
      matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
1593
1594
    bool MatchAndExplain(Pointer pointer,
                         MatchResultListener* listener) const override {
1595
      if (GetRawPointer(pointer) == nullptr) return false;
1596

1597
1598
      *listener << "which points to ";
      return MatchPrintAndExplain(*pointer, matcher_, listener);
1599
    }
1600

1601
1602
   private:
    const Matcher<const Pointee&> matcher_;
1603
1604

    GTEST_DISALLOW_ASSIGN_(Impl);
1605
1606
1607
  };

  const InnerMatcher matcher_;
1608
1609

  GTEST_DISALLOW_ASSIGN_(PointeeMatcher);
1610
1611
};

1612
#if GTEST_HAS_RTTI
billydonahue's avatar
billydonahue committed
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
// Implements the WhenDynamicCastTo<T>(m) matcher that matches a pointer or
// reference that matches inner_matcher when dynamic_cast<T> is applied.
// The result of dynamic_cast<To> is forwarded to the inner matcher.
// If To is a pointer and the cast fails, the inner matcher will receive NULL.
// If To is a reference and the cast fails, this matcher returns false
// immediately.
template <typename To>
class WhenDynamicCastToMatcherBase {
 public:
  explicit WhenDynamicCastToMatcherBase(const Matcher<To>& matcher)
      : matcher_(matcher) {}

  void DescribeTo(::std::ostream* os) const {
    GetCastTypeDescription(os);
    matcher_.DescribeTo(os);
  }

  void DescribeNegationTo(::std::ostream* os) const {
    GetCastTypeDescription(os);
    matcher_.DescribeNegationTo(os);
  }

 protected:
  const Matcher<To> matcher_;

1638
  static std::string GetToName() {
billydonahue's avatar
billydonahue committed
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
    return GetTypeName<To>();
  }

 private:
  static void GetCastTypeDescription(::std::ostream* os) {
    *os << "when dynamic_cast to " << GetToName() << ", ";
  }

  GTEST_DISALLOW_ASSIGN_(WhenDynamicCastToMatcherBase);
};

// Primary template.
// To is a pointer. Cast and forward the result.
template <typename To>
class WhenDynamicCastToMatcher : public WhenDynamicCastToMatcherBase<To> {
 public:
  explicit WhenDynamicCastToMatcher(const Matcher<To>& matcher)
      : WhenDynamicCastToMatcherBase<To>(matcher) {}

  template <typename From>
  bool MatchAndExplain(From from, MatchResultListener* listener) const {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1660
    // FIXME: Add more detail on failures. ie did the dyn_cast fail?
billydonahue's avatar
billydonahue committed
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
    To to = dynamic_cast<To>(from);
    return MatchPrintAndExplain(to, this->matcher_, listener);
  }
};

// Specialize for references.
// In this case we return false if the dynamic_cast fails.
template <typename To>
class WhenDynamicCastToMatcher<To&> : public WhenDynamicCastToMatcherBase<To&> {
 public:
  explicit WhenDynamicCastToMatcher(const Matcher<To&>& matcher)
      : WhenDynamicCastToMatcherBase<To&>(matcher) {}

  template <typename From>
  bool MatchAndExplain(From& from, MatchResultListener* listener) const {
    // We don't want an std::bad_cast here, so do the cast with pointers.
    To* to = dynamic_cast<To*>(&from);
1678
    if (to == nullptr) {
billydonahue's avatar
billydonahue committed
1679
1680
1681
1682
1683
1684
      *listener << "which cannot be dynamic_cast to " << this->GetToName();
      return false;
    }
    return MatchPrintAndExplain(*to, this->matcher_, listener);
  }
};
1685
#endif  // GTEST_HAS_RTTI
billydonahue's avatar
billydonahue committed
1686

1687
1688
1689
1690
1691
1692
1693
// Implements the Field() matcher for matching a field (i.e. member
// variable) of an object.
template <typename Class, typename FieldType>
class FieldMatcher {
 public:
  FieldMatcher(FieldType Class::*field,
               const Matcher<const FieldType&>& matcher)
Gennadiy Civil's avatar
Gennadiy Civil committed
1694
1695
1696
1697
1698
1699
1700
      : field_(field), matcher_(matcher), whose_field_("whose given field ") {}

  FieldMatcher(const std::string& field_name, FieldType Class::*field,
               const Matcher<const FieldType&>& matcher)
      : field_(field),
        matcher_(matcher),
        whose_field_("whose field `" + field_name + "` ") {}
1701
1702

  void DescribeTo(::std::ostream* os) const {
Gennadiy Civil's avatar
Gennadiy Civil committed
1703
    *os << "is an object " << whose_field_;
1704
1705
1706
1707
    matcher_.DescribeTo(os);
  }

  void DescribeNegationTo(::std::ostream* os) const {
Gennadiy Civil's avatar
Gennadiy Civil committed
1708
    *os << "is an object " << whose_field_;
1709
1710
1711
    matcher_.DescribeNegationTo(os);
  }

1712
1713
  template <typename T>
  bool MatchAndExplain(const T& value, MatchResultListener* listener) const {
Abseil Team's avatar
Abseil Team committed
1714
1715
    // FIXME: The dispatch on std::is_pointer was introduced as a workaround for
    // a compiler bug, and can now be removed.
1716
    return MatchAndExplainImpl(
Abseil Team's avatar
Abseil Team committed
1717
1718
        typename std::is_pointer<GTEST_REMOVE_CONST_(T)>::type(), value,
        listener);
1719
1720
1721
  }

 private:
Abseil Team's avatar
Abseil Team committed
1722
1723
  bool MatchAndExplainImpl(std::false_type /* is_not_pointer */,
                           const Class& obj,
1724
                           MatchResultListener* listener) const {
Gennadiy Civil's avatar
Gennadiy Civil committed
1725
    *listener << whose_field_ << "is ";
1726
    return MatchPrintAndExplain(obj.*field_, matcher_, listener);
1727
1728
  }

Abseil Team's avatar
Abseil Team committed
1729
  bool MatchAndExplainImpl(std::true_type /* is_pointer */, const Class* p,
1730
                           MatchResultListener* listener) const {
1731
    if (p == nullptr) return false;
zhanyong.wan's avatar
zhanyong.wan committed
1732

1733
    *listener << "which points to an object ";
zhanyong.wan's avatar
zhanyong.wan committed
1734
1735
1736
    // Since *p has a field, it must be a class/struct/union type and
    // thus cannot be a pointer.  Therefore we pass false_type() as
    // the first argument.
Abseil Team's avatar
Abseil Team committed
1737
    return MatchAndExplainImpl(std::false_type(), *p, listener);
1738
  }
1739

1740
1741
  const FieldType Class::*field_;
  const Matcher<const FieldType&> matcher_;
1742

Gennadiy Civil's avatar
Gennadiy Civil committed
1743
1744
1745
1746
  // Contains either "whose given field " if the name of the field is unknown
  // or "whose field `name_of_field` " if the name is known.
  const std::string whose_field_;

1747
  GTEST_DISALLOW_ASSIGN_(FieldMatcher);
1748
1749
1750
1751
};

// Implements the Property() matcher for matching a property
// (i.e. return value of a getter method) of an object.
1752
1753
1754
1755
//
// Property is a const-qualified member function of Class returning
// PropertyType.
template <typename Class, typename PropertyType, typename Property>
1756
1757
class PropertyMatcher {
 public:
Abseil Team's avatar
Abseil Team committed
1758
  typedef const PropertyType& RefToConstProperty;
1759

1760
  PropertyMatcher(Property property, const Matcher<RefToConstProperty>& matcher)
Gennadiy Civil's avatar
Gennadiy Civil committed
1761
1762
1763
1764
1765
1766
1767
1768
1769
      : property_(property),
        matcher_(matcher),
        whose_property_("whose given property ") {}

  PropertyMatcher(const std::string& property_name, Property property,
                  const Matcher<RefToConstProperty>& matcher)
      : property_(property),
        matcher_(matcher),
        whose_property_("whose property `" + property_name + "` ") {}
1770
1771

  void DescribeTo(::std::ostream* os) const {
Gennadiy Civil's avatar
Gennadiy Civil committed
1772
    *os << "is an object " << whose_property_;
1773
1774
1775
1776
    matcher_.DescribeTo(os);
  }

  void DescribeNegationTo(::std::ostream* os) const {
Gennadiy Civil's avatar
Gennadiy Civil committed
1777
    *os << "is an object " << whose_property_;
1778
1779
1780
    matcher_.DescribeNegationTo(os);
  }

1781
1782
1783
  template <typename T>
  bool MatchAndExplain(const T&value, MatchResultListener* listener) const {
    return MatchAndExplainImpl(
Abseil Team's avatar
Abseil Team committed
1784
1785
        typename std::is_pointer<GTEST_REMOVE_CONST_(T)>::type(), value,
        listener);
1786
1787
1788
  }

 private:
Abseil Team's avatar
Abseil Team committed
1789
1790
  bool MatchAndExplainImpl(std::false_type /* is_not_pointer */,
                           const Class& obj,
1791
                           MatchResultListener* listener) const {
Gennadiy Civil's avatar
Gennadiy Civil committed
1792
    *listener << whose_property_ << "is ";
1793
1794
1795
1796
    // Cannot pass the return value (for example, int) to MatchPrintAndExplain,
    // which takes a non-const reference as argument.
    RefToConstProperty result = (obj.*property_)();
    return MatchPrintAndExplain(result, matcher_, listener);
1797
1798
  }

Abseil Team's avatar
Abseil Team committed
1799
  bool MatchAndExplainImpl(std::true_type /* is_pointer */, const Class* p,
1800
                           MatchResultListener* listener) const {
1801
    if (p == nullptr) return false;
zhanyong.wan's avatar
zhanyong.wan committed
1802

1803
    *listener << "which points to an object ";
zhanyong.wan's avatar
zhanyong.wan committed
1804
1805
1806
    // Since *p has a property method, it must be a class/struct/union
    // type and thus cannot be a pointer.  Therefore we pass
    // false_type() as the first argument.
Abseil Team's avatar
Abseil Team committed
1807
    return MatchAndExplainImpl(std::false_type(), *p, listener);
1808
  }
1809

1810
  Property property_;
1811
  const Matcher<RefToConstProperty> matcher_;
1812

Gennadiy Civil's avatar
Gennadiy Civil committed
1813
1814
1815
1816
  // Contains either "whose given property " if the name of the property is
  // unknown or "whose property `name_of_property` " if the name is known.
  const std::string whose_property_;

1817
  GTEST_DISALLOW_ASSIGN_(PropertyMatcher);
1818
1819
1820
1821
1822
1823
1824
1825
};

// Type traits specifying various features of different functors for ResultOf.
// The default template specifies features for functor objects.
template <typename Functor>
struct CallableTraits {
  typedef Functor StorageType;

1826
  static void CheckIsValid(Functor /* functor */) {}
1827
1828
1829

  template <typename T>
  static auto Invoke(Functor f, T arg) -> decltype(f(arg)) { return f(arg); }
1830
1831
1832
1833
1834
1835
1836
1837
1838
};

// Specialization for function pointers.
template <typename ArgType, typename ResType>
struct CallableTraits<ResType(*)(ArgType)> {
  typedef ResType ResultType;
  typedef ResType(*StorageType)(ArgType);

  static void CheckIsValid(ResType(*f)(ArgType)) {
1839
    GTEST_CHECK_(f != nullptr)
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
        << "NULL function pointer is passed into ResultOf().";
  }
  template <typename T>
  static ResType Invoke(ResType(*f)(ArgType), T arg) {
    return (*f)(arg);
  }
};

// Implements the ResultOf() matcher for matching a return value of a
// unary function of an object.
1850
template <typename Callable, typename InnerMatcher>
1851
1852
class ResultOfMatcher {
 public:
1853
  ResultOfMatcher(Callable callable, InnerMatcher matcher)
Abseil Team's avatar
Abseil Team committed
1854
      : callable_(std::move(callable)), matcher_(std::move(matcher)) {
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
    CallableTraits<Callable>::CheckIsValid(callable_);
  }

  template <typename T>
  operator Matcher<T>() const {
    return Matcher<T>(new Impl<T>(callable_, matcher_));
  }

 private:
  typedef typename CallableTraits<Callable>::StorageType CallableStorageType;

  template <typename T>
  class Impl : public MatcherInterface<T> {
1868
1869
1870
    using ResultType = decltype(CallableTraits<Callable>::template Invoke<T>(
        std::declval<CallableStorageType>(), std::declval<T>()));

1871
   public:
1872
1873
1874
    template <typename M>
    Impl(const CallableStorageType& callable, const M& matcher)
        : callable_(callable), matcher_(MatcherCast<ResultType>(matcher)) {}
1875

Abseil Team's avatar
Abseil Team committed
1876
    void DescribeTo(::std::ostream* os) const override {
1877
      *os << "is mapped by the given callable to a value that ";
1878
1879
1880
      matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
1881
    void DescribeNegationTo(::std::ostream* os) const override {
1882
      *os << "is mapped by the given callable to a value that ";
1883
1884
1885
      matcher_.DescribeNegationTo(os);
    }

Abseil Team's avatar
Abseil Team committed
1886
    bool MatchAndExplain(T obj, MatchResultListener* listener) const override {
1887
      *listener << "which is mapped by the given callable to ";
1888
1889
1890
1891
      // Cannot pass the return value directly to MatchPrintAndExplain, which
      // takes a non-const reference as argument.
      // Also, specifying template argument explicitly is needed because T could
      // be a non-const reference (e.g. Matcher<Uncopyable&>).
1892
1893
1894
      ResultType result =
          CallableTraits<Callable>::template Invoke<T>(callable_, obj);
      return MatchPrintAndExplain(result, matcher_, listener);
1895
    }
1896

1897
1898
   private:
    // Functors often define operator() as non-const method even though
Troy Holsapple's avatar
Troy Holsapple committed
1899
    // they are actually stateless. But we need to use them even when
1900
    // 'this' is a const pointer. It's the user's responsibility not to
1901
    // use stateful callables with ResultOf(), which doesn't guarantee
1902
1903
1904
    // how many times the callable will be invoked.
    mutable CallableStorageType callable_;
    const Matcher<ResultType> matcher_;
1905
1906

    GTEST_DISALLOW_ASSIGN_(Impl);
1907
1908
1909
  };  // class Impl

  const CallableStorageType callable_;
1910
  const InnerMatcher matcher_;
1911
1912

  GTEST_DISALLOW_ASSIGN_(ResultOfMatcher);
1913
1914
};

zhanyong.wan's avatar
zhanyong.wan committed
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
// Implements a matcher that checks the size of an STL-style container.
template <typename SizeMatcher>
class SizeIsMatcher {
 public:
  explicit SizeIsMatcher(const SizeMatcher& size_matcher)
       : size_matcher_(size_matcher) {
  }

  template <typename Container>
  operator Matcher<Container>() const {
Abseil Team's avatar
Abseil Team committed
1925
    return Matcher<Container>(new Impl<const Container&>(size_matcher_));
zhanyong.wan's avatar
zhanyong.wan committed
1926
1927
1928
1929
1930
  }

  template <typename Container>
  class Impl : public MatcherInterface<Container> {
   public:
Abseil Team's avatar
Abseil Team committed
1931
    using SizeType = decltype(std::declval<Container>().size());
zhanyong.wan's avatar
zhanyong.wan committed
1932
1933
1934
    explicit Impl(const SizeMatcher& size_matcher)
        : size_matcher_(MatcherCast<SizeType>(size_matcher)) {}

Abseil Team's avatar
Abseil Team committed
1935
    void DescribeTo(::std::ostream* os) const override {
zhanyong.wan's avatar
zhanyong.wan committed
1936
1937
1938
      *os << "size ";
      size_matcher_.DescribeTo(os);
    }
Abseil Team's avatar
Abseil Team committed
1939
    void DescribeNegationTo(::std::ostream* os) const override {
zhanyong.wan's avatar
zhanyong.wan committed
1940
1941
1942
1943
      *os << "size ";
      size_matcher_.DescribeNegationTo(os);
    }

Abseil Team's avatar
Abseil Team committed
1944
1945
    bool MatchAndExplain(Container container,
                         MatchResultListener* listener) const override {
zhanyong.wan's avatar
zhanyong.wan committed
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
      SizeType size = container.size();
      StringMatchResultListener size_listener;
      const bool result = size_matcher_.MatchAndExplain(size, &size_listener);
      *listener
          << "whose size " << size << (result ? " matches" : " doesn't match");
      PrintIfNotEmpty(size_listener.str(), listener->stream());
      return result;
    }

   private:
    const Matcher<SizeType> size_matcher_;
    GTEST_DISALLOW_ASSIGN_(Impl);
  };

 private:
  const SizeMatcher size_matcher_;
  GTEST_DISALLOW_ASSIGN_(SizeIsMatcher);
};

1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
// Implements a matcher that checks the begin()..end() distance of an STL-style
// container.
template <typename DistanceMatcher>
class BeginEndDistanceIsMatcher {
 public:
  explicit BeginEndDistanceIsMatcher(const DistanceMatcher& distance_matcher)
      : distance_matcher_(distance_matcher) {}

  template <typename Container>
  operator Matcher<Container>() const {
Abseil Team's avatar
Abseil Team committed
1975
    return Matcher<Container>(new Impl<const Container&>(distance_matcher_));
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
  }

  template <typename Container>
  class Impl : public MatcherInterface<Container> {
   public:
    typedef internal::StlContainerView<
        GTEST_REMOVE_REFERENCE_AND_CONST_(Container)> ContainerView;
    typedef typename std::iterator_traits<
        typename ContainerView::type::const_iterator>::difference_type
        DistanceType;
    explicit Impl(const DistanceMatcher& distance_matcher)
        : distance_matcher_(MatcherCast<DistanceType>(distance_matcher)) {}

Abseil Team's avatar
Abseil Team committed
1989
    void DescribeTo(::std::ostream* os) const override {
1990
1991
1992
      *os << "distance between begin() and end() ";
      distance_matcher_.DescribeTo(os);
    }
Abseil Team's avatar
Abseil Team committed
1993
    void DescribeNegationTo(::std::ostream* os) const override {
1994
1995
1996
1997
      *os << "distance between begin() and end() ";
      distance_matcher_.DescribeNegationTo(os);
    }

Abseil Team's avatar
Abseil Team committed
1998
1999
    bool MatchAndExplain(Container container,
                         MatchResultListener* listener) const override {
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
      using std::begin;
      using std::end;
      DistanceType distance = std::distance(begin(container), end(container));
      StringMatchResultListener distance_listener;
      const bool result =
          distance_matcher_.MatchAndExplain(distance, &distance_listener);
      *listener << "whose distance between begin() and end() " << distance
                << (result ? " matches" : " doesn't match");
      PrintIfNotEmpty(distance_listener.str(), listener->stream());
      return result;
    }

   private:
    const Matcher<DistanceType> distance_matcher_;
    GTEST_DISALLOW_ASSIGN_(Impl);
  };

 private:
  const DistanceMatcher distance_matcher_;
  GTEST_DISALLOW_ASSIGN_(BeginEndDistanceIsMatcher);
};

zhanyong.wan's avatar
zhanyong.wan committed
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
// Implements an equality matcher for any STL-style container whose elements
// support ==. This matcher is like Eq(), but its failure explanations provide
// more detailed information that is useful when the container is used as a set.
// The failure message reports elements that are in one of the operands but not
// the other. The failure messages do not report duplicate or out-of-order
// elements in the containers (which don't properly matter to sets, but can
// occur if the containers are vectors or lists, for example).
//
// Uses the container's const_iterator, value_type, operator ==,
// begin(), and end().
template <typename Container>
class ContainerEqMatcher {
 public:
2035
2036
2037
2038
  typedef internal::StlContainerView<Container> View;
  typedef typename View::type StlContainer;
  typedef typename View::const_reference StlContainerReference;

2039
  // We make a copy of expected in case the elements in it are modified
2040
  // after this matcher is created.
2041
2042
  explicit ContainerEqMatcher(const Container& expected)
      : expected_(View::Copy(expected)) {
2043
2044
    // Makes sure the user doesn't instantiate this class template
    // with a const or reference type.
zhanyong.wan's avatar
zhanyong.wan committed
2045
2046
    (void)testing::StaticAssertTypeEq<Container,
        GTEST_REMOVE_REFERENCE_AND_CONST_(Container)>();
2047
2048
  }

zhanyong.wan's avatar
zhanyong.wan committed
2049
2050
  void DescribeTo(::std::ostream* os) const {
    *os << "equals ";
2051
    UniversalPrint(expected_, os);
zhanyong.wan's avatar
zhanyong.wan committed
2052
2053
2054
  }
  void DescribeNegationTo(::std::ostream* os) const {
    *os << "does not equal ";
2055
    UniversalPrint(expected_, os);
zhanyong.wan's avatar
zhanyong.wan committed
2056
2057
  }

2058
  template <typename LhsContainer>
2059
2060
  bool MatchAndExplain(const LhsContainer& lhs,
                       MatchResultListener* listener) const {
2061
    // GTEST_REMOVE_CONST_() is needed to work around an MSVC 8.0 bug
2062
    // that causes LhsContainer to be a const type sometimes.
2063
    typedef internal::StlContainerView<GTEST_REMOVE_CONST_(LhsContainer)>
2064
2065
2066
        LhsView;
    typedef typename LhsView::type LhsStlContainer;
    StlContainerReference lhs_stl_container = LhsView::ConstReference(lhs);
2067
    if (lhs_stl_container == expected_)
2068
      return true;
2069

2070
    ::std::ostream* const os = listener->stream();
2071
    if (os != nullptr) {
2072
      // Something is different. Check for extra values first.
2073
2074
2075
2076
      bool printed_header = false;
      for (typename LhsStlContainer::const_iterator it =
               lhs_stl_container.begin();
           it != lhs_stl_container.end(); ++it) {
2077
2078
        if (internal::ArrayAwareFind(expected_.begin(), expected_.end(), *it) ==
            expected_.end()) {
2079
2080
2081
          if (printed_header) {
            *os << ", ";
          } else {
2082
            *os << "which has these unexpected elements: ";
2083
2084
            printed_header = true;
          }
vladlosev's avatar
vladlosev committed
2085
          UniversalPrint(*it, os);
zhanyong.wan's avatar
zhanyong.wan committed
2086
2087
2088
        }
      }

2089
      // Now check for missing values.
2090
      bool printed_header2 = false;
2091
2092
      for (typename StlContainer::const_iterator it = expected_.begin();
           it != expected_.end(); ++it) {
2093
2094
2095
2096
2097
2098
        if (internal::ArrayAwareFind(
                lhs_stl_container.begin(), lhs_stl_container.end(), *it) ==
            lhs_stl_container.end()) {
          if (printed_header2) {
            *os << ", ";
          } else {
2099
2100
            *os << (printed_header ? ",\nand" : "which")
                << " doesn't have these expected elements: ";
2101
2102
            printed_header2 = true;
          }
vladlosev's avatar
vladlosev committed
2103
          UniversalPrint(*it, os);
zhanyong.wan's avatar
zhanyong.wan committed
2104
2105
2106
        }
      }
    }
2107
2108

    return false;
zhanyong.wan's avatar
zhanyong.wan committed
2109
  }
2110

zhanyong.wan's avatar
zhanyong.wan committed
2111
 private:
2112
  const StlContainer expected_;
2113
2114

  GTEST_DISALLOW_ASSIGN_(ContainerEqMatcher);
zhanyong.wan's avatar
zhanyong.wan committed
2115
2116
};

2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
// A comparator functor that uses the < operator to compare two values.
struct LessComparator {
  template <typename T, typename U>
  bool operator()(const T& lhs, const U& rhs) const { return lhs < rhs; }
};

// Implements WhenSortedBy(comparator, container_matcher).
template <typename Comparator, typename ContainerMatcher>
class WhenSortedByMatcher {
 public:
  WhenSortedByMatcher(const Comparator& comparator,
                      const ContainerMatcher& matcher)
      : comparator_(comparator), matcher_(matcher) {}

  template <typename LhsContainer>
  operator Matcher<LhsContainer>() const {
    return MakeMatcher(new Impl<LhsContainer>(comparator_, matcher_));
  }

  template <typename LhsContainer>
  class Impl : public MatcherInterface<LhsContainer> {
   public:
    typedef internal::StlContainerView<
         GTEST_REMOVE_REFERENCE_AND_CONST_(LhsContainer)> LhsView;
    typedef typename LhsView::type LhsStlContainer;
    typedef typename LhsView::const_reference LhsStlContainerReference;
2143
2144
2145
2146
    // Transforms std::pair<const Key, Value> into std::pair<Key, Value>
    // so that we can match associative containers.
    typedef typename RemoveConstFromKey<
        typename LhsStlContainer::value_type>::type LhsValue;
2147
2148
2149
2150

    Impl(const Comparator& comparator, const ContainerMatcher& matcher)
        : comparator_(comparator), matcher_(matcher) {}

Abseil Team's avatar
Abseil Team committed
2151
    void DescribeTo(::std::ostream* os) const override {
2152
2153
2154
2155
      *os << "(when sorted) ";
      matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
2156
    void DescribeNegationTo(::std::ostream* os) const override {
2157
2158
2159
2160
      *os << "(when sorted) ";
      matcher_.DescribeNegationTo(os);
    }

Abseil Team's avatar
Abseil Team committed
2161
2162
    bool MatchAndExplain(LhsContainer lhs,
                         MatchResultListener* listener) const override {
2163
      LhsStlContainerReference lhs_stl_container = LhsView::ConstReference(lhs);
2164
2165
2166
2167
      ::std::vector<LhsValue> sorted_container(lhs_stl_container.begin(),
                                               lhs_stl_container.end());
      ::std::sort(
           sorted_container.begin(), sorted_container.end(), comparator_);
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187

      if (!listener->IsInterested()) {
        // If the listener is not interested, we do not need to
        // construct the inner explanation.
        return matcher_.Matches(sorted_container);
      }

      *listener << "which is ";
      UniversalPrint(sorted_container, listener->stream());
      *listener << " when sorted";

      StringMatchResultListener inner_listener;
      const bool match = matcher_.MatchAndExplain(sorted_container,
                                                  &inner_listener);
      PrintIfNotEmpty(inner_listener.str(), listener->stream());
      return match;
    }

   private:
    const Comparator comparator_;
2188
    const Matcher<const ::std::vector<LhsValue>&> matcher_;
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199

    GTEST_DISALLOW_COPY_AND_ASSIGN_(Impl);
  };

 private:
  const Comparator comparator_;
  const ContainerMatcher matcher_;

  GTEST_DISALLOW_ASSIGN_(WhenSortedByMatcher);
};

zhanyong.wan's avatar
zhanyong.wan committed
2200
// Implements Pointwise(tuple_matcher, rhs_container).  tuple_matcher
Abseil Team's avatar
Abseil Team committed
2201
// must be able to be safely cast to Matcher<std::tuple<const T1&, const
zhanyong.wan's avatar
zhanyong.wan committed
2202
2203
2204
2205
// T2&> >, where T1 and T2 are the types of elements in the LHS
// container and the RHS container respectively.
template <typename TupleMatcher, typename RhsContainer>
class PointwiseMatcher {
Gennadiy Civil's avatar
Gennadiy Civil committed
2206
2207
2208
2209
  GTEST_COMPILE_ASSERT_(
      !IsHashTable<GTEST_REMOVE_REFERENCE_AND_CONST_(RhsContainer)>::value,
      use_UnorderedPointwise_with_hash_tables);

zhanyong.wan's avatar
zhanyong.wan committed
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
 public:
  typedef internal::StlContainerView<RhsContainer> RhsView;
  typedef typename RhsView::type RhsStlContainer;
  typedef typename RhsStlContainer::value_type RhsValue;

  // Like ContainerEq, we make a copy of rhs in case the elements in
  // it are modified after this matcher is created.
  PointwiseMatcher(const TupleMatcher& tuple_matcher, const RhsContainer& rhs)
      : tuple_matcher_(tuple_matcher), rhs_(RhsView::Copy(rhs)) {
    // Makes sure the user doesn't instantiate this class template
    // with a const or reference type.
    (void)testing::StaticAssertTypeEq<RhsContainer,
        GTEST_REMOVE_REFERENCE_AND_CONST_(RhsContainer)>();
  }

  template <typename LhsContainer>
  operator Matcher<LhsContainer>() const {
Gennadiy Civil's avatar
Gennadiy Civil committed
2227
2228
2229
2230
    GTEST_COMPILE_ASSERT_(
        !IsHashTable<GTEST_REMOVE_REFERENCE_AND_CONST_(LhsContainer)>::value,
        use_UnorderedPointwise_with_hash_tables);

Abseil Team's avatar
Abseil Team committed
2231
2232
    return Matcher<LhsContainer>(
        new Impl<const LhsContainer&>(tuple_matcher_, rhs_));
zhanyong.wan's avatar
zhanyong.wan committed
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
  }

  template <typename LhsContainer>
  class Impl : public MatcherInterface<LhsContainer> {
   public:
    typedef internal::StlContainerView<
         GTEST_REMOVE_REFERENCE_AND_CONST_(LhsContainer)> LhsView;
    typedef typename LhsView::type LhsStlContainer;
    typedef typename LhsView::const_reference LhsStlContainerReference;
    typedef typename LhsStlContainer::value_type LhsValue;
    // We pass the LHS value and the RHS value to the inner matcher by
    // reference, as they may be expensive to copy.  We must use tuple
    // instead of pair here, as a pair cannot hold references (C++ 98,
    // 20.2.2 [lib.pairs]).
Abseil Team's avatar
Abseil Team committed
2247
    typedef ::std::tuple<const LhsValue&, const RhsValue&> InnerMatcherArg;
zhanyong.wan's avatar
zhanyong.wan committed
2248
2249
2250
2251
2252
2253

    Impl(const TupleMatcher& tuple_matcher, const RhsStlContainer& rhs)
        // mono_tuple_matcher_ holds a monomorphic version of the tuple matcher.
        : mono_tuple_matcher_(SafeMatcherCast<InnerMatcherArg>(tuple_matcher)),
          rhs_(rhs) {}

Abseil Team's avatar
Abseil Team committed
2254
    void DescribeTo(::std::ostream* os) const override {
zhanyong.wan's avatar
zhanyong.wan committed
2255
2256
2257
2258
2259
2260
      *os << "contains " << rhs_.size()
          << " values, where each value and its corresponding value in ";
      UniversalPrinter<RhsStlContainer>::Print(rhs_, os);
      *os << " ";
      mono_tuple_matcher_.DescribeTo(os);
    }
Abseil Team's avatar
Abseil Team committed
2261
    void DescribeNegationTo(::std::ostream* os) const override {
zhanyong.wan's avatar
zhanyong.wan committed
2262
2263
2264
2265
2266
2267
2268
2269
      *os << "doesn't contain exactly " << rhs_.size()
          << " values, or contains a value x at some index i"
          << " where x and the i-th value of ";
      UniversalPrint(rhs_, os);
      *os << " ";
      mono_tuple_matcher_.DescribeNegationTo(os);
    }

Abseil Team's avatar
Abseil Team committed
2270
2271
    bool MatchAndExplain(LhsContainer lhs,
                         MatchResultListener* listener) const override {
zhanyong.wan's avatar
zhanyong.wan committed
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
      LhsStlContainerReference lhs_stl_container = LhsView::ConstReference(lhs);
      const size_t actual_size = lhs_stl_container.size();
      if (actual_size != rhs_.size()) {
        *listener << "which contains " << actual_size << " values";
        return false;
      }

      typename LhsStlContainer::const_iterator left = lhs_stl_container.begin();
      typename RhsStlContainer::const_iterator right = rhs_.begin();
      for (size_t i = 0; i != actual_size; ++i, ++left, ++right) {
        if (listener->IsInterested()) {
          StringMatchResultListener inner_listener;
Gennadiy Civil's avatar
Gennadiy Civil committed
2284
2285
2286
          // Create InnerMatcherArg as a temporarily object to avoid it outlives
          // *left and *right. Dereference or the conversion to `const T&` may
          // return temp objects, e.g for vector<bool>.
zhanyong.wan's avatar
zhanyong.wan committed
2287
          if (!mono_tuple_matcher_.MatchAndExplain(
Gennadiy Civil's avatar
Gennadiy Civil committed
2288
2289
2290
                  InnerMatcherArg(ImplicitCast_<const LhsValue&>(*left),
                                  ImplicitCast_<const RhsValue&>(*right)),
                  &inner_listener)) {
zhanyong.wan's avatar
zhanyong.wan committed
2291
2292
2293
2294
2295
2296
2297
2298
2299
            *listener << "where the value pair (";
            UniversalPrint(*left, listener->stream());
            *listener << ", ";
            UniversalPrint(*right, listener->stream());
            *listener << ") at index #" << i << " don't match";
            PrintIfNotEmpty(inner_listener.str(), listener->stream());
            return false;
          }
        } else {
Gennadiy Civil's avatar
Gennadiy Civil committed
2300
2301
2302
          if (!mono_tuple_matcher_.Matches(
                  InnerMatcherArg(ImplicitCast_<const LhsValue&>(*left),
                                  ImplicitCast_<const RhsValue&>(*right))))
zhanyong.wan's avatar
zhanyong.wan committed
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
            return false;
        }
      }

      return true;
    }

   private:
    const Matcher<InnerMatcherArg> mono_tuple_matcher_;
    const RhsStlContainer rhs_;

    GTEST_DISALLOW_ASSIGN_(Impl);
  };

 private:
  const TupleMatcher tuple_matcher_;
  const RhsStlContainer rhs_;

  GTEST_DISALLOW_ASSIGN_(PointwiseMatcher);
};

2324
// Holds the logic common to ContainsMatcherImpl and EachMatcherImpl.
2325
template <typename Container>
2326
class QuantifierMatcherImpl : public MatcherInterface<Container> {
2327
 public:
zhanyong.wan's avatar
zhanyong.wan committed
2328
  typedef GTEST_REMOVE_REFERENCE_AND_CONST_(Container) RawContainer;
2329
2330
2331
2332
2333
2334
  typedef StlContainerView<RawContainer> View;
  typedef typename View::type StlContainer;
  typedef typename View::const_reference StlContainerReference;
  typedef typename StlContainer::value_type Element;

  template <typename InnerMatcher>
2335
  explicit QuantifierMatcherImpl(InnerMatcher inner_matcher)
2336
      : inner_matcher_(
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
           testing::SafeMatcherCast<const Element&>(inner_matcher)) {}

  // Checks whether:
  // * All elements in the container match, if all_elements_should_match.
  // * Any element in the container matches, if !all_elements_should_match.
  bool MatchAndExplainImpl(bool all_elements_should_match,
                           Container container,
                           MatchResultListener* listener) const {
    StlContainerReference stl_container = View::ConstReference(container);
    size_t i = 0;
    for (typename StlContainer::const_iterator it = stl_container.begin();
         it != stl_container.end(); ++it, ++i) {
      StringMatchResultListener inner_listener;
      const bool matches = inner_matcher_.MatchAndExplain(*it, &inner_listener);

      if (matches != all_elements_should_match) {
        *listener << "whose element #" << i
                  << (matches ? " matches" : " doesn't match");
        PrintIfNotEmpty(inner_listener.str(), listener->stream());
        return !all_elements_should_match;
      }
    }
    return all_elements_should_match;
  }

 protected:
  const Matcher<const Element&> inner_matcher_;

  GTEST_DISALLOW_ASSIGN_(QuantifierMatcherImpl);
};

// Implements Contains(element_matcher) for the given argument type Container.
// Symmetric to EachMatcherImpl.
template <typename Container>
class ContainsMatcherImpl : public QuantifierMatcherImpl<Container> {
 public:
  template <typename InnerMatcher>
  explicit ContainsMatcherImpl(InnerMatcher inner_matcher)
      : QuantifierMatcherImpl<Container>(inner_matcher) {}
2376
2377

  // Describes what this matcher does.
Abseil Team's avatar
Abseil Team committed
2378
  void DescribeTo(::std::ostream* os) const override {
2379
    *os << "contains at least one element that ";
2380
    this->inner_matcher_.DescribeTo(os);
2381
2382
  }

Abseil Team's avatar
Abseil Team committed
2383
  void DescribeNegationTo(::std::ostream* os) const override {
2384
    *os << "doesn't contain any element that ";
2385
    this->inner_matcher_.DescribeTo(os);
2386
2387
  }

Abseil Team's avatar
Abseil Team committed
2388
2389
  bool MatchAndExplain(Container container,
                       MatchResultListener* listener) const override {
2390
    return this->MatchAndExplainImpl(false, container, listener);
2391
2392
2393
  }

 private:
2394
  GTEST_DISALLOW_ASSIGN_(ContainsMatcherImpl);
2395
2396
};

2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
// Implements Each(element_matcher) for the given argument type Container.
// Symmetric to ContainsMatcherImpl.
template <typename Container>
class EachMatcherImpl : public QuantifierMatcherImpl<Container> {
 public:
  template <typename InnerMatcher>
  explicit EachMatcherImpl(InnerMatcher inner_matcher)
      : QuantifierMatcherImpl<Container>(inner_matcher) {}

  // Describes what this matcher does.
Abseil Team's avatar
Abseil Team committed
2407
  void DescribeTo(::std::ostream* os) const override {
2408
2409
2410
2411
    *os << "only contains elements that ";
    this->inner_matcher_.DescribeTo(os);
  }

Abseil Team's avatar
Abseil Team committed
2412
  void DescribeNegationTo(::std::ostream* os) const override {
2413
2414
2415
2416
    *os << "contains some element that ";
    this->inner_matcher_.DescribeNegationTo(os);
  }

Abseil Team's avatar
Abseil Team committed
2417
2418
  bool MatchAndExplain(Container container,
                       MatchResultListener* listener) const override {
2419
2420
2421
2422
2423
2424
2425
    return this->MatchAndExplainImpl(true, container, listener);
  }

 private:
  GTEST_DISALLOW_ASSIGN_(EachMatcherImpl);
};

2426
2427
2428
2429
2430
2431
2432
2433
// Implements polymorphic Contains(element_matcher).
template <typename M>
class ContainsMatcher {
 public:
  explicit ContainsMatcher(M m) : inner_matcher_(m) {}

  template <typename Container>
  operator Matcher<Container>() const {
Abseil Team's avatar
Abseil Team committed
2434
2435
    return Matcher<Container>(
        new ContainsMatcherImpl<const Container&>(inner_matcher_));
2436
2437
2438
2439
  }

 private:
  const M inner_matcher_;
2440
2441

  GTEST_DISALLOW_ASSIGN_(ContainsMatcher);
2442
2443
};

2444
2445
2446
2447
2448
2449
2450
2451
// Implements polymorphic Each(element_matcher).
template <typename M>
class EachMatcher {
 public:
  explicit EachMatcher(M m) : inner_matcher_(m) {}

  template <typename Container>
  operator Matcher<Container>() const {
Abseil Team's avatar
Abseil Team committed
2452
2453
    return Matcher<Container>(
        new EachMatcherImpl<const Container&>(inner_matcher_));
2454
2455
2456
2457
2458
2459
2460
2461
  }

 private:
  const M inner_matcher_;

  GTEST_DISALLOW_ASSIGN_(EachMatcher);
};

Gennadiy Civil's avatar
 
Gennadiy Civil committed
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
struct Rank1 {};
struct Rank0 : Rank1 {};

namespace pair_getters {
using std::get;
template <typename T>
auto First(T& x, Rank1) -> decltype(get<0>(x)) {  // NOLINT
  return get<0>(x);
}
template <typename T>
auto First(T& x, Rank0) -> decltype((x.first)) {  // NOLINT
  return x.first;
}

template <typename T>
auto Second(T& x, Rank1) -> decltype(get<1>(x)) {  // NOLINT
  return get<1>(x);
}
template <typename T>
auto Second(T& x, Rank0) -> decltype((x.second)) {  // NOLINT
  return x.second;
}
}  // namespace pair_getters

2486
2487
2488
2489
2490
2491
2492
// Implements Key(inner_matcher) for the given argument pair type.
// Key(inner_matcher) matches an std::pair whose 'first' field matches
// inner_matcher.  For example, Contains(Key(Ge(5))) can be used to match an
// std::map that contains at least one element whose key is >= 5.
template <typename PairType>
class KeyMatcherImpl : public MatcherInterface<PairType> {
 public:
zhanyong.wan's avatar
zhanyong.wan committed
2493
  typedef GTEST_REMOVE_REFERENCE_AND_CONST_(PairType) RawPairType;
2494
2495
2496
2497
2498
2499
2500
2501
2502
  typedef typename RawPairType::first_type KeyType;

  template <typename InnerMatcher>
  explicit KeyMatcherImpl(InnerMatcher inner_matcher)
      : inner_matcher_(
          testing::SafeMatcherCast<const KeyType&>(inner_matcher)) {
  }

  // Returns true iff 'key_value.first' (the key) matches the inner matcher.
Abseil Team's avatar
Abseil Team committed
2503
2504
  bool MatchAndExplain(PairType key_value,
                       MatchResultListener* listener) const override {
2505
    StringMatchResultListener inner_listener;
Gennadiy Civil's avatar
Gennadiy Civil committed
2506
2507
    const bool match = inner_matcher_.MatchAndExplain(
        pair_getters::First(key_value, Rank0()), &inner_listener);
2508
    const std::string explanation = inner_listener.str();
2509
2510
2511
2512
    if (explanation != "") {
      *listener << "whose first field is a value " << explanation;
    }
    return match;
2513
2514
2515
  }

  // Describes what this matcher does.
Abseil Team's avatar
Abseil Team committed
2516
  void DescribeTo(::std::ostream* os) const override {
2517
2518
2519
2520
2521
    *os << "has a key that ";
    inner_matcher_.DescribeTo(os);
  }

  // Describes what the negation of this matcher does.
Abseil Team's avatar
Abseil Team committed
2522
  void DescribeNegationTo(::std::ostream* os) const override {
2523
2524
2525
2526
2527
2528
    *os << "doesn't have a key that ";
    inner_matcher_.DescribeTo(os);
  }

 private:
  const Matcher<const KeyType&> inner_matcher_;
2529
2530

  GTEST_DISALLOW_ASSIGN_(KeyMatcherImpl);
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
};

// Implements polymorphic Key(matcher_for_key).
template <typename M>
class KeyMatcher {
 public:
  explicit KeyMatcher(M m) : matcher_for_key_(m) {}

  template <typename PairType>
  operator Matcher<PairType>() const {
    return MakeMatcher(new KeyMatcherImpl<PairType>(matcher_for_key_));
  }

 private:
  const M matcher_for_key_;
2546
2547

  GTEST_DISALLOW_ASSIGN_(KeyMatcher);
2548
2549
};

2550
2551
2552
2553
2554
// Implements Pair(first_matcher, second_matcher) for the given argument pair
// type with its two matchers. See Pair() function below.
template <typename PairType>
class PairMatcherImpl : public MatcherInterface<PairType> {
 public:
zhanyong.wan's avatar
zhanyong.wan committed
2555
  typedef GTEST_REMOVE_REFERENCE_AND_CONST_(PairType) RawPairType;
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
  typedef typename RawPairType::first_type FirstType;
  typedef typename RawPairType::second_type SecondType;

  template <typename FirstMatcher, typename SecondMatcher>
  PairMatcherImpl(FirstMatcher first_matcher, SecondMatcher second_matcher)
      : first_matcher_(
            testing::SafeMatcherCast<const FirstType&>(first_matcher)),
        second_matcher_(
            testing::SafeMatcherCast<const SecondType&>(second_matcher)) {
  }

  // Describes what this matcher does.
Abseil Team's avatar
Abseil Team committed
2568
  void DescribeTo(::std::ostream* os) const override {
2569
2570
2571
2572
2573
2574
2575
    *os << "has a first field that ";
    first_matcher_.DescribeTo(os);
    *os << ", and has a second field that ";
    second_matcher_.DescribeTo(os);
  }

  // Describes what the negation of this matcher does.
Abseil Team's avatar
Abseil Team committed
2576
  void DescribeNegationTo(::std::ostream* os) const override {
2577
2578
2579
2580
2581
2582
    *os << "has a first field that ";
    first_matcher_.DescribeNegationTo(os);
    *os << ", or has a second field that ";
    second_matcher_.DescribeNegationTo(os);
  }

zhanyong.wan's avatar
zhanyong.wan committed
2583
2584
  // Returns true iff 'a_pair.first' matches first_matcher and 'a_pair.second'
  // matches second_matcher.
Abseil Team's avatar
Abseil Team committed
2585
2586
  bool MatchAndExplain(PairType a_pair,
                       MatchResultListener* listener) const override {
2587
2588
2589
    if (!listener->IsInterested()) {
      // If the listener is not interested, we don't need to construct the
      // explanation.
Gennadiy Civil's avatar
Gennadiy Civil committed
2590
2591
      return first_matcher_.Matches(pair_getters::First(a_pair, Rank0())) &&
             second_matcher_.Matches(pair_getters::Second(a_pair, Rank0()));
zhanyong.wan's avatar
zhanyong.wan committed
2592
    }
2593
    StringMatchResultListener first_inner_listener;
Gennadiy Civil's avatar
Gennadiy Civil committed
2594
    if (!first_matcher_.MatchAndExplain(pair_getters::First(a_pair, Rank0()),
2595
2596
                                        &first_inner_listener)) {
      *listener << "whose first field does not match";
2597
      PrintIfNotEmpty(first_inner_listener.str(), listener->stream());
zhanyong.wan's avatar
zhanyong.wan committed
2598
      return false;
2599
    }
2600
    StringMatchResultListener second_inner_listener;
Gennadiy Civil's avatar
Gennadiy Civil committed
2601
    if (!second_matcher_.MatchAndExplain(pair_getters::Second(a_pair, Rank0()),
2602
2603
                                         &second_inner_listener)) {
      *listener << "whose second field does not match";
2604
      PrintIfNotEmpty(second_inner_listener.str(), listener->stream());
zhanyong.wan's avatar
zhanyong.wan committed
2605
      return false;
2606
    }
2607
2608
    ExplainSuccess(first_inner_listener.str(), second_inner_listener.str(),
                   listener);
zhanyong.wan's avatar
zhanyong.wan committed
2609
    return true;
2610
2611
2612
  }

 private:
2613
2614
  void ExplainSuccess(const std::string& first_explanation,
                      const std::string& second_explanation,
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
                      MatchResultListener* listener) const {
    *listener << "whose both fields match";
    if (first_explanation != "") {
      *listener << ", where the first field is a value " << first_explanation;
    }
    if (second_explanation != "") {
      *listener << ", ";
      if (first_explanation != "") {
        *listener << "and ";
      } else {
        *listener << "where ";
      }
      *listener << "the second field is a value " << second_explanation;
    }
  }

2631
2632
  const Matcher<const FirstType&> first_matcher_;
  const Matcher<const SecondType&> second_matcher_;
2633
2634

  GTEST_DISALLOW_ASSIGN_(PairMatcherImpl);
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
};

// Implements polymorphic Pair(first_matcher, second_matcher).
template <typename FirstMatcher, typename SecondMatcher>
class PairMatcher {
 public:
  PairMatcher(FirstMatcher first_matcher, SecondMatcher second_matcher)
      : first_matcher_(first_matcher), second_matcher_(second_matcher) {}

  template <typename PairType>
  operator Matcher<PairType> () const {
    return MakeMatcher(
        new PairMatcherImpl<PairType>(
            first_matcher_, second_matcher_));
  }

 private:
  const FirstMatcher first_matcher_;
  const SecondMatcher second_matcher_;
2654
2655

  GTEST_DISALLOW_ASSIGN_(PairMatcher);
2656
2657
};

2658
2659
2660
2661
// Implements ElementsAre() and ElementsAreArray().
template <typename Container>
class ElementsAreMatcherImpl : public MatcherInterface<Container> {
 public:
zhanyong.wan's avatar
zhanyong.wan committed
2662
  typedef GTEST_REMOVE_REFERENCE_AND_CONST_(Container) RawContainer;
2663
2664
2665
2666
2667
2668
2669
2670
  typedef internal::StlContainerView<RawContainer> View;
  typedef typename View::type StlContainer;
  typedef typename View::const_reference StlContainerReference;
  typedef typename StlContainer::value_type Element;

  // Constructs the matcher from a sequence of element values or
  // element matchers.
  template <typename InputIter>
2671
2672
2673
  ElementsAreMatcherImpl(InputIter first, InputIter last) {
    while (first != last) {
      matchers_.push_back(MatcherCast<const Element&>(*first++));
2674
2675
2676
2677
    }
  }

  // Describes what this matcher does.
Abseil Team's avatar
Abseil Team committed
2678
  void DescribeTo(::std::ostream* os) const override {
2679
2680
2681
2682
2683
2684
2685
2686
    if (count() == 0) {
      *os << "is empty";
    } else if (count() == 1) {
      *os << "has 1 element that ";
      matchers_[0].DescribeTo(os);
    } else {
      *os << "has " << Elements(count()) << " where\n";
      for (size_t i = 0; i != count(); ++i) {
2687
        *os << "element #" << i << " ";
2688
2689
2690
2691
2692
2693
2694
2695
2696
        matchers_[i].DescribeTo(os);
        if (i + 1 < count()) {
          *os << ",\n";
        }
      }
    }
  }

  // Describes what the negation of this matcher does.
Abseil Team's avatar
Abseil Team committed
2697
  void DescribeNegationTo(::std::ostream* os) const override {
2698
    if (count() == 0) {
2699
      *os << "isn't empty";
2700
2701
2702
      return;
    }

2703
    *os << "doesn't have " << Elements(count()) << ", or\n";
2704
    for (size_t i = 0; i != count(); ++i) {
2705
      *os << "element #" << i << " ";
2706
2707
2708
2709
2710
2711
2712
      matchers_[i].DescribeNegationTo(os);
      if (i + 1 < count()) {
        *os << ", or\n";
      }
    }
  }

Abseil Team's avatar
Abseil Team committed
2713
2714
  bool MatchAndExplain(Container container,
                       MatchResultListener* listener) const override {
2715
2716
2717
2718
2719
2720
    // To work with stream-like "containers", we must only walk
    // through the elements in one pass.

    const bool listener_interested = listener->IsInterested();

    // explanations[i] is the explanation of the element at index i.
2721
    ::std::vector<std::string> explanations(count());
2722
    StlContainerReference stl_container = View::ConstReference(container);
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
    typename StlContainer::const_iterator it = stl_container.begin();
    size_t exam_pos = 0;
    bool mismatch_found = false;  // Have we found a mismatched element yet?

    // Go through the elements and matchers in pairs, until we reach
    // the end of either the elements or the matchers, or until we find a
    // mismatch.
    for (; it != stl_container.end() && exam_pos != count(); ++it, ++exam_pos) {
      bool match;  // Does the current element match the current matcher?
      if (listener_interested) {
        StringMatchResultListener s;
        match = matchers_[exam_pos].MatchAndExplain(*it, &s);
        explanations[exam_pos] = s.str();
      } else {
        match = matchers_[exam_pos].Matches(*it);
      }

      if (!match) {
        mismatch_found = true;
        break;
      }
    }
    // If mismatch_found is true, 'exam_pos' is the index of the mismatch.

    // Find how many elements the actual container has.  We avoid
    // calling size() s.t. this code works for stream-like "containers"
    // that don't define size().
    size_t actual_count = exam_pos;
    for (; it != stl_container.end(); ++it) {
      ++actual_count;
    }

zhanyong.wan's avatar
zhanyong.wan committed
2755
2756
2757
2758
2759
    if (actual_count != count()) {
      // The element count doesn't match.  If the container is empty,
      // there's no need to explain anything as Google Mock already
      // prints the empty container.  Otherwise we just need to show
      // how many elements there actually are.
2760
      if (listener_interested && (actual_count != 0)) {
2761
        *listener << "which has " << Elements(actual_count);
2762
      }
zhanyong.wan's avatar
zhanyong.wan committed
2763
2764
      return false;
    }
2765

2766
2767
2768
2769
2770
    if (mismatch_found) {
      // The element count matches, but the exam_pos-th element doesn't match.
      if (listener_interested) {
        *listener << "whose element #" << exam_pos << " doesn't match";
        PrintIfNotEmpty(explanations[exam_pos], listener->stream());
zhanyong.wan's avatar
zhanyong.wan committed
2771
      }
2772
      return false;
zhanyong.wan's avatar
zhanyong.wan committed
2773
    }
2774

zhanyong.wan's avatar
zhanyong.wan committed
2775
2776
    // Every element matches its expectation.  We need to explain why
    // (the obvious ones can be skipped).
2777
2778
2779
    if (listener_interested) {
      bool reason_printed = false;
      for (size_t i = 0; i != count(); ++i) {
2780
        const std::string& s = explanations[i];
2781
2782
2783
2784
2785
2786
        if (!s.empty()) {
          if (reason_printed) {
            *listener << ",\nand ";
          }
          *listener << "whose element #" << i << " matches, " << s;
          reason_printed = true;
2787
2788
2789
        }
      }
    }
zhanyong.wan's avatar
zhanyong.wan committed
2790
    return true;
2791
2792
2793
2794
2795
2796
2797
2798
  }

 private:
  static Message Elements(size_t count) {
    return Message() << count << (count == 1 ? " element" : " elements");
  }

  size_t count() const { return matchers_.size(); }
2799
2800

  ::std::vector<Matcher<const Element&> > matchers_;
2801
2802

  GTEST_DISALLOW_ASSIGN_(ElementsAreMatcherImpl);
2803
2804
};

2805
2806
2807
2808
2809
// Connectivity matrix of (elements X matchers), in element-major order.
// Initially, there are no edges.
// Use NextGraph() to iterate over all possible edge configurations.
// Use Randomize() to generate a random edge configuration.
class GTEST_API_ MatchMatrix {
2810
 public:
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
  MatchMatrix(size_t num_elements, size_t num_matchers)
      : num_elements_(num_elements),
        num_matchers_(num_matchers),
        matched_(num_elements_* num_matchers_, 0) {
  }

  size_t LhsSize() const { return num_elements_; }
  size_t RhsSize() const { return num_matchers_; }
  bool HasEdge(size_t ilhs, size_t irhs) const {
    return matched_[SpaceIndex(ilhs, irhs)] == 1;
  }
  void SetEdge(size_t ilhs, size_t irhs, bool b) {
    matched_[SpaceIndex(ilhs, irhs)] = b ? 1 : 0;
  }

  // Treating the connectivity matrix as a (LhsSize()*RhsSize())-bit number,
  // adds 1 to that number; returns false if incrementing the graph left it
  // empty.
  bool NextGraph();

  void Randomize();

2833
  std::string DebugString() const;
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856

 private:
  size_t SpaceIndex(size_t ilhs, size_t irhs) const {
    return ilhs * num_matchers_ + irhs;
  }

  size_t num_elements_;
  size_t num_matchers_;

  // Each element is a char interpreted as bool. They are stored as a
  // flattened array in lhs-major order, use 'SpaceIndex()' to translate
  // a (ilhs, irhs) matrix coordinate into an offset.
  ::std::vector<char> matched_;
};

typedef ::std::pair<size_t, size_t> ElementMatcherPair;
typedef ::std::vector<ElementMatcherPair> ElementMatcherPairs;

// Returns a maximum bipartite matching for the specified graph 'g'.
// The matching is represented as a vector of {element, matcher} pairs.
GTEST_API_ ElementMatcherPairs
FindMaxBipartiteMatching(const MatchMatrix& g);

Gennadiy Civil's avatar
Gennadiy Civil committed
2857
2858
2859
2860
2861
2862
2863
struct UnorderedMatcherRequire {
  enum Flags {
    Superset = 1 << 0,
    Subset = 1 << 1,
    ExactMatch = Superset | Subset,
  };
};
2864
2865
2866
2867
2868
2869

// Untyped base class for implementing UnorderedElementsAre.  By
// putting logic that's not specific to the element type here, we
// reduce binary bloat and increase compilation speed.
class GTEST_API_ UnorderedElementsAreMatcherImplBase {
 protected:
Gennadiy Civil's avatar
Gennadiy Civil committed
2870
2871
2872
2873
  explicit UnorderedElementsAreMatcherImplBase(
      UnorderedMatcherRequire::Flags matcher_flags)
      : match_flags_(matcher_flags) {}

2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
  // A vector of matcher describers, one for each element matcher.
  // Does not own the describers (and thus can be used only when the
  // element matchers are alive).
  typedef ::std::vector<const MatcherDescriberInterface*> MatcherDescriberVec;

  // Describes this UnorderedElementsAre matcher.
  void DescribeToImpl(::std::ostream* os) const;

  // Describes the negation of this UnorderedElementsAre matcher.
  void DescribeNegationToImpl(::std::ostream* os) const;

Gennadiy Civil's avatar
Gennadiy Civil committed
2885
2886
2887
2888
2889
2890
  bool VerifyMatchMatrix(const ::std::vector<std::string>& element_printouts,
                         const MatchMatrix& matrix,
                         MatchResultListener* listener) const;

  bool FindPairing(const MatchMatrix& matrix,
                   MatchResultListener* listener) const;
2891
2892
2893
2894
2895
2896
2897
2898
2899

  MatcherDescriberVec& matcher_describers() {
    return matcher_describers_;
  }

  static Message Elements(size_t n) {
    return Message() << n << " element" << (n == 1 ? "" : "s");
  }

Gennadiy Civil's avatar
Gennadiy Civil committed
2900
2901
  UnorderedMatcherRequire::Flags match_flags() const { return match_flags_; }

2902
 private:
Gennadiy Civil's avatar
Gennadiy Civil committed
2903
  UnorderedMatcherRequire::Flags match_flags_;
2904
2905
2906
2907
2908
  MatcherDescriberVec matcher_describers_;

  GTEST_DISALLOW_ASSIGN_(UnorderedElementsAreMatcherImplBase);
};

Gennadiy Civil's avatar
Gennadiy Civil committed
2909
2910
// Implements UnorderedElementsAre, UnorderedElementsAreArray, IsSubsetOf, and
// IsSupersetOf.
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
template <typename Container>
class UnorderedElementsAreMatcherImpl
    : public MatcherInterface<Container>,
      public UnorderedElementsAreMatcherImplBase {
 public:
  typedef GTEST_REMOVE_REFERENCE_AND_CONST_(Container) RawContainer;
  typedef internal::StlContainerView<RawContainer> View;
  typedef typename View::type StlContainer;
  typedef typename View::const_reference StlContainerReference;
  typedef typename StlContainer::const_iterator StlContainerConstIterator;
  typedef typename StlContainer::value_type Element;

  template <typename InputIter>
Gennadiy Civil's avatar
Gennadiy Civil committed
2924
2925
2926
  UnorderedElementsAreMatcherImpl(UnorderedMatcherRequire::Flags matcher_flags,
                                  InputIter first, InputIter last)
      : UnorderedElementsAreMatcherImplBase(matcher_flags) {
2927
2928
2929
2930
2931
2932
2933
    for (; first != last; ++first) {
      matchers_.push_back(MatcherCast<const Element&>(*first));
      matcher_describers().push_back(matchers_.back().GetDescriber());
    }
  }

  // Describes what this matcher does.
Abseil Team's avatar
Abseil Team committed
2934
  void DescribeTo(::std::ostream* os) const override {
2935
2936
2937
2938
    return UnorderedElementsAreMatcherImplBase::DescribeToImpl(os);
  }

  // Describes what the negation of this matcher does.
Abseil Team's avatar
Abseil Team committed
2939
  void DescribeNegationTo(::std::ostream* os) const override {
2940
2941
2942
    return UnorderedElementsAreMatcherImplBase::DescribeNegationToImpl(os);
  }

Abseil Team's avatar
Abseil Team committed
2943
2944
  bool MatchAndExplain(Container container,
                       MatchResultListener* listener) const override {
2945
    StlContainerReference stl_container = View::ConstReference(container);
2946
    ::std::vector<std::string> element_printouts;
Gennadiy Civil's avatar
Gennadiy Civil committed
2947
2948
2949
    MatchMatrix matrix =
        AnalyzeElements(stl_container.begin(), stl_container.end(),
                        &element_printouts, listener);
2950

Gennadiy Civil's avatar
Gennadiy Civil committed
2951
    if (matrix.LhsSize() == 0 && matrix.RhsSize() == 0) {
2952
2953
      return true;
    }
Gennadiy Civil's avatar
Gennadiy Civil committed
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964

    if (match_flags() == UnorderedMatcherRequire::ExactMatch) {
      if (matrix.LhsSize() != matrix.RhsSize()) {
        // The element count doesn't match.  If the container is empty,
        // there's no need to explain anything as Google Mock already
        // prints the empty container. Otherwise we just need to show
        // how many elements there actually are.
        if (matrix.LhsSize() != 0 && listener->IsInterested()) {
          *listener << "which has " << Elements(matrix.LhsSize());
        }
        return false;
2965
2966
2967
      }
    }

Gennadiy Civil's avatar
Gennadiy Civil committed
2968
    return VerifyMatchMatrix(element_printouts, matrix, listener) &&
2969
2970
2971
2972
2973
2974
           FindPairing(matrix, listener);
  }

 private:
  template <typename ElementIter>
  MatchMatrix AnalyzeElements(ElementIter elem_first, ElementIter elem_last,
2975
                              ::std::vector<std::string>* element_printouts,
2976
                              MatchResultListener* listener) const {
2977
    element_printouts->clear();
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
    ::std::vector<char> did_match;
    size_t num_elements = 0;
    for (; elem_first != elem_last; ++num_elements, ++elem_first) {
      if (listener->IsInterested()) {
        element_printouts->push_back(PrintToString(*elem_first));
      }
      for (size_t irhs = 0; irhs != matchers_.size(); ++irhs) {
        did_match.push_back(Matches(matchers_[irhs])(*elem_first));
      }
    }

    MatchMatrix matrix(num_elements, matchers_.size());
    ::std::vector<char>::const_iterator did_match_iter = did_match.begin();
    for (size_t ilhs = 0; ilhs != num_elements; ++ilhs) {
      for (size_t irhs = 0; irhs != matchers_.size(); ++irhs) {
        matrix.SetEdge(ilhs, irhs, *did_match_iter++ != 0);
      }
    }
    return matrix;
  }

Gennadiy Civil's avatar
Gennadiy Civil committed
2999
  ::std::vector<Matcher<const Element&> > matchers_;
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027

  GTEST_DISALLOW_ASSIGN_(UnorderedElementsAreMatcherImpl);
};

// Functor for use in TransformTuple.
// Performs MatcherCast<Target> on an input argument of any type.
template <typename Target>
struct CastAndAppendTransform {
  template <typename Arg>
  Matcher<Target> operator()(const Arg& a) const {
    return MatcherCast<Target>(a);
  }
};

// Implements UnorderedElementsAre.
template <typename MatcherTuple>
class UnorderedElementsAreMatcher {
 public:
  explicit UnorderedElementsAreMatcher(const MatcherTuple& args)
      : matchers_(args) {}

  template <typename Container>
  operator Matcher<Container>() const {
    typedef GTEST_REMOVE_REFERENCE_AND_CONST_(Container) RawContainer;
    typedef typename internal::StlContainerView<RawContainer>::type View;
    typedef typename View::value_type Element;
    typedef ::std::vector<Matcher<const Element&> > MatcherVec;
    MatcherVec matchers;
Abseil Team's avatar
Abseil Team committed
3028
    matchers.reserve(::std::tuple_size<MatcherTuple>::value);
3029
3030
    TransformTupleValues(CastAndAppendTransform<const Element&>(), matchers_,
                         ::std::back_inserter(matchers));
Abseil Team's avatar
Abseil Team committed
3031
3032
3033
3034
    return Matcher<Container>(
        new UnorderedElementsAreMatcherImpl<const Container&>(
            UnorderedMatcherRequire::ExactMatch, matchers.begin(),
            matchers.end()));
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
  }

 private:
  const MatcherTuple matchers_;
  GTEST_DISALLOW_ASSIGN_(UnorderedElementsAreMatcher);
};

// Implements ElementsAre.
template <typename MatcherTuple>
class ElementsAreMatcher {
 public:
  explicit ElementsAreMatcher(const MatcherTuple& args) : matchers_(args) {}
3047
3048
3049

  template <typename Container>
  operator Matcher<Container>() const {
Gennadiy Civil's avatar
Gennadiy Civil committed
3050
3051
    GTEST_COMPILE_ASSERT_(
        !IsHashTable<GTEST_REMOVE_REFERENCE_AND_CONST_(Container)>::value ||
Abseil Team's avatar
Abseil Team committed
3052
            ::std::tuple_size<MatcherTuple>::value < 2,
Gennadiy Civil's avatar
Gennadiy Civil committed
3053
3054
        use_UnorderedElementsAre_with_hash_tables);

zhanyong.wan's avatar
zhanyong.wan committed
3055
    typedef GTEST_REMOVE_REFERENCE_AND_CONST_(Container) RawContainer;
3056
3057
3058
3059
    typedef typename internal::StlContainerView<RawContainer>::type View;
    typedef typename View::value_type Element;
    typedef ::std::vector<Matcher<const Element&> > MatcherVec;
    MatcherVec matchers;
Abseil Team's avatar
Abseil Team committed
3060
    matchers.reserve(::std::tuple_size<MatcherTuple>::value);
3061
3062
    TransformTupleValues(CastAndAppendTransform<const Element&>(), matchers_,
                         ::std::back_inserter(matchers));
Abseil Team's avatar
Abseil Team committed
3063
3064
    return Matcher<Container>(new ElementsAreMatcherImpl<const Container&>(
        matchers.begin(), matchers.end()));
3065
3066
3067
3068
3069
3070
  }

 private:
  const MatcherTuple matchers_;
  GTEST_DISALLOW_ASSIGN_(ElementsAreMatcher);
};
3071

Gennadiy Civil's avatar
Gennadiy Civil committed
3072
// Implements UnorderedElementsAreArray(), IsSubsetOf(), and IsSupersetOf().
3073
3074
3075
3076
template <typename T>
class UnorderedElementsAreArrayMatcher {
 public:
  template <typename Iter>
Gennadiy Civil's avatar
Gennadiy Civil committed
3077
3078
3079
  UnorderedElementsAreArrayMatcher(UnorderedMatcherRequire::Flags match_flags,
                                   Iter first, Iter last)
      : match_flags_(match_flags), matchers_(first, last) {}
3080
3081
3082

  template <typename Container>
  operator Matcher<Container>() const {
Abseil Team's avatar
Abseil Team committed
3083
3084
3085
    return Matcher<Container>(
        new UnorderedElementsAreMatcherImpl<const Container&>(
            match_flags_, matchers_.begin(), matchers_.end()));
3086
  }
3087
3088

 private:
Gennadiy Civil's avatar
Gennadiy Civil committed
3089
  UnorderedMatcherRequire::Flags match_flags_;
3090
3091
3092
  ::std::vector<T> matchers_;

  GTEST_DISALLOW_ASSIGN_(UnorderedElementsAreArrayMatcher);
3093
3094
3095
3096
3097
3098
};

// Implements ElementsAreArray().
template <typename T>
class ElementsAreArrayMatcher {
 public:
3099
3100
  template <typename Iter>
  ElementsAreArrayMatcher(Iter first, Iter last) : matchers_(first, last) {}
3101
3102
3103

  template <typename Container>
  operator Matcher<Container>() const {
Gennadiy Civil's avatar
Gennadiy Civil committed
3104
3105
3106
3107
    GTEST_COMPILE_ASSERT_(
        !IsHashTable<GTEST_REMOVE_REFERENCE_AND_CONST_(Container)>::value,
        use_UnorderedElementsAreArray_with_hash_tables);

Abseil Team's avatar
Abseil Team committed
3108
    return Matcher<Container>(new ElementsAreMatcherImpl<const Container&>(
3109
        matchers_.begin(), matchers_.end()));
3110
3111
3112
  }

 private:
3113
  const ::std::vector<T> matchers_;
3114
3115

  GTEST_DISALLOW_ASSIGN_(ElementsAreArrayMatcher);
3116
3117
};

3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
// Given a 2-tuple matcher tm of type Tuple2Matcher and a value second
// of type Second, BoundSecondMatcher<Tuple2Matcher, Second>(tm,
// second) is a polymorphic matcher that matches a value x iff tm
// matches tuple (x, second).  Useful for implementing
// UnorderedPointwise() in terms of UnorderedElementsAreArray().
//
// BoundSecondMatcher is copyable and assignable, as we need to put
// instances of this class in a vector when implementing
// UnorderedPointwise().
template <typename Tuple2Matcher, typename Second>
class BoundSecondMatcher {
 public:
  BoundSecondMatcher(const Tuple2Matcher& tm, const Second& second)
      : tuple2_matcher_(tm), second_value_(second) {}

  template <typename T>
  operator Matcher<T>() const {
    return MakeMatcher(new Impl<T>(tuple2_matcher_, second_value_));
  }

  // We have to define this for UnorderedPointwise() to compile in
  // C++98 mode, as it puts BoundSecondMatcher instances in a vector,
  // which requires the elements to be assignable in C++98.  The
  // compiler cannot generate the operator= for us, as Tuple2Matcher
  // and Second may not be assignable.
  //
  // However, this should never be called, so the implementation just
  // need to assert.
  void operator=(const BoundSecondMatcher& /*rhs*/) {
    GTEST_LOG_(FATAL) << "BoundSecondMatcher should never be assigned.";
  }

 private:
  template <typename T>
  class Impl : public MatcherInterface<T> {
   public:
Abseil Team's avatar
Abseil Team committed
3154
    typedef ::std::tuple<T, Second> ArgTuple;
3155
3156
3157
3158
3159

    Impl(const Tuple2Matcher& tm, const Second& second)
        : mono_tuple2_matcher_(SafeMatcherCast<const ArgTuple&>(tm)),
          second_value_(second) {}

Abseil Team's avatar
Abseil Team committed
3160
    void DescribeTo(::std::ostream* os) const override {
3161
3162
3163
3164
3165
3166
      *os << "and ";
      UniversalPrint(second_value_, os);
      *os << " ";
      mono_tuple2_matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
3167
    bool MatchAndExplain(T x, MatchResultListener* listener) const override {
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
      return mono_tuple2_matcher_.MatchAndExplain(ArgTuple(x, second_value_),
                                                  listener);
    }

   private:
    const Matcher<const ArgTuple&> mono_tuple2_matcher_;
    const Second second_value_;

    GTEST_DISALLOW_ASSIGN_(Impl);
  };

  const Tuple2Matcher tuple2_matcher_;
  const Second second_value_;
};

// Given a 2-tuple matcher tm and a value second,
// MatcherBindSecond(tm, second) returns a matcher that matches a
// value x iff tm matches tuple (x, second).  Useful for implementing
// UnorderedPointwise() in terms of UnorderedElementsAreArray().
template <typename Tuple2Matcher, typename Second>
BoundSecondMatcher<Tuple2Matcher, Second> MatcherBindSecond(
    const Tuple2Matcher& tm, const Second& second) {
  return BoundSecondMatcher<Tuple2Matcher, Second>(tm, second);
}

3193
3194
3195
3196
3197
// Returns the description for a matcher defined using the MATCHER*()
// macro where the user-supplied description string is "", if
// 'negation' is false; otherwise returns the description of the
// negation of the matcher.  'param_values' contains a list of strings
// that are the print-out of the matcher's parameters.
3198
3199
3200
GTEST_API_ std::string FormatMatcherDescription(bool negation,
                                                const char* matcher_name,
                                                const Strings& param_values);
3201

Gennadiy Civil's avatar
Gennadiy Civil committed
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
// Implements a matcher that checks the value of a optional<> type variable.
template <typename ValueMatcher>
class OptionalMatcher {
 public:
  explicit OptionalMatcher(const ValueMatcher& value_matcher)
      : value_matcher_(value_matcher) {}

  template <typename Optional>
  operator Matcher<Optional>() const {
    return MakeMatcher(new Impl<Optional>(value_matcher_));
  }

  template <typename Optional>
  class Impl : public MatcherInterface<Optional> {
   public:
    typedef GTEST_REMOVE_REFERENCE_AND_CONST_(Optional) OptionalView;
    typedef typename OptionalView::value_type ValueType;
    explicit Impl(const ValueMatcher& value_matcher)
        : value_matcher_(MatcherCast<ValueType>(value_matcher)) {}

Abseil Team's avatar
Abseil Team committed
3222
    void DescribeTo(::std::ostream* os) const override {
Gennadiy Civil's avatar
Gennadiy Civil committed
3223
3224
3225
3226
      *os << "value ";
      value_matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
3227
    void DescribeNegationTo(::std::ostream* os) const override {
Gennadiy Civil's avatar
Gennadiy Civil committed
3228
3229
3230
3231
      *os << "value ";
      value_matcher_.DescribeNegationTo(os);
    }

Abseil Team's avatar
Abseil Team committed
3232
3233
    bool MatchAndExplain(Optional optional,
                         MatchResultListener* listener) const override {
Gennadiy Civil's avatar
Gennadiy Civil committed
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
      if (!optional) {
        *listener << "which is not engaged";
        return false;
      }
      const ValueType& value = *optional;
      StringMatchResultListener value_listener;
      const bool match = value_matcher_.MatchAndExplain(value, &value_listener);
      *listener << "whose value " << PrintToString(value)
                << (match ? " matches" : " doesn't match");
      PrintIfNotEmpty(value_listener.str(), listener->stream());
      return match;
    }

   private:
    const Matcher<ValueType> value_matcher_;
    GTEST_DISALLOW_ASSIGN_(Impl);
  };

 private:
  const ValueMatcher value_matcher_;
  GTEST_DISALLOW_ASSIGN_(OptionalMatcher);
};

Xiaoyi Zhang's avatar
Xiaoyi Zhang committed
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
namespace variant_matcher {
// Overloads to allow VariantMatcher to do proper ADL lookup.
template <typename T>
void holds_alternative() {}
template <typename T>
void get() {}

// Implements a matcher that checks the value of a variant<> type variable.
template <typename T>
class VariantMatcher {
 public:
  explicit VariantMatcher(::testing::Matcher<const T&> matcher)
Abseil Team's avatar
Abseil Team committed
3269
      : matcher_(std::move(matcher)) {}
Xiaoyi Zhang's avatar
Xiaoyi Zhang committed
3270
3271
3272
3273

  template <typename Variant>
  bool MatchAndExplain(const Variant& value,
                       ::testing::MatchResultListener* listener) const {
Abseil Team's avatar
Abseil Team committed
3274
    using std::get;
Xiaoyi Zhang's avatar
Xiaoyi Zhang committed
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
    if (!listener->IsInterested()) {
      return holds_alternative<T>(value) && matcher_.Matches(get<T>(value));
    }

    if (!holds_alternative<T>(value)) {
      *listener << "whose value is not of type '" << GetTypeName() << "'";
      return false;
    }

    const T& elem = get<T>(value);
    StringMatchResultListener elem_listener;
    const bool match = matcher_.MatchAndExplain(elem, &elem_listener);
    *listener << "whose value " << PrintToString(elem)
              << (match ? " matches" : " doesn't match");
    PrintIfNotEmpty(elem_listener.str(), listener->stream());
    return match;
  }

  void DescribeTo(std::ostream* os) const {
    *os << "is a variant<> with value of type '" << GetTypeName()
        << "' and the value ";
    matcher_.DescribeTo(os);
  }

  void DescribeNegationTo(std::ostream* os) const {
    *os << "is a variant<> with value of type other than '" << GetTypeName()
        << "' or the value ";
    matcher_.DescribeNegationTo(os);
  }

 private:
Gennadiy Civil's avatar
Gennadiy Civil committed
3306
  static std::string GetTypeName() {
Xiaoyi Zhang's avatar
Xiaoyi Zhang committed
3307
#if GTEST_HAS_RTTI
Gennadiy Civil's avatar
 
Gennadiy Civil committed
3308
3309
    GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(
        return internal::GetTypeName<T>());
Xiaoyi Zhang's avatar
Xiaoyi Zhang committed
3310
3311
3312
3313
3314
3315
3316
3317
3318
#endif
    return "the element type";
  }

  const ::testing::Matcher<const T&> matcher_;
};

}  // namespace variant_matcher

Gennadiy Civil's avatar
 
Gennadiy Civil committed
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
namespace any_cast_matcher {

// Overloads to allow AnyCastMatcher to do proper ADL lookup.
template <typename T>
void any_cast() {}

// Implements a matcher that any_casts the value.
template <typename T>
class AnyCastMatcher {
 public:
  explicit AnyCastMatcher(const ::testing::Matcher<const T&>& matcher)
      : matcher_(matcher) {}

  template <typename AnyType>
  bool MatchAndExplain(const AnyType& value,
                       ::testing::MatchResultListener* listener) const {
    if (!listener->IsInterested()) {
      const T* ptr = any_cast<T>(&value);
3337
      return ptr != nullptr && matcher_.Matches(*ptr);
Gennadiy Civil's avatar
 
Gennadiy Civil committed
3338
3339
3340
    }

    const T* elem = any_cast<T>(&value);
3341
    if (elem == nullptr) {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
      *listener << "whose value is not of type '" << GetTypeName() << "'";
      return false;
    }

    StringMatchResultListener elem_listener;
    const bool match = matcher_.MatchAndExplain(*elem, &elem_listener);
    *listener << "whose value " << PrintToString(*elem)
              << (match ? " matches" : " doesn't match");
    PrintIfNotEmpty(elem_listener.str(), listener->stream());
    return match;
  }

  void DescribeTo(std::ostream* os) const {
    *os << "is an 'any' type with value of type '" << GetTypeName()
        << "' and the value ";
    matcher_.DescribeTo(os);
  }

  void DescribeNegationTo(std::ostream* os) const {
    *os << "is an 'any' type with value of type other than '" << GetTypeName()
        << "' or the value ";
    matcher_.DescribeNegationTo(os);
  }

 private:
  static std::string GetTypeName() {
#if GTEST_HAS_RTTI
Gennadiy Civil's avatar
 
Gennadiy Civil committed
3369
3370
    GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(
        return internal::GetTypeName<T>());
Gennadiy Civil's avatar
 
Gennadiy Civil committed
3371
3372
3373
3374
3375
3376
3377
3378
#endif
    return "the element type";
  }

  const ::testing::Matcher<const T&> matcher_;
};

}  // namespace any_cast_matcher
Abseil Team's avatar
Abseil Team committed
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452

// Implements the Args() matcher.
template <class ArgsTuple, size_t... k>
class ArgsMatcherImpl : public MatcherInterface<ArgsTuple> {
 public:
  using RawArgsTuple = typename std::decay<ArgsTuple>::type;
  using SelectedArgs =
      std::tuple<typename std::tuple_element<k, RawArgsTuple>::type...>;
  using MonomorphicInnerMatcher = Matcher<const SelectedArgs&>;

  template <typename InnerMatcher>
  explicit ArgsMatcherImpl(const InnerMatcher& inner_matcher)
      : inner_matcher_(SafeMatcherCast<const SelectedArgs&>(inner_matcher)) {}

  bool MatchAndExplain(ArgsTuple args,
                       MatchResultListener* listener) const override {
    // Workaround spurious C4100 on MSVC<=15.7 when k is empty.
    (void)args;
    const SelectedArgs& selected_args =
        std::forward_as_tuple(std::get<k>(args)...);
    if (!listener->IsInterested()) return inner_matcher_.Matches(selected_args);

    PrintIndices(listener->stream());
    *listener << "are " << PrintToString(selected_args);

    StringMatchResultListener inner_listener;
    const bool match =
        inner_matcher_.MatchAndExplain(selected_args, &inner_listener);
    PrintIfNotEmpty(inner_listener.str(), listener->stream());
    return match;
  }

  void DescribeTo(::std::ostream* os) const override {
    *os << "are a tuple ";
    PrintIndices(os);
    inner_matcher_.DescribeTo(os);
  }

  void DescribeNegationTo(::std::ostream* os) const override {
    *os << "are a tuple ";
    PrintIndices(os);
    inner_matcher_.DescribeNegationTo(os);
  }

 private:
  // Prints the indices of the selected fields.
  static void PrintIndices(::std::ostream* os) {
    *os << "whose fields (";
    const char* sep = "";
    // Workaround spurious C4189 on MSVC<=15.7 when k is empty.
    (void)sep;
    const char* dummy[] = {"", (*os << sep << "#" << k, sep = ", ")...};
    (void)dummy;
    *os << ") ";
  }

  MonomorphicInnerMatcher inner_matcher_;
};

template <class InnerMatcher, size_t... k>
class ArgsMatcher {
 public:
  explicit ArgsMatcher(InnerMatcher inner_matcher)
      : inner_matcher_(std::move(inner_matcher)) {}

  template <typename ArgsTuple>
  operator Matcher<ArgsTuple>() const {  // NOLINT
    return MakeMatcher(new ArgsMatcherImpl<ArgsTuple, k...>(inner_matcher_));
  }

 private:
  InnerMatcher inner_matcher_;
};

3453
3454
}  // namespace internal

Gennadiy Civil's avatar
Gennadiy Civil committed
3455
// ElementsAreArray(iterator_first, iterator_last)
3456
3457
// ElementsAreArray(pointer, count)
// ElementsAreArray(array)
3458
// ElementsAreArray(container)
3459
// ElementsAreArray({ e1, e2, ..., en })
3460
//
3461
3462
3463
3464
3465
3466
// The ElementsAreArray() functions are like ElementsAre(...), except
// that they are given a homogeneous sequence rather than taking each
// element as a function argument. The sequence can be specified as an
// array, a pointer and count, a vector, an initializer list, or an
// STL iterator range. In each of these cases, the underlying sequence
// can be either a sequence of values or a sequence of matchers.
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
//
// All forms of ElementsAreArray() make a copy of the input matcher sequence.

template <typename Iter>
inline internal::ElementsAreArrayMatcher<
    typename ::std::iterator_traits<Iter>::value_type>
ElementsAreArray(Iter first, Iter last) {
  typedef typename ::std::iterator_traits<Iter>::value_type T;
  return internal::ElementsAreArrayMatcher<T>(first, last);
}

template <typename T>
inline internal::ElementsAreArrayMatcher<T> ElementsAreArray(
    const T* pointer, size_t count) {
  return ElementsAreArray(pointer, pointer + count);
}

template <typename T, size_t N>
inline internal::ElementsAreArrayMatcher<T> ElementsAreArray(
    const T (&array)[N]) {
  return ElementsAreArray(array, N);
}

3490
3491
3492
3493
template <typename Container>
inline internal::ElementsAreArrayMatcher<typename Container::value_type>
ElementsAreArray(const Container& container) {
  return ElementsAreArray(container.begin(), container.end());
3494
3495
}

3496
3497
3498
3499
3500
3501
template <typename T>
inline internal::ElementsAreArrayMatcher<T>
ElementsAreArray(::std::initializer_list<T> xs) {
  return ElementsAreArray(xs.begin(), xs.end());
}

Gennadiy Civil's avatar
Gennadiy Civil committed
3502
// UnorderedElementsAreArray(iterator_first, iterator_last)
3503
3504
// UnorderedElementsAreArray(pointer, count)
// UnorderedElementsAreArray(array)
3505
// UnorderedElementsAreArray(container)
3506
// UnorderedElementsAreArray({ e1, e2, ..., en })
3507
//
Gennadiy Civil's avatar
Gennadiy Civil committed
3508
3509
3510
3511
3512
3513
3514
// UnorderedElementsAreArray() verifies that a bijective mapping onto a
// collection of matchers exists.
//
// The matchers can be specified as an array, a pointer and count, a container,
// an initializer list, or an STL iterator range. In each of these cases, the
// underlying matchers can be either values or matchers.

3515
3516
3517
3518
3519
template <typename Iter>
inline internal::UnorderedElementsAreArrayMatcher<
    typename ::std::iterator_traits<Iter>::value_type>
UnorderedElementsAreArray(Iter first, Iter last) {
  typedef typename ::std::iterator_traits<Iter>::value_type T;
Gennadiy Civil's avatar
Gennadiy Civil committed
3520
3521
  return internal::UnorderedElementsAreArrayMatcher<T>(
      internal::UnorderedMatcherRequire::ExactMatch, first, last);
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
}

template <typename T>
inline internal::UnorderedElementsAreArrayMatcher<T>
UnorderedElementsAreArray(const T* pointer, size_t count) {
  return UnorderedElementsAreArray(pointer, pointer + count);
}

template <typename T, size_t N>
inline internal::UnorderedElementsAreArrayMatcher<T>
UnorderedElementsAreArray(const T (&array)[N]) {
  return UnorderedElementsAreArray(array, N);
}

3536
3537
3538
3539
3540
template <typename Container>
inline internal::UnorderedElementsAreArrayMatcher<
    typename Container::value_type>
UnorderedElementsAreArray(const Container& container) {
  return UnorderedElementsAreArray(container.begin(), container.end());
3541
3542
}

3543
3544
3545
3546
3547
template <typename T>
inline internal::UnorderedElementsAreArrayMatcher<T>
UnorderedElementsAreArray(::std::initializer_list<T> xs) {
  return UnorderedElementsAreArray(xs.begin(), xs.end());
}
3548

3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
// _ is a matcher that matches anything of any type.
//
// This definition is fine as:
//
//   1. The C++ standard permits using the name _ in a namespace that
//      is not the global namespace or ::std.
//   2. The AnythingMatcher class has no data member or constructor,
//      so it's OK to create global variables of this type.
//   3. c-style has approved of using _ in this case.
const internal::AnythingMatcher _ = {};
// Creates a matcher that matches any value of the given type T.
template <typename T>
Gennadiy Civil's avatar
Gennadiy Civil committed
3561
3562
3563
inline Matcher<T> A() {
  return Matcher<T>(new internal::AnyMatcherImpl<T>());
}
3564
3565
3566
3567
3568

// Creates a matcher that matches any value of the given type T.
template <typename T>
inline Matcher<T> An() { return A<T>(); }

Gennadiy Civil's avatar
 
Gennadiy Civil committed
3569
3570
3571
3572
3573
3574
3575
3576
template <typename T, typename M>
Matcher<T> internal::MatcherCastImpl<T, M>::CastImpl(
    const M& value,
    internal::BooleanConstant<false> /* convertible_to_matcher */,
    internal::BooleanConstant<false> /* convertible_to_T */) {
  return Eq(value);
}

zhanyong.wan's avatar
zhanyong.wan committed
3577
3578
3579
3580
3581
// Creates a polymorphic matcher that matches any NULL pointer.
inline PolymorphicMatcher<internal::IsNullMatcher > IsNull() {
  return MakePolymorphicMatcher(internal::IsNullMatcher());
}

3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
// Creates a polymorphic matcher that matches any non-NULL pointer.
// This is convenient as Not(NULL) doesn't compile (the compiler
// thinks that that expression is comparing a pointer with an integer).
inline PolymorphicMatcher<internal::NotNullMatcher > NotNull() {
  return MakePolymorphicMatcher(internal::NotNullMatcher());
}

// Creates a polymorphic matcher that matches any argument that
// references variable x.
template <typename T>
inline internal::RefMatcher<T&> Ref(T& x) {  // NOLINT
  return internal::RefMatcher<T&>(x);
}

// Creates a matcher that matches any double argument approximately
// equal to rhs, where two NANs are considered unequal.
inline internal::FloatingEqMatcher<double> DoubleEq(double rhs) {
  return internal::FloatingEqMatcher<double>(rhs, false);
}

// Creates a matcher that matches any double argument approximately
// equal to rhs, including NaN values when rhs is NaN.
inline internal::FloatingEqMatcher<double> NanSensitiveDoubleEq(double rhs) {
  return internal::FloatingEqMatcher<double>(rhs, true);
}

3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
// Creates a matcher that matches any double argument approximately equal to
// rhs, up to the specified max absolute error bound, where two NANs are
// considered unequal.  The max absolute error bound must be non-negative.
inline internal::FloatingEqMatcher<double> DoubleNear(
    double rhs, double max_abs_error) {
  return internal::FloatingEqMatcher<double>(rhs, false, max_abs_error);
}

// Creates a matcher that matches any double argument approximately equal to
// rhs, up to the specified max absolute error bound, including NaN values when
// rhs is NaN.  The max absolute error bound must be non-negative.
inline internal::FloatingEqMatcher<double> NanSensitiveDoubleNear(
    double rhs, double max_abs_error) {
  return internal::FloatingEqMatcher<double>(rhs, true, max_abs_error);
}

3624
3625
3626
3627
3628
3629
// Creates a matcher that matches any float argument approximately
// equal to rhs, where two NANs are considered unequal.
inline internal::FloatingEqMatcher<float> FloatEq(float rhs) {
  return internal::FloatingEqMatcher<float>(rhs, false);
}

3630
// Creates a matcher that matches any float argument approximately
3631
3632
3633
3634
3635
// equal to rhs, including NaN values when rhs is NaN.
inline internal::FloatingEqMatcher<float> NanSensitiveFloatEq(float rhs) {
  return internal::FloatingEqMatcher<float>(rhs, true);
}

3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
// Creates a matcher that matches any float argument approximately equal to
// rhs, up to the specified max absolute error bound, where two NANs are
// considered unequal.  The max absolute error bound must be non-negative.
inline internal::FloatingEqMatcher<float> FloatNear(
    float rhs, float max_abs_error) {
  return internal::FloatingEqMatcher<float>(rhs, false, max_abs_error);
}

// Creates a matcher that matches any float argument approximately equal to
// rhs, up to the specified max absolute error bound, including NaN values when
// rhs is NaN.  The max absolute error bound must be non-negative.
inline internal::FloatingEqMatcher<float> NanSensitiveFloatNear(
    float rhs, float max_abs_error) {
  return internal::FloatingEqMatcher<float>(rhs, true, max_abs_error);
}

3652
3653
3654
3655
3656
3657
3658
3659
// Creates a matcher that matches a pointer (raw or smart) that points
// to a value that matches inner_matcher.
template <typename InnerMatcher>
inline internal::PointeeMatcher<InnerMatcher> Pointee(
    const InnerMatcher& inner_matcher) {
  return internal::PointeeMatcher<InnerMatcher>(inner_matcher);
}

3660
#if GTEST_HAS_RTTI
billydonahue's avatar
billydonahue committed
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
// Creates a matcher that matches a pointer or reference that matches
// inner_matcher when dynamic_cast<To> is applied.
// The result of dynamic_cast<To> is forwarded to the inner matcher.
// If To is a pointer and the cast fails, the inner matcher will receive NULL.
// If To is a reference and the cast fails, this matcher returns false
// immediately.
template <typename To>
inline PolymorphicMatcher<internal::WhenDynamicCastToMatcher<To> >
WhenDynamicCastTo(const Matcher<To>& inner_matcher) {
  return MakePolymorphicMatcher(
      internal::WhenDynamicCastToMatcher<To>(inner_matcher));
}
3673
#endif  // GTEST_HAS_RTTI
billydonahue's avatar
billydonahue committed
3674

3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
// Creates a matcher that matches an object whose given field matches
// 'matcher'.  For example,
//   Field(&Foo::number, Ge(5))
// matches a Foo object x iff x.number >= 5.
template <typename Class, typename FieldType, typename FieldMatcher>
inline PolymorphicMatcher<
  internal::FieldMatcher<Class, FieldType> > Field(
    FieldType Class::*field, const FieldMatcher& matcher) {
  return MakePolymorphicMatcher(
      internal::FieldMatcher<Class, FieldType>(
          field, MatcherCast<const FieldType&>(matcher)));
  // The call to MatcherCast() is required for supporting inner
  // matchers of compatible types.  For example, it allows
  //   Field(&Foo::bar, m)
  // to compile where bar is an int32 and m is a matcher for int64.
}

Gennadiy Civil's avatar
Gennadiy Civil committed
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
// Same as Field() but also takes the name of the field to provide better error
// messages.
template <typename Class, typename FieldType, typename FieldMatcher>
inline PolymorphicMatcher<internal::FieldMatcher<Class, FieldType> > Field(
    const std::string& field_name, FieldType Class::*field,
    const FieldMatcher& matcher) {
  return MakePolymorphicMatcher(internal::FieldMatcher<Class, FieldType>(
      field_name, field, MatcherCast<const FieldType&>(matcher)));
}

3702
3703
3704
3705
3706
// Creates a matcher that matches an object whose given property
// matches 'matcher'.  For example,
//   Property(&Foo::str, StartsWith("hi"))
// matches a Foo object x iff x.str() starts with "hi".
template <typename Class, typename PropertyType, typename PropertyMatcher>
3707
3708
3709
3710
inline PolymorphicMatcher<internal::PropertyMatcher<
    Class, PropertyType, PropertyType (Class::*)() const> >
Property(PropertyType (Class::*property)() const,
         const PropertyMatcher& matcher) {
3711
  return MakePolymorphicMatcher(
3712
3713
      internal::PropertyMatcher<Class, PropertyType,
                                PropertyType (Class::*)() const>(
Abseil Team's avatar
Abseil Team committed
3714
          property, MatcherCast<const PropertyType&>(matcher)));
3715
3716
3717
3718
3719
3720
  // The call to MatcherCast() is required for supporting inner
  // matchers of compatible types.  For example, it allows
  //   Property(&Foo::bar, m)
  // to compile where bar() returns an int32 and m is a matcher for int64.
}

Gennadiy Civil's avatar
Gennadiy Civil committed
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
// Same as Property() above, but also takes the name of the property to provide
// better error messages.
template <typename Class, typename PropertyType, typename PropertyMatcher>
inline PolymorphicMatcher<internal::PropertyMatcher<
    Class, PropertyType, PropertyType (Class::*)() const> >
Property(const std::string& property_name,
         PropertyType (Class::*property)() const,
         const PropertyMatcher& matcher) {
  return MakePolymorphicMatcher(
      internal::PropertyMatcher<Class, PropertyType,
                                PropertyType (Class::*)() const>(
Abseil Team's avatar
Abseil Team committed
3732
          property_name, property, MatcherCast<const PropertyType&>(matcher)));
Gennadiy Civil's avatar
Gennadiy Civil committed
3733
3734
}

3735
3736
3737
3738
3739
3740
3741
3742
// The same as above but for reference-qualified member functions.
template <typename Class, typename PropertyType, typename PropertyMatcher>
inline PolymorphicMatcher<internal::PropertyMatcher<
    Class, PropertyType, PropertyType (Class::*)() const &> >
Property(PropertyType (Class::*property)() const &,
         const PropertyMatcher& matcher) {
  return MakePolymorphicMatcher(
      internal::PropertyMatcher<Class, PropertyType,
Abseil Team's avatar
Abseil Team committed
3743
3744
                                PropertyType (Class::*)() const&>(
          property, MatcherCast<const PropertyType&>(matcher)));
3745
}
Gennadiy Civil's avatar
 
Gennadiy Civil committed
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755

// Three-argument form for reference-qualified member functions.
template <typename Class, typename PropertyType, typename PropertyMatcher>
inline PolymorphicMatcher<internal::PropertyMatcher<
    Class, PropertyType, PropertyType (Class::*)() const &> >
Property(const std::string& property_name,
         PropertyType (Class::*property)() const &,
         const PropertyMatcher& matcher) {
  return MakePolymorphicMatcher(
      internal::PropertyMatcher<Class, PropertyType,
Abseil Team's avatar
Abseil Team committed
3756
3757
                                PropertyType (Class::*)() const&>(
          property_name, property, MatcherCast<const PropertyType&>(matcher)));
Gennadiy Civil's avatar
 
Gennadiy Civil committed
3758
}
3759

3760
3761
3762
3763
3764
// Creates a matcher that matches an object iff the result of applying
// a callable to x matches 'matcher'.
// For example,
//   ResultOf(f, StartsWith("hi"))
// matches a Foo object x iff f(x) starts with "hi".
3765
3766
3767
3768
3769
3770
3771
3772
// `callable` parameter can be a function, function pointer, or a functor. It is
// required to keep no state affecting the results of the calls on it and make
// no assumptions about how many calls will be made. Any state it keeps must be
// protected from the concurrent access.
template <typename Callable, typename InnerMatcher>
internal::ResultOfMatcher<Callable, InnerMatcher> ResultOf(
    Callable callable, InnerMatcher matcher) {
  return internal::ResultOfMatcher<Callable, InnerMatcher>(
Abseil Team's avatar
Abseil Team committed
3773
      std::move(callable), std::move(matcher));
3774
3775
3776
3777
3778
}

// String matchers.

// Matches a string equal to str.
3779
3780
3781
3782
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::string> > StrEq(
    const std::string& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::string>(str, true, true));
3783
3784
3785
}

// Matches a string not equal to str.
3786
3787
3788
3789
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::string> > StrNe(
    const std::string& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::string>(str, false, true));
3790
3791
3792
}

// Matches a string equal to str, ignoring case.
3793
3794
3795
3796
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::string> > StrCaseEq(
    const std::string& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::string>(str, true, false));
3797
3798
3799
}

// Matches a string not equal to str, ignoring case.
3800
3801
3802
3803
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::string> > StrCaseNe(
    const std::string& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::string>(str, false, false));
3804
3805
3806
3807
}

// Creates a matcher that matches any string, std::string, or C string
// that contains the given substring.
3808
3809
3810
3811
inline PolymorphicMatcher<internal::HasSubstrMatcher<std::string> > HasSubstr(
    const std::string& substring) {
  return MakePolymorphicMatcher(
      internal::HasSubstrMatcher<std::string>(substring));
3812
3813
3814
}

// Matches a string that starts with 'prefix' (case-sensitive).
3815
3816
3817
3818
inline PolymorphicMatcher<internal::StartsWithMatcher<std::string> > StartsWith(
    const std::string& prefix) {
  return MakePolymorphicMatcher(
      internal::StartsWithMatcher<std::string>(prefix));
3819
3820
3821
}

// Matches a string that ends with 'suffix' (case-sensitive).
3822
3823
3824
inline PolymorphicMatcher<internal::EndsWithMatcher<std::string> > EndsWith(
    const std::string& suffix) {
  return MakePolymorphicMatcher(internal::EndsWithMatcher<std::string>(suffix));
3825
3826
3827
3828
3829
3830
}

#if GTEST_HAS_GLOBAL_WSTRING || GTEST_HAS_STD_WSTRING
// Wide string matchers.

// Matches a string equal to str.
Gennadiy Civil's avatar
Gennadiy Civil committed
3831
3832
3833
3834
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::wstring> > StrEq(
    const std::wstring& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::wstring>(str, true, true));
3835
3836
3837
}

// Matches a string not equal to str.
Gennadiy Civil's avatar
Gennadiy Civil committed
3838
3839
3840
3841
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::wstring> > StrNe(
    const std::wstring& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::wstring>(str, false, true));
3842
3843
3844
}

// Matches a string equal to str, ignoring case.
Gennadiy Civil's avatar
Gennadiy Civil committed
3845
3846
3847
3848
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::wstring> >
StrCaseEq(const std::wstring& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::wstring>(str, true, false));
3849
3850
3851
}

// Matches a string not equal to str, ignoring case.
Gennadiy Civil's avatar
Gennadiy Civil committed
3852
3853
3854
3855
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::wstring> >
StrCaseNe(const std::wstring& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::wstring>(str, false, false));
3856
3857
}

Gennadiy Civil's avatar
Gennadiy Civil committed
3858
// Creates a matcher that matches any ::wstring, std::wstring, or C wide string
3859
// that contains the given substring.
Gennadiy Civil's avatar
Gennadiy Civil committed
3860
3861
3862
3863
inline PolymorphicMatcher<internal::HasSubstrMatcher<std::wstring> > HasSubstr(
    const std::wstring& substring) {
  return MakePolymorphicMatcher(
      internal::HasSubstrMatcher<std::wstring>(substring));
3864
3865
3866
}

// Matches a string that starts with 'prefix' (case-sensitive).
Gennadiy Civil's avatar
Gennadiy Civil committed
3867
3868
3869
3870
inline PolymorphicMatcher<internal::StartsWithMatcher<std::wstring> >
StartsWith(const std::wstring& prefix) {
  return MakePolymorphicMatcher(
      internal::StartsWithMatcher<std::wstring>(prefix));
3871
3872
3873
}

// Matches a string that ends with 'suffix' (case-sensitive).
Gennadiy Civil's avatar
Gennadiy Civil committed
3874
3875
3876
3877
inline PolymorphicMatcher<internal::EndsWithMatcher<std::wstring> > EndsWith(
    const std::wstring& suffix) {
  return MakePolymorphicMatcher(
      internal::EndsWithMatcher<std::wstring>(suffix));
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
}

#endif  // GTEST_HAS_GLOBAL_WSTRING || GTEST_HAS_STD_WSTRING

// Creates a polymorphic matcher that matches a 2-tuple where the
// first field == the second field.
inline internal::Eq2Matcher Eq() { return internal::Eq2Matcher(); }

// Creates a polymorphic matcher that matches a 2-tuple where the
// first field >= the second field.
inline internal::Ge2Matcher Ge() { return internal::Ge2Matcher(); }

// Creates a polymorphic matcher that matches a 2-tuple where the
// first field > the second field.
inline internal::Gt2Matcher Gt() { return internal::Gt2Matcher(); }

// Creates a polymorphic matcher that matches a 2-tuple where the
// first field <= the second field.
inline internal::Le2Matcher Le() { return internal::Le2Matcher(); }

// Creates a polymorphic matcher that matches a 2-tuple where the
// first field < the second field.
inline internal::Lt2Matcher Lt() { return internal::Lt2Matcher(); }

// Creates a polymorphic matcher that matches a 2-tuple where the
// first field != the second field.
inline internal::Ne2Matcher Ne() { return internal::Ne2Matcher(); }

Gennadiy Civil's avatar
Gennadiy Civil committed
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
// Creates a polymorphic matcher that matches a 2-tuple where
// FloatEq(first field) matches the second field.
inline internal::FloatingEq2Matcher<float> FloatEq() {
  return internal::FloatingEq2Matcher<float>();
}

// Creates a polymorphic matcher that matches a 2-tuple where
// DoubleEq(first field) matches the second field.
inline internal::FloatingEq2Matcher<double> DoubleEq() {
  return internal::FloatingEq2Matcher<double>();
}

// Creates a polymorphic matcher that matches a 2-tuple where
// FloatEq(first field) matches the second field with NaN equality.
inline internal::FloatingEq2Matcher<float> NanSensitiveFloatEq() {
  return internal::FloatingEq2Matcher<float>(true);
}

// Creates a polymorphic matcher that matches a 2-tuple where
// DoubleEq(first field) matches the second field with NaN equality.
inline internal::FloatingEq2Matcher<double> NanSensitiveDoubleEq() {
  return internal::FloatingEq2Matcher<double>(true);
}

// Creates a polymorphic matcher that matches a 2-tuple where
// FloatNear(first field, max_abs_error) matches the second field.
inline internal::FloatingEq2Matcher<float> FloatNear(float max_abs_error) {
  return internal::FloatingEq2Matcher<float>(max_abs_error);
}

// Creates a polymorphic matcher that matches a 2-tuple where
// DoubleNear(first field, max_abs_error) matches the second field.
inline internal::FloatingEq2Matcher<double> DoubleNear(double max_abs_error) {
  return internal::FloatingEq2Matcher<double>(max_abs_error);
}

// Creates a polymorphic matcher that matches a 2-tuple where
// FloatNear(first field, max_abs_error) matches the second field with NaN
// equality.
inline internal::FloatingEq2Matcher<float> NanSensitiveFloatNear(
    float max_abs_error) {
  return internal::FloatingEq2Matcher<float>(max_abs_error, true);
}

// Creates a polymorphic matcher that matches a 2-tuple where
// DoubleNear(first field, max_abs_error) matches the second field with NaN
// equality.
inline internal::FloatingEq2Matcher<double> NanSensitiveDoubleNear(
    double max_abs_error) {
  return internal::FloatingEq2Matcher<double>(max_abs_error, true);
}

3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
// Creates a matcher that matches any value of type T that m doesn't
// match.
template <typename InnerMatcher>
inline internal::NotMatcher<InnerMatcher> Not(InnerMatcher m) {
  return internal::NotMatcher<InnerMatcher>(m);
}

// Returns a matcher that matches anything that satisfies the given
// predicate.  The predicate can be any unary function or functor
// whose return type can be implicitly converted to bool.
template <typename Predicate>
inline PolymorphicMatcher<internal::TrulyMatcher<Predicate> >
Truly(Predicate pred) {
  return MakePolymorphicMatcher(internal::TrulyMatcher<Predicate>(pred));
}

zhanyong.wan's avatar
zhanyong.wan committed
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
// Returns a matcher that matches the container size. The container must
// support both size() and size_type which all STL-like containers provide.
// Note that the parameter 'size' can be a value of type size_type as well as
// matcher. For instance:
//   EXPECT_THAT(container, SizeIs(2));     // Checks container has 2 elements.
//   EXPECT_THAT(container, SizeIs(Le(2));  // Checks container has at most 2.
template <typename SizeMatcher>
inline internal::SizeIsMatcher<SizeMatcher>
SizeIs(const SizeMatcher& size_matcher) {
  return internal::SizeIsMatcher<SizeMatcher>(size_matcher);
}

3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
// Returns a matcher that matches the distance between the container's begin()
// iterator and its end() iterator, i.e. the size of the container. This matcher
// can be used instead of SizeIs with containers such as std::forward_list which
// do not implement size(). The container must provide const_iterator (with
// valid iterator_traits), begin() and end().
template <typename DistanceMatcher>
inline internal::BeginEndDistanceIsMatcher<DistanceMatcher>
BeginEndDistanceIs(const DistanceMatcher& distance_matcher) {
  return internal::BeginEndDistanceIsMatcher<DistanceMatcher>(distance_matcher);
}

zhanyong.wan's avatar
zhanyong.wan committed
3997
3998
3999
4000
4001
// Returns a matcher that matches an equal container.
// This matcher behaves like Eq(), but in the event of mismatch lists the
// values that are included in one container but not the other. (Duplicate
// values and order differences are not explained.)
template <typename Container>
zhanyong.wan's avatar
zhanyong.wan committed
4002
inline PolymorphicMatcher<internal::ContainerEqMatcher<  // NOLINT
4003
                            GTEST_REMOVE_CONST_(Container)> >
zhanyong.wan's avatar
zhanyong.wan committed
4004
    ContainerEq(const Container& rhs) {
4005
4006
  // This following line is for working around a bug in MSVC 8.0,
  // which causes Container to be a const type sometimes.
4007
  typedef GTEST_REMOVE_CONST_(Container) RawContainer;
zhanyong.wan's avatar
zhanyong.wan committed
4008
4009
  return MakePolymorphicMatcher(
      internal::ContainerEqMatcher<RawContainer>(rhs));
4010
4011
}

4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
// Returns a matcher that matches a container that, when sorted using
// the given comparator, matches container_matcher.
template <typename Comparator, typename ContainerMatcher>
inline internal::WhenSortedByMatcher<Comparator, ContainerMatcher>
WhenSortedBy(const Comparator& comparator,
             const ContainerMatcher& container_matcher) {
  return internal::WhenSortedByMatcher<Comparator, ContainerMatcher>(
      comparator, container_matcher);
}

// Returns a matcher that matches a container that, when sorted using
// the < operator, matches container_matcher.
template <typename ContainerMatcher>
inline internal::WhenSortedByMatcher<internal::LessComparator, ContainerMatcher>
WhenSorted(const ContainerMatcher& container_matcher) {
  return
      internal::WhenSortedByMatcher<internal::LessComparator, ContainerMatcher>(
          internal::LessComparator(), container_matcher);
}

zhanyong.wan's avatar
zhanyong.wan committed
4032
4033
4034
// Matches an STL-style container or a native array that contains the
// same number of elements as in rhs, where its i-th element and rhs's
// i-th element (as a pair) satisfy the given pair matcher, for all i.
Abseil Team's avatar
Abseil Team committed
4035
// TupleMatcher must be able to be safely cast to Matcher<std::tuple<const
zhanyong.wan's avatar
zhanyong.wan committed
4036
4037
4038
4039
4040
4041
4042
// T1&, const T2&> >, where T1 and T2 are the types of elements in the
// LHS container and the RHS container respectively.
template <typename TupleMatcher, typename Container>
inline internal::PointwiseMatcher<TupleMatcher,
                                  GTEST_REMOVE_CONST_(Container)>
Pointwise(const TupleMatcher& tuple_matcher, const Container& rhs) {
  // This following line is for working around a bug in MSVC 8.0,
4043
4044
  // which causes Container to be a const type sometimes (e.g. when
  // rhs is a const int[])..
zhanyong.wan's avatar
zhanyong.wan committed
4045
4046
4047
4048
4049
  typedef GTEST_REMOVE_CONST_(Container) RawContainer;
  return internal::PointwiseMatcher<TupleMatcher, RawContainer>(
      tuple_matcher, rhs);
}

4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063

// Supports the Pointwise(m, {a, b, c}) syntax.
template <typename TupleMatcher, typename T>
inline internal::PointwiseMatcher<TupleMatcher, std::vector<T> > Pointwise(
    const TupleMatcher& tuple_matcher, std::initializer_list<T> rhs) {
  return Pointwise(tuple_matcher, std::vector<T>(rhs));
}


// UnorderedPointwise(pair_matcher, rhs) matches an STL-style
// container or a native array that contains the same number of
// elements as in rhs, where in some permutation of the container, its
// i-th element and rhs's i-th element (as a pair) satisfy the given
// pair matcher, for all i.  Tuple2Matcher must be able to be safely
Abseil Team's avatar
Abseil Team committed
4064
// cast to Matcher<std::tuple<const T1&, const T2&> >, where T1 and T2 are
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
// the types of elements in the LHS container and the RHS container
// respectively.
//
// This is like Pointwise(pair_matcher, rhs), except that the element
// order doesn't matter.
template <typename Tuple2Matcher, typename RhsContainer>
inline internal::UnorderedElementsAreArrayMatcher<
    typename internal::BoundSecondMatcher<
        Tuple2Matcher, typename internal::StlContainerView<GTEST_REMOVE_CONST_(
                           RhsContainer)>::type::value_type> >
UnorderedPointwise(const Tuple2Matcher& tuple2_matcher,
                   const RhsContainer& rhs_container) {
  // This following line is for working around a bug in MSVC 8.0,
  // which causes RhsContainer to be a const type sometimes (e.g. when
  // rhs_container is a const int[]).
  typedef GTEST_REMOVE_CONST_(RhsContainer) RawRhsContainer;

  // RhsView allows the same code to handle RhsContainer being a
  // STL-style container and it being a native C-style array.
  typedef typename internal::StlContainerView<RawRhsContainer> RhsView;
  typedef typename RhsView::type RhsStlContainer;
  typedef typename RhsStlContainer::value_type Second;
  const RhsStlContainer& rhs_stl_container =
      RhsView::ConstReference(rhs_container);

  // Create a matcher for each element in rhs_container.
  ::std::vector<internal::BoundSecondMatcher<Tuple2Matcher, Second> > matchers;
  for (typename RhsStlContainer::const_iterator it = rhs_stl_container.begin();
       it != rhs_stl_container.end(); ++it) {
    matchers.push_back(
        internal::MatcherBindSecond(tuple2_matcher, *it));
  }

  // Delegate the work to UnorderedElementsAreArray().
  return UnorderedElementsAreArray(matchers);
}


// Supports the UnorderedPointwise(m, {a, b, c}) syntax.
template <typename Tuple2Matcher, typename T>
inline internal::UnorderedElementsAreArrayMatcher<
    typename internal::BoundSecondMatcher<Tuple2Matcher, T> >
UnorderedPointwise(const Tuple2Matcher& tuple2_matcher,
                   std::initializer_list<T> rhs) {
  return UnorderedPointwise(tuple2_matcher, std::vector<T>(rhs));
}


4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
// Matches an STL-style container or a native array that contains at
// least one element matching the given value or matcher.
//
// Examples:
//   ::std::set<int> page_ids;
//   page_ids.insert(3);
//   page_ids.insert(1);
//   EXPECT_THAT(page_ids, Contains(1));
//   EXPECT_THAT(page_ids, Contains(Gt(2)));
//   EXPECT_THAT(page_ids, Not(Contains(4)));
//
//   ::std::map<int, size_t> page_lengths;
//   page_lengths[1] = 100;
zhanyong.wan's avatar
zhanyong.wan committed
4126
4127
//   EXPECT_THAT(page_lengths,
//               Contains(::std::pair<const int, size_t>(1, 100)));
4128
4129
4130
4131
4132
4133
//
//   const char* user_ids[] = { "joe", "mike", "tom" };
//   EXPECT_THAT(user_ids, Contains(Eq(::std::string("tom"))));
template <typename M>
inline internal::ContainsMatcher<M> Contains(M matcher) {
  return internal::ContainsMatcher<M>(matcher);
zhanyong.wan's avatar
zhanyong.wan committed
4134
4135
}

Gennadiy Civil's avatar
Gennadiy Civil committed
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
// IsSupersetOf(iterator_first, iterator_last)
// IsSupersetOf(pointer, count)
// IsSupersetOf(array)
// IsSupersetOf(container)
// IsSupersetOf({e1, e2, ..., en})
//
// IsSupersetOf() verifies that a surjective partial mapping onto a collection
// of matchers exists. In other words, a container matches
// IsSupersetOf({e1, ..., en}) if and only if there is a permutation
// {y1, ..., yn} of some of the container's elements where y1 matches e1,
// ..., and yn matches en. Obviously, the size of the container must be >= n
// in order to have a match. Examples:
//
// - {1, 2, 3} matches IsSupersetOf({Ge(3), Ne(0)}), as 3 matches Ge(3) and
//   1 matches Ne(0).
// - {1, 2} doesn't match IsSupersetOf({Eq(1), Lt(2)}), even though 1 matches
//   both Eq(1) and Lt(2). The reason is that different matchers must be used
//   for elements in different slots of the container.
// - {1, 1, 2} matches IsSupersetOf({Eq(1), Lt(2)}), as (the first) 1 matches
//   Eq(1) and (the second) 1 matches Lt(2).
// - {1, 2, 3} matches IsSupersetOf(Gt(1), Gt(1)), as 2 matches (the first)
//   Gt(1) and 3 matches (the second) Gt(1).
//
// The matchers can be specified as an array, a pointer and count, a container,
// an initializer list, or an STL iterator range. In each of these cases, the
// underlying matchers can be either values or matchers.

template <typename Iter>
inline internal::UnorderedElementsAreArrayMatcher<
    typename ::std::iterator_traits<Iter>::value_type>
IsSupersetOf(Iter first, Iter last) {
  typedef typename ::std::iterator_traits<Iter>::value_type T;
  return internal::UnorderedElementsAreArrayMatcher<T>(
      internal::UnorderedMatcherRequire::Superset, first, last);
}

template <typename T>
inline internal::UnorderedElementsAreArrayMatcher<T> IsSupersetOf(
    const T* pointer, size_t count) {
  return IsSupersetOf(pointer, pointer + count);
}

template <typename T, size_t N>
inline internal::UnorderedElementsAreArrayMatcher<T> IsSupersetOf(
    const T (&array)[N]) {
  return IsSupersetOf(array, N);
}

template <typename Container>
inline internal::UnorderedElementsAreArrayMatcher<
    typename Container::value_type>
IsSupersetOf(const Container& container) {
  return IsSupersetOf(container.begin(), container.end());
}

template <typename T>
inline internal::UnorderedElementsAreArrayMatcher<T> IsSupersetOf(
    ::std::initializer_list<T> xs) {
  return IsSupersetOf(xs.begin(), xs.end());
}

// IsSubsetOf(iterator_first, iterator_last)
// IsSubsetOf(pointer, count)
// IsSubsetOf(array)
// IsSubsetOf(container)
// IsSubsetOf({e1, e2, ..., en})
//
// IsSubsetOf() verifies that an injective mapping onto a collection of matchers
// exists.  In other words, a container matches IsSubsetOf({e1, ..., en}) if and
// only if there is a subset of matchers {m1, ..., mk} which would match the
// container using UnorderedElementsAre.  Obviously, the size of the container
// must be <= n in order to have a match. Examples:
//
// - {1} matches IsSubsetOf({Gt(0), Lt(0)}), as 1 matches Gt(0).
// - {1, -1} matches IsSubsetOf({Lt(0), Gt(0)}), as 1 matches Gt(0) and -1
//   matches Lt(0).
// - {1, 2} doesn't matches IsSubsetOf({Gt(0), Lt(0)}), even though 1 and 2 both
//   match Gt(0). The reason is that different matchers must be used for
//   elements in different slots of the container.
//
// The matchers can be specified as an array, a pointer and count, a container,
// an initializer list, or an STL iterator range. In each of these cases, the
// underlying matchers can be either values or matchers.

template <typename Iter>
inline internal::UnorderedElementsAreArrayMatcher<
    typename ::std::iterator_traits<Iter>::value_type>
IsSubsetOf(Iter first, Iter last) {
  typedef typename ::std::iterator_traits<Iter>::value_type T;
  return internal::UnorderedElementsAreArrayMatcher<T>(
      internal::UnorderedMatcherRequire::Subset, first, last);
}

template <typename T>
inline internal::UnorderedElementsAreArrayMatcher<T> IsSubsetOf(
    const T* pointer, size_t count) {
  return IsSubsetOf(pointer, pointer + count);
}

template <typename T, size_t N>
inline internal::UnorderedElementsAreArrayMatcher<T> IsSubsetOf(
    const T (&array)[N]) {
  return IsSubsetOf(array, N);
}

template <typename Container>
inline internal::UnorderedElementsAreArrayMatcher<
    typename Container::value_type>
IsSubsetOf(const Container& container) {
  return IsSubsetOf(container.begin(), container.end());
}

template <typename T>
inline internal::UnorderedElementsAreArrayMatcher<T> IsSubsetOf(
    ::std::initializer_list<T> xs) {
  return IsSubsetOf(xs.begin(), xs.end());
}

4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
// Matches an STL-style container or a native array that contains only
// elements matching the given value or matcher.
//
// Each(m) is semantically equivalent to Not(Contains(Not(m))). Only
// the messages are different.
//
// Examples:
//   ::std::set<int> page_ids;
//   // Each(m) matches an empty container, regardless of what m is.
//   EXPECT_THAT(page_ids, Each(Eq(1)));
//   EXPECT_THAT(page_ids, Each(Eq(77)));
//
//   page_ids.insert(3);
//   EXPECT_THAT(page_ids, Each(Gt(0)));
//   EXPECT_THAT(page_ids, Not(Each(Gt(4))));
//   page_ids.insert(1);
//   EXPECT_THAT(page_ids, Not(Each(Lt(2))));
//
//   ::std::map<int, size_t> page_lengths;
//   page_lengths[1] = 100;
//   page_lengths[2] = 200;
//   page_lengths[3] = 300;
//   EXPECT_THAT(page_lengths, Not(Each(Pair(1, 100))));
//   EXPECT_THAT(page_lengths, Each(Key(Le(3))));
//
//   const char* user_ids[] = { "joe", "mike", "tom" };
//   EXPECT_THAT(user_ids, Not(Each(Eq(::std::string("tom")))));
template <typename M>
inline internal::EachMatcher<M> Each(M matcher) {
  return internal::EachMatcher<M>(matcher);
}

4286
4287
4288
4289
4290
4291
4292
4293
// Key(inner_matcher) matches an std::pair whose 'first' field matches
// inner_matcher.  For example, Contains(Key(Ge(5))) can be used to match an
// std::map that contains at least one element whose key is >= 5.
template <typename M>
inline internal::KeyMatcher<M> Key(M inner_matcher) {
  return internal::KeyMatcher<M>(inner_matcher);
}

4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
// Pair(first_matcher, second_matcher) matches a std::pair whose 'first' field
// matches first_matcher and whose 'second' field matches second_matcher.  For
// example, EXPECT_THAT(map_type, ElementsAre(Pair(Ge(5), "foo"))) can be used
// to match a std::map<int, string> that contains exactly one element whose key
// is >= 5 and whose value equals "foo".
template <typename FirstMatcher, typename SecondMatcher>
inline internal::PairMatcher<FirstMatcher, SecondMatcher>
Pair(FirstMatcher first_matcher, SecondMatcher second_matcher) {
  return internal::PairMatcher<FirstMatcher, SecondMatcher>(
      first_matcher, second_matcher);
}

4306
4307
4308
4309
4310
4311
4312
// Returns a predicate that is satisfied by anything that matches the
// given matcher.
template <typename M>
inline internal::MatcherAsPredicate<M> Matches(M matcher) {
  return internal::MatcherAsPredicate<M>(matcher);
}

4313
4314
4315
4316
4317
4318
// Returns true iff the value matches the matcher.
template <typename T, typename M>
inline bool Value(const T& value, M matcher) {
  return testing::Matches(matcher)(value);
}

4319
4320
4321
// Matches the value against the given matcher and explains the match
// result to listener.
template <typename T, typename M>
4322
inline bool ExplainMatchResult(
4323
4324
4325
4326
    M matcher, const T& value, MatchResultListener* listener) {
  return SafeMatcherCast<const T&>(matcher).MatchAndExplain(value, listener);
}

Gennadiy Civil's avatar
Gennadiy Civil committed
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
// Returns a string representation of the given matcher.  Useful for description
// strings of matchers defined using MATCHER_P* macros that accept matchers as
// their arguments.  For example:
//
// MATCHER_P(XAndYThat, matcher,
//           "X that " + DescribeMatcher<int>(matcher, negation) +
//               " and Y that " + DescribeMatcher<double>(matcher, negation)) {
//   return ExplainMatchResult(matcher, arg.x(), result_listener) &&
//          ExplainMatchResult(matcher, arg.y(), result_listener);
// }
template <typename T, typename M>
std::string DescribeMatcher(const M& matcher, bool negation = false) {
  ::std::stringstream ss;
  Matcher<T> monomorphic_matcher = SafeMatcherCast<T>(matcher);
  if (negation) {
    monomorphic_matcher.DescribeNegationTo(&ss);
  } else {
    monomorphic_matcher.DescribeTo(&ss);
  }
  return ss.str();
}

Gennadiy Civil's avatar
 
Gennadiy Civil committed
4349
template <typename... Args>
Abseil Team's avatar
Abseil Team committed
4350
4351
internal::ElementsAreMatcher<
    std::tuple<typename std::decay<const Args&>::type...>>
Gennadiy Civil's avatar
 
Gennadiy Civil committed
4352
4353
ElementsAre(const Args&... matchers) {
  return internal::ElementsAreMatcher<
Abseil Team's avatar
Abseil Team committed
4354
4355
      std::tuple<typename std::decay<const Args&>::type...>>(
      std::make_tuple(matchers...));
Gennadiy Civil's avatar
 
Gennadiy Civil committed
4356
4357
4358
}

template <typename... Args>
Gennadiy Civil's avatar
Gennadiy Civil committed
4359
internal::UnorderedElementsAreMatcher<
Abseil Team's avatar
Abseil Team committed
4360
    std::tuple<typename std::decay<const Args&>::type...>>
Gennadiy Civil's avatar
 
Gennadiy Civil committed
4361
4362
UnorderedElementsAre(const Args&... matchers) {
  return internal::UnorderedElementsAreMatcher<
Abseil Team's avatar
Abseil Team committed
4363
4364
      std::tuple<typename std::decay<const Args&>::type...>>(
      std::make_tuple(matchers...));
Gennadiy Civil's avatar
 
Gennadiy Civil committed
4365
4366
}

misterg's avatar
misterg committed
4367
// Define variadic matcher versions.
misterg's avatar
misterg committed
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
template <typename... Args>
internal::AllOfMatcher<typename std::decay<const Args&>::type...> AllOf(
    const Args&... matchers) {
  return internal::AllOfMatcher<typename std::decay<const Args&>::type...>(
      matchers...);
}

template <typename... Args>
internal::AnyOfMatcher<typename std::decay<const Args&>::type...> AnyOf(
    const Args&... matchers) {
  return internal::AnyOfMatcher<typename std::decay<const Args&>::type...>(
      matchers...);
}

Abseil Team's avatar
Abseil Team committed
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
// Args<N1, N2, ..., Nk>(a_matcher) matches a tuple if the selected
// fields of it matches a_matcher.  C++ doesn't support default
// arguments for function templates, so we have to overload it.
template <size_t... k, typename InnerMatcher>
internal::ArgsMatcher<typename std::decay<InnerMatcher>::type, k...> Args(
    InnerMatcher&& matcher) {
  return internal::ArgsMatcher<typename std::decay<InnerMatcher>::type, k...>(
      std::forward<InnerMatcher>(matcher));
}

4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
// AllArgs(m) is a synonym of m.  This is useful in
//
//   EXPECT_CALL(foo, Bar(_, _)).With(AllArgs(Eq()));
//
// which is easier to read than
//
//   EXPECT_CALL(foo, Bar(_, _)).With(Eq());
template <typename InnerMatcher>
inline InnerMatcher AllArgs(const InnerMatcher& matcher) { return matcher; }

Gennadiy Civil's avatar
Gennadiy Civil committed
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
// Returns a matcher that matches the value of an optional<> type variable.
// The matcher implementation only uses '!arg' and requires that the optional<>
// type has a 'value_type' member type and that '*arg' is of type 'value_type'
// and is printable using 'PrintToString'. It is compatible with
// std::optional/std::experimental::optional.
// Note that to compare an optional type variable against nullopt you should
// use Eq(nullopt) and not Optional(Eq(nullopt)). The latter implies that the
// optional value contains an optional itself.
template <typename ValueMatcher>
inline internal::OptionalMatcher<ValueMatcher> Optional(
    const ValueMatcher& value_matcher) {
  return internal::OptionalMatcher<ValueMatcher>(value_matcher);
}

// Returns a matcher that matches the value of a absl::any type variable.
template <typename T>
PolymorphicMatcher<internal::any_cast_matcher::AnyCastMatcher<T> > AnyWith(
    const Matcher<const T&>& matcher) {
  return MakePolymorphicMatcher(
      internal::any_cast_matcher::AnyCastMatcher<T>(matcher));
}

Xiaoyi Zhang's avatar
Xiaoyi Zhang committed
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
// Returns a matcher that matches the value of a variant<> type variable.
// The matcher implementation uses ADL to find the holds_alternative and get
// functions.
// It is compatible with std::variant.
template <typename T>
PolymorphicMatcher<internal::variant_matcher::VariantMatcher<T> > VariantWith(
    const Matcher<const T&>& matcher) {
  return MakePolymorphicMatcher(
      internal::variant_matcher::VariantMatcher<T>(matcher));
}

4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
// These macros allow using matchers to check values in Google Test
// tests.  ASSERT_THAT(value, matcher) and EXPECT_THAT(value, matcher)
// succeed iff the value matches the matcher.  If the assertion fails,
// the value and the description of the matcher will be printed.
#define ASSERT_THAT(value, matcher) ASSERT_PRED_FORMAT1(\
    ::testing::internal::MakePredicateFormatterFromMatcher(matcher), value)
#define EXPECT_THAT(value, matcher) EXPECT_PRED_FORMAT1(\
    ::testing::internal::MakePredicateFormatterFromMatcher(matcher), value)

}  // namespace testing

misterg's avatar
misterg committed
4446
GTEST_DISABLE_MSC_WARNINGS_POP_()  //  4251 5046
misterg's avatar
misterg committed
4447

4448
4449
4450
4451
// Include any custom callback matchers added by the local installation.
// We must include this header at the end to make sure it can use the
// declarations from this file.
#include "gmock/internal/custom/gmock-matchers.h"
Gennadiy Civil's avatar
Gennadiy Civil committed
4452

4453
#endif  // GMOCK_INCLUDE_GMOCK_GMOCK_MATCHERS_H_