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

// Google Mock - a framework for writing C++ mock classes.
//
Abseil Team's avatar
Abseil Team committed
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
// The MATCHER* family of macros can be used in a namespace scope to
// define custom matchers easily.
//
// Basic Usage
// ===========
//
// The syntax
//
//   MATCHER(name, description_string) { statements; }
//
// defines a matcher with the given name that executes the statements,
// which must return a bool to indicate if the match succeeds.  Inside
// the statements, you can refer to the value being matched by 'arg',
// and refer to its type by 'arg_type'.
//
// The description string documents what the matcher does, and is used
// to generate the failure message when the match fails.  Since a
// MATCHER() is usually defined in a header file shared by multiple
// C++ source files, we require the description to be a C-string
// literal to avoid possible side effects.  It can be empty, in which
// case we'll use the sequence of words in the matcher name as the
// description.
//
// For example:
//
//   MATCHER(IsEven, "") { return (arg % 2) == 0; }
//
// allows you to write
//
//   // Expects mock_foo.Bar(n) to be called where n is even.
//   EXPECT_CALL(mock_foo, Bar(IsEven()));
//
// or,
//
//   // Verifies that the value of some_expression is even.
//   EXPECT_THAT(some_expression, IsEven());
//
// If the above assertion fails, it will print something like:
//
//   Value of: some_expression
//   Expected: is even
//     Actual: 7
//
// where the description "is even" is automatically calculated from the
// matcher name IsEven.
//
// Argument Type
// =============
//
// Note that the type of the value being matched (arg_type) is
// determined by the context in which you use the matcher and is
// supplied to you by the compiler, so you don't need to worry about
// declaring it (nor can you).  This allows the matcher to be
// polymorphic.  For example, IsEven() can be used to match any type
// where the value of "(arg % 2) == 0" can be implicitly converted to
// a bool.  In the "Bar(IsEven())" example above, if method Bar()
// takes an int, 'arg_type' will be int; if it takes an unsigned long,
// 'arg_type' will be unsigned long; and so on.
//
// Parameterizing Matchers
// =======================
//
// Sometimes you'll want to parameterize the matcher.  For that you
// can use another macro:
//
//   MATCHER_P(name, param_name, description_string) { statements; }
//
// For example:
//
//   MATCHER_P(HasAbsoluteValue, value, "") { return abs(arg) == value; }
//
// will allow you to write:
//
//   EXPECT_THAT(Blah("a"), HasAbsoluteValue(n));
//
// which may lead to this message (assuming n is 10):
//
//   Value of: Blah("a")
//   Expected: has absolute value 10
//     Actual: -9
//
// Note that both the matcher description and its parameter are
// printed, making the message human-friendly.
//
// In the matcher definition body, you can write 'foo_type' to
// reference the type of a parameter named 'foo'.  For example, in the
// body of MATCHER_P(HasAbsoluteValue, value) above, you can write
// 'value_type' to refer to the type of 'value'.
//
// We also provide MATCHER_P2, MATCHER_P3, ..., up to MATCHER_P$n to
// support multi-parameter matchers.
//
// Describing Parameterized Matchers
// =================================
//
// The last argument to MATCHER*() is a string-typed expression.  The
// expression can reference all of the matcher's parameters and a
// special bool-typed variable named 'negation'.  When 'negation' is
// false, the expression should evaluate to the matcher's description;
// otherwise it should evaluate to the description of the negation of
// the matcher.  For example,
//
//   using testing::PrintToString;
//
//   MATCHER_P2(InClosedRange, low, hi,
//       std::string(negation ? "is not" : "is") + " in range [" +
//       PrintToString(low) + ", " + PrintToString(hi) + "]") {
//     return low <= arg && arg <= hi;
//   }
//   ...
//   EXPECT_THAT(3, InClosedRange(4, 6));
//   EXPECT_THAT(3, Not(InClosedRange(2, 4)));
//
// would generate two failures that contain the text:
//
//   Expected: is in range [4, 6]
//   ...
//   Expected: is not in range [2, 4]
//
// If you specify "" as the description, the failure message will
// contain the sequence of words in the matcher name followed by the
// parameter values printed as a tuple.  For example,
//
//   MATCHER_P2(InClosedRange, low, hi, "") { ... }
//   ...
//   EXPECT_THAT(3, InClosedRange(4, 6));
//   EXPECT_THAT(3, Not(InClosedRange(2, 4)));
//
// would generate two failures that contain the text:
//
//   Expected: in closed range (4, 6)
//   ...
//   Expected: not (in closed range (2, 4))
//
// Types of Matcher Parameters
// ===========================
//
// For the purpose of typing, you can view
//
//   MATCHER_Pk(Foo, p1, ..., pk, description_string) { ... }
//
// as shorthand for
//
//   template <typename p1_type, ..., typename pk_type>
//   FooMatcherPk<p1_type, ..., pk_type>
//   Foo(p1_type p1, ..., pk_type pk) { ... }
//
// When you write Foo(v1, ..., vk), the compiler infers the types of
// the parameters v1, ..., and vk for you.  If you are not happy with
// the result of the type inference, you can specify the types by
// explicitly instantiating the template, as in Foo<long, bool>(5,
// false).  As said earlier, you don't get to (or need to) specify
// 'arg_type' as that's determined by the context in which the matcher
// is used.  You can assign the result of expression Foo(p1, ..., pk)
// to a variable of type FooMatcherPk<p1_type, ..., pk_type>.  This
// can be useful when composing matchers.
//
// While you can instantiate a matcher template with reference types,
// passing the parameters by pointer usually makes your code more
// readable.  If, however, you still want to pass a parameter by
// reference, be aware that in the failure message generated by the
// matcher you will see the value of the referenced object but not its
// address.
//
// Explaining Match Results
// ========================
//
// Sometimes the matcher description alone isn't enough to explain why
// the match has failed or succeeded.  For example, when expecting a
// long string, it can be very helpful to also print the diff between
// the expected string and the actual one.  To achieve that, you can
// optionally stream additional information to a special variable
// named result_listener, whose type is a pointer to class
// MatchResultListener:
//
//   MATCHER_P(EqualsLongString, str, "") {
//     if (arg == str) return true;
//
//     *result_listener << "the difference: "
///                     << DiffStrings(str, arg);
//     return false;
//   }
//
// Overloading Matchers
// ====================
//
// You can overload matchers with different numbers of parameters:
//
//   MATCHER_P(Blah, a, description_string1) { ... }
//   MATCHER_P2(Blah, a, b, description_string2) { ... }
//
// Caveats
// =======
//
// When defining a new matcher, you should also consider implementing
// MatcherInterface or using MakePolymorphicMatcher().  These
// approaches require more work than the MATCHER* macros, but also
// give you more control on the types of the value being matched and
// the matcher parameters, which may leads to better compiler error
// messages when the matcher is used wrong.  They also allow
// overloading matchers based on parameter types (as opposed to just
// based on the number of parameters).
//
// MATCHER*() can only be used in a namespace scope as templates cannot be
// declared inside of a local class.
//
// More Information
// ================
//
// To learn more about using these macros, please search for 'MATCHER'
// on
// https://github.com/google/googletest/blob/master/googlemock/docs/cook_book.md
//
// This file also implements some commonly used argument matchers.  More
247
248
// matchers can be defined by the user implementing the
// MatcherInterface<T> interface if necessary.
durandal's avatar
durandal committed
249
250
251
//
// See googletest/include/gtest/gtest-matchers.h for the definition of class
// Matcher, class MatcherInterface, and others.
252

Gennadiy Civil's avatar
 
Gennadiy Civil committed
253
254
// GOOGLETEST_CM0002 DO NOT DELETE

255
256
257
#ifndef GMOCK_INCLUDE_GMOCK_GMOCK_MATCHERS_H_
#define GMOCK_INCLUDE_GMOCK_GMOCK_MATCHERS_H_

zhanyong.wan's avatar
zhanyong.wan committed
258
#include <algorithm>
Abseil Team's avatar
Abseil Team committed
259
#include <cmath>
Abseil Team's avatar
Abseil Team committed
260
#include <initializer_list>
261
#include <iterator>
262
#include <limits>
misterg's avatar
misterg committed
263
#include <memory>
264
265
266
#include <ostream>  // NOLINT
#include <sstream>
#include <string>
Abseil Team's avatar
Abseil Team committed
267
#include <type_traits>
zhanyong.wan's avatar
zhanyong.wan committed
268
#include <utility>
269
#include <vector>
Abseil Team's avatar
Abseil Team committed
270

271
272
#include "gmock/internal/gmock-internal-utils.h"
#include "gmock/internal/gmock-port.h"
Abseil Team's avatar
Abseil Team committed
273
#include "gmock/internal/gmock-pp.h"
misterg's avatar
misterg committed
274
#include "gtest/gtest.h"
275

276
277
278
279
280
281
282
// MSVC warning C5046 is new as of VS2017 version 15.8.
#if defined(_MSC_VER) && _MSC_VER >= 1915
#define GMOCK_MAYBE_5046_ 5046
#else
#define GMOCK_MAYBE_5046_
#endif

misterg's avatar
misterg committed
283
GTEST_DISABLE_MSC_WARNINGS_PUSH_(
284
285
    4251 GMOCK_MAYBE_5046_ /* class A needs to have dll-interface to be used by
                              clients of class B */
misterg's avatar
misterg committed
286
    /* Symbol involving type with internal linkage not defined */)
misterg's avatar
misterg committed
287

288
289
290
291
292
293
294
295
296
297
298
299
300
301
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.

302
303
304
305
306
307
// 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.
308
  std::string str() const { return ss_.str(); }
309
310
311
312
313
314
315
316
317
318

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

 private:
  ::std::stringstream ss_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(StringMatchResultListener);
};

319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
// 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:
336
  static Matcher<T> Cast(const M& polymorphic_matcher_or_value) {
Gennadiy Civil's avatar
Gennadiy Civil committed
337
    // M can be a polymorphic matcher, in which case we want to use
338
339
340
341
342
343
344
345
346
347
348
349
    // 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).
kuzkry's avatar
kuzkry committed
350
    return CastImpl(polymorphic_matcher_or_value,
351
352
                    std::is_convertible<M, Matcher<T>>{},
                    std::is_convertible<M, T>{});
353
354
355
  }

 private:
Gennadiy Civil's avatar
 
Gennadiy Civil committed
356
  template <bool Ignore>
357
  static Matcher<T> CastImpl(const M& polymorphic_matcher_or_value,
358
                             std::true_type /* convertible_to_matcher */,
Abseil Team's avatar
Abseil Team committed
359
                             std::integral_constant<bool, Ignore>) {
360
    // M is implicitly convertible to Matcher<T>, which means that either
Gennadiy Civil's avatar
 
Gennadiy Civil committed
361
    // M is a polymorphic matcher or Matcher<T> has an implicit constructor
362
363
364
365
366
367
368
369
    // 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
370
371
372
373

  // 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.
kuzkry's avatar
kuzkry committed
374
  static Matcher<T> CastImpl(const M& value,
375
376
                             std::false_type /* convertible_to_matcher */,
                             std::true_type /* convertible_to_T */) {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
377
378
379
380
381
382
383
384
385
386
387
388
389
    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().
kuzkry's avatar
kuzkry committed
390
  static Matcher<T> CastImpl(const M& value,
391
392
                             std::false_type /* convertible_to_matcher */,
                             std::false_type /* convertible_to_T */);
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
};

// 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
412
    bool MatchAndExplain(T x, MatchResultListener* listener) const override {
Gennadiy Civil's avatar
Gennadiy Civil committed
413
414
415
416
417
418
419
420
421
422
423
424
425
426
      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>");

Abseil Team's avatar
Abseil Team committed
427
428
429
430
431
432
433
434
      // Do the cast to `U` explicitly if necessary.
      // Otherwise, let implicit conversions do the trick.
      using CastType =
          typename std::conditional<std::is_convertible<T&, const U&>::value,
                                    T&, U>::type;

      return source_matcher_.MatchAndExplain(static_cast<CastType>(x),
                                             listener);
435
436
    }

Abseil Team's avatar
Abseil Team committed
437
    void DescribeTo(::std::ostream* os) const override {
438
439
440
      source_matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
441
    void DescribeNegationTo(::std::ostream* os) const override {
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
      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; }
};

Abseil Team's avatar
Abseil Team committed
460
461
462
463
464
465
466
467
468
469
470
471
472
// Template specialization for parameterless Matcher.
template <typename Derived>
class MatcherBaseImpl {
 public:
  MatcherBaseImpl() = default;

  template <typename T>
  operator ::testing::Matcher<T>() const {  // NOLINT(runtime/explicit)
    return ::testing::Matcher<T>(new
                                 typename Derived::template gmock_Impl<T>());
  }
};

Abseil Team's avatar
Abseil Team committed
473
// Template specialization for Matcher with parameters.
Abseil Team's avatar
Abseil Team committed
474
475
476
template <template <typename...> class Derived, typename... Ts>
class MatcherBaseImpl<Derived<Ts...>> {
 public:
Abseil Team's avatar
Abseil Team committed
477
478
479
480
  // Mark the constructor explicit for single argument T to avoid implicit
  // conversions.
  template <typename E = std::enable_if<sizeof...(Ts) == 1>,
            typename E::type* = nullptr>
Abseil Team's avatar
Abseil Team committed
481
482
  explicit MatcherBaseImpl(Ts... params)
      : params_(std::forward<Ts>(params)...) {}
Abseil Team's avatar
Abseil Team committed
483
484
  template <typename E = std::enable_if<sizeof...(Ts) != 1>,
            typename = typename E::type>
Abseil Team's avatar
Abseil Team committed
485
486
  MatcherBaseImpl(Ts... params)  // NOLINT
      : params_(std::forward<Ts>(params)...) {}
Abseil Team's avatar
Abseil Team committed
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503

  template <typename F>
  operator ::testing::Matcher<F>() const {  // NOLINT(runtime/explicit)
    return Apply<F>(MakeIndexSequence<sizeof...(Ts)>{});
  }

 private:
  template <typename F, std::size_t... tuple_ids>
  ::testing::Matcher<F> Apply(IndexSequence<tuple_ids...>) const {
    return ::testing::Matcher<F>(
        new typename Derived<Ts...>::template gmock_Impl<F>(
            std::get<tuple_ids>(params_)...));
  }

  const std::tuple<Ts...> params_;
};

504
505
}  // namespace internal

506
507
508
509
510
// 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>
511
inline Matcher<T> MatcherCast(const M& matcher) {
512
513
  return internal::MatcherCastImpl<T, M>::Cast(matcher);
}
514

515
516
// This overload handles polymorphic matchers and values only since
// monomorphic matchers are handled by the next one.
517
template <typename T, typename M>
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
inline Matcher<T> SafeMatcherCast(const M& polymorphic_matcher_or_value) {
  return MatcherCast<T>(polymorphic_matcher_or_value);
}

// 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 T, typename U>
inline Matcher<T> SafeMatcherCast(const Matcher<U>& matcher) {
  // Enforce that T can be implicitly converted to U.
Abseil Team's avatar
Abseil Team committed
534
535
  static_assert(std::is_convertible<const T&, const U&>::value,
                "T must be implicitly convertible to U");
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
  // Enforce that we are not converting a non-reference type T to a reference
  // type U.
  GTEST_COMPILE_ASSERT_(
      std::is_reference<T>::value || !std::is_reference<U>::value,
      cannot_convert_non_reference_arg_to_reference);
  // In case both T and U are arithmetic types, enforce that the
  // conversion is not lossy.
  typedef GTEST_REMOVE_REFERENCE_AND_CONST_(T) RawT;
  typedef GTEST_REMOVE_REFERENCE_AND_CONST_(U) RawU;
  constexpr bool kTIsOther = GMOCK_KIND_OF_(RawT) == internal::kOther;
  constexpr bool kUIsOther = GMOCK_KIND_OF_(RawU) == internal::kOther;
  GTEST_COMPILE_ASSERT_(
      kTIsOther || kUIsOther ||
      (internal::LosslessArithmeticConvertible<RawT, RawU>::value),
      conversion_of_arithmetic_types_must_be_lossless);
  return MatcherCast<T>(matcher);
552
553
}

554
555
556
557
558
559
560
561
// 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 {

562
// If the explanation is not empty, prints it to the ostream.
563
inline void PrintIfNotEmpty(const std::string& explanation,
564
                            ::std::ostream* os) {
565
  if (explanation != "" && os != nullptr) {
566
    *os << ", " << explanation;
567
568
569
  }
}

570
571
572
// 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.
573
inline bool IsReadableTypeName(const std::string& type_name) {
574
575
576
  // We consider a type name readable if it's short or doesn't contain
  // a template or function type.
  return (type_name.length() <= 20 ||
577
          type_name.find_first_of("<(") == std::string::npos);
578
579
}

580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
// 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());
598
#if GTEST_HAS_RTTI
599
  const std::string& type_name = GetTypeName<Value>();
600
601
602
  if (IsReadableTypeName(type_name))
    *listener->stream() << " (of type " << type_name << ")";
#endif
603
  PrintIfNotEmpty(inner_listener.str(), listener->stream());
604
605
606
607

  return match;
}

608
609
610
611
612
613
// 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
614
615
  // if and only if the first N fields of matcher_tuple matches
  // the first N fields of value_tuple, respectively.
616
617
618
  template <typename MatcherTuple, typename ValueTuple>
  static bool Matches(const MatcherTuple& matcher_tuple,
                      const ValueTuple& value_tuple) {
Abseil Team's avatar
Abseil Team committed
619
620
    return TuplePrefix<N - 1>::Matches(matcher_tuple, value_tuple) &&
           std::get<N - 1>(matcher_tuple).Matches(std::get<N - 1>(value_tuple));
621
622
  }

623
  // TuplePrefix<N>::ExplainMatchFailuresTo(matchers, values, os)
624
625
626
627
  // 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>
628
629
630
  static void ExplainMatchFailuresTo(const MatcherTuple& matchers,
                                     const ValueTuple& values,
                                     ::std::ostream* os) {
631
    // First, describes failures in the first N - 1 fields.
632
    TuplePrefix<N - 1>::ExplainMatchFailuresTo(matchers, values, os);
633
634
635

    // Then describes the failure (if any) in the (N - 1)-th (0-based)
    // field.
Abseil Team's avatar
Abseil Team committed
636
637
638
    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
639
    const Value& value = std::get<N - 1>(values);
zhanyong.wan's avatar
zhanyong.wan committed
640
641
    StringMatchResultListener listener;
    if (!matcher.MatchAndExplain(value, &listener)) {
642
      *os << "  Expected arg #" << N - 1 << ": ";
Abseil Team's avatar
Abseil Team committed
643
      std::get<N - 1>(matchers).DescribeTo(os);
644
645
646
647
      *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
648
      // matcher's MatchAndExplain() method handles the case when
649
      // the address is interesting.
650
651
      internal::UniversalPrint(value, os);
      PrintIfNotEmpty(listener.str(), os);
652
653
654
655
656
657
658
659
660
661
      *os << "\n";
    }
  }
};

// The base case.
template <>
class TuplePrefix<0> {
 public:
  template <typename MatcherTuple, typename ValueTuple>
662
663
  static bool Matches(const MatcherTuple& /* matcher_tuple */,
                      const ValueTuple& /* value_tuple */) {
664
665
666
667
    return true;
  }

  template <typename MatcherTuple, typename ValueTuple>
668
669
670
  static void ExplainMatchFailuresTo(const MatcherTuple& /* matchers */,
                                     const ValueTuple& /* values */,
                                     ::std::ostream* /* os */) {}
671
672
};

673
674
// TupleMatches(matcher_tuple, value_tuple) returns true if and only if
// all matchers in matcher_tuple match the corresponding fields in
675
676
677
678
679
680
681
682
// 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
683
684
  GTEST_COMPILE_ASSERT_(std::tuple_size<MatcherTuple>::value ==
                            std::tuple_size<ValueTuple>::value,
685
                        matcher_and_value_have_different_numbers_of_fields);
Abseil Team's avatar
Abseil Team committed
686
687
  return TuplePrefix<std::tuple_size<ValueTuple>::value>::Matches(matcher_tuple,
                                                                  value_tuple);
688
689
690
691
692
}

// Describes failures in matching matchers against values.  If there
// is no failure, nothing will be streamed to os.
template <typename MatcherTuple, typename ValueTuple>
693
694
695
void ExplainMatchFailureTupleTo(const MatcherTuple& matchers,
                                const ValueTuple& values,
                                ::std::ostream* os) {
Abseil Team's avatar
Abseil Team committed
696
  TuplePrefix<std::tuple_size<MatcherTuple>::value>::ExplainMatchFailuresTo(
697
698
699
      matchers, values, os);
}

700
701
702
703
704
705
706
// 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
707
  typedef ::std::tuple_size<Tuple> TupleSize;
708
709
710
711
712
713
714
715
716
717
718
719

 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
720
      *out++ = f(::std::get<TupleSize::value - kRemainingSize>(t));
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
      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);
}

740
741
// Implements A<T>().
template <typename T>
Abseil Team's avatar
Abseil Team committed
742
class AnyMatcherImpl : public MatcherInterface<const T&> {
743
 public:
Abseil Team's avatar
Abseil Team committed
744
  bool MatchAndExplain(const T& /* x */,
Abseil Team's avatar
Abseil Team committed
745
                       MatchResultListener* /* listener */) const override {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
746
747
    return true;
  }
Abseil Team's avatar
Abseil Team committed
748
749
  void DescribeTo(::std::ostream* os) const override { *os << "is anything"; }
  void DescribeNegationTo(::std::ostream* os) const override {
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
    // 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>(); }
};

767
// Implements the polymorphic IsNull() matcher, which matches any raw or smart
zhanyong.wan's avatar
zhanyong.wan committed
768
769
770
// pointer that is NULL.
class IsNullMatcher {
 public:
771
  template <typename Pointer>
772
773
  bool MatchAndExplain(const Pointer& p,
                       MatchResultListener* /* listener */) const {
774
    return p == nullptr;
775
  }
zhanyong.wan's avatar
zhanyong.wan committed
776
777
778

  void DescribeTo(::std::ostream* os) const { *os << "is NULL"; }
  void DescribeNegationTo(::std::ostream* os) const {
779
    *os << "isn't NULL";
zhanyong.wan's avatar
zhanyong.wan committed
780
781
782
  }
};

783
// Implements the polymorphic NotNull() matcher, which matches any raw or smart
784
785
786
// pointer that is not NULL.
class NotNullMatcher {
 public:
787
  template <typename Pointer>
788
789
  bool MatchAndExplain(const Pointer& p,
                       MatchResultListener* /* listener */) const {
790
    return p != nullptr;
791
  }
792

793
  void DescribeTo(::std::ostream* os) const { *os << "isn't NULL"; }
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
  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_));
  }
837

838
839
840
841
842
843
 private:
  template <typename Super>
  class Impl : public MatcherInterface<Super&> {
   public:
    explicit Impl(Super& x) : object_(x) {}  // NOLINT

844
845
    // MatchAndExplain() takes a Super& (as opposed to const Super&)
    // in order to match the interface MatcherInterface<Super&>.
Abseil Team's avatar
Abseil Team committed
846
847
    bool MatchAndExplain(Super& x,
                         MatchResultListener* listener) const override {
848
      *listener << "which is located @" << static_cast<const void*>(&x);
zhanyong.wan's avatar
zhanyong.wan committed
849
850
      return &x == &object_;
    }
851

Abseil Team's avatar
Abseil Team committed
852
    void DescribeTo(::std::ostream* os) const override {
853
854
855
856
      *os << "references the variable ";
      UniversalPrinter<Super&>::Print(object_, os);
    }

Abseil Team's avatar
Abseil Team committed
857
    void DescribeNegationTo(::std::ostream* os) const override {
858
859
860
861
862
863
      *os << "does not reference the variable ";
      UniversalPrinter<Super&>::Print(object_, os);
    }

   private:
    const Super& object_;
864
865

    GTEST_DISALLOW_ASSIGN_(Impl);
866
867
868
  };

  T& object_;
869
870

  GTEST_DISALLOW_ASSIGN_(RefMatcher);
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
};

// 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) {}

Abseil Team's avatar
Abseil Team committed
916
917
#if GTEST_INTERNAL_HAS_STRING_VIEW
  bool MatchAndExplain(const internal::StringView& s,
Gennadiy Civil's avatar
 
Gennadiy Civil committed
918
                       MatchResultListener* listener) const {
Abseil Team's avatar
Abseil Team committed
919
    // This should fail to compile if StringView is used with wide
Gennadiy Civil's avatar
 
Gennadiy Civil committed
920
    // strings.
Abseil Team's avatar
Abseil Team committed
921
    const StringType& str = std::string(s);
Gennadiy Civil's avatar
 
Gennadiy Civil committed
922
923
    return MatchAndExplain(str, listener);
  }
Abseil Team's avatar
Abseil Team committed
924
#endif  // GTEST_INTERNAL_HAS_STRING_VIEW
Gennadiy Civil's avatar
 
Gennadiy Civil committed
925

926
927
928
929
930
931
932
  // Accepts pointer types, particularly:
  //   const char*
  //   char*
  //   const wchar_t*
  //   wchar_t*
  template <typename CharType>
  bool MatchAndExplain(CharType* s, MatchResultListener* listener) const {
933
    if (s == nullptr) {
934
935
      return !expect_eq_;
    }
936
    return MatchAndExplain(StringType(s), listener);
937
938
  }

939
940
941
  // Matches anything that can convert to StringType.
  //
  // This is a template, not just a plain function with const StringType&,
Abseil Team's avatar
Abseil Team committed
942
  // because StringView has some interfering non-explicit constructors.
943
944
  template <typename MatcheeStringType>
  bool MatchAndExplain(const MatcheeStringType& s,
945
                       MatchResultListener* /* listener */) const {
Abseil Team's avatar
Abseil Team committed
946
    const StringType s2(s);
947
948
    const bool eq = case_sensitive_ ? s2 == string_ :
        CaseInsensitiveStringEquals(s2, string_);
949
950
951
952
953
954
955
956
957
958
    return expect_eq_ == eq;
  }

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

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

960
961
 private:
  void DescribeToHelper(bool expect_eq, ::std::ostream* os) const {
962
    *os << (expect_eq ? "is " : "isn't ");
963
964
965
966
    *os << "equal to ";
    if (!case_sensitive_) {
      *os << "(ignoring case) ";
    }
vladlosev's avatar
vladlosev committed
967
    UniversalPrint(string_, os);
968
969
970
971
972
  }

  const StringType string_;
  const bool expect_eq_;
  const bool case_sensitive_;
973
974

  GTEST_DISALLOW_ASSIGN_(StrEqualityMatcher);
975
976
977
978
979
980
981
982
983
984
985
};

// 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) {}

Abseil Team's avatar
Abseil Team committed
986
987
#if GTEST_INTERNAL_HAS_STRING_VIEW
  bool MatchAndExplain(const internal::StringView& s,
Gennadiy Civil's avatar
 
Gennadiy Civil committed
988
                       MatchResultListener* listener) const {
Abseil Team's avatar
Abseil Team committed
989
    // This should fail to compile if StringView is used with wide
Gennadiy Civil's avatar
 
Gennadiy Civil committed
990
    // strings.
Abseil Team's avatar
Abseil Team committed
991
    const StringType& str = std::string(s);
Gennadiy Civil's avatar
 
Gennadiy Civil committed
992
993
    return MatchAndExplain(str, listener);
  }
Abseil Team's avatar
Abseil Team committed
994
#endif  // GTEST_INTERNAL_HAS_STRING_VIEW
Gennadiy Civil's avatar
 
Gennadiy Civil committed
995

996
997
998
999
1000
1001
1002
  // Accepts pointer types, particularly:
  //   const char*
  //   char*
  //   const wchar_t*
  //   wchar_t*
  template <typename CharType>
  bool MatchAndExplain(CharType* s, MatchResultListener* listener) const {
1003
    return s != nullptr && MatchAndExplain(StringType(s), listener);
1004
1005
  }

1006
1007
1008
  // Matches anything that can convert to StringType.
  //
  // This is a template, not just a plain function with const StringType&,
Abseil Team's avatar
Abseil Team committed
1009
  // because StringView has some interfering non-explicit constructors.
1010
1011
  template <typename MatcheeStringType>
  bool MatchAndExplain(const MatcheeStringType& s,
1012
                       MatchResultListener* /* listener */) const {
Abseil Team's avatar
Abseil Team committed
1013
    return StringType(s).find(substring_) != StringType::npos;
1014
1015
1016
1017
1018
  }

  // Describes what this matcher matches.
  void DescribeTo(::std::ostream* os) const {
    *os << "has substring ";
vladlosev's avatar
vladlosev committed
1019
    UniversalPrint(substring_, os);
1020
1021
1022
1023
  }

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

1027
1028
 private:
  const StringType substring_;
1029
1030

  GTEST_DISALLOW_ASSIGN_(HasSubstrMatcher);
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
};

// 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) {
  }

Abseil Team's avatar
Abseil Team committed
1042
1043
#if GTEST_INTERNAL_HAS_STRING_VIEW
  bool MatchAndExplain(const internal::StringView& s,
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1044
                       MatchResultListener* listener) const {
Abseil Team's avatar
Abseil Team committed
1045
    // This should fail to compile if StringView is used with wide
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1046
    // strings.
Abseil Team's avatar
Abseil Team committed
1047
    const StringType& str = std::string(s);
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1048
1049
    return MatchAndExplain(str, listener);
  }
Abseil Team's avatar
Abseil Team committed
1050
#endif  // GTEST_INTERNAL_HAS_STRING_VIEW
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1051

1052
1053
1054
1055
1056
1057
1058
  // Accepts pointer types, particularly:
  //   const char*
  //   char*
  //   const wchar_t*
  //   wchar_t*
  template <typename CharType>
  bool MatchAndExplain(CharType* s, MatchResultListener* listener) const {
1059
    return s != nullptr && MatchAndExplain(StringType(s), listener);
1060
1061
  }

1062
1063
1064
  // Matches anything that can convert to StringType.
  //
  // This is a template, not just a plain function with const StringType&,
Abseil Team's avatar
Abseil Team committed
1065
  // because StringView has some interfering non-explicit constructors.
1066
1067
  template <typename MatcheeStringType>
  bool MatchAndExplain(const MatcheeStringType& s,
1068
                       MatchResultListener* /* listener */) const {
1069
1070
1071
    const StringType& s2(s);
    return s2.length() >= prefix_.length() &&
        s2.substr(0, prefix_.length()) == prefix_;
1072
1073
1074
1075
  }

  void DescribeTo(::std::ostream* os) const {
    *os << "starts with ";
vladlosev's avatar
vladlosev committed
1076
    UniversalPrint(prefix_, os);
1077
1078
1079
1080
  }

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

1084
1085
 private:
  const StringType prefix_;
1086
1087

  GTEST_DISALLOW_ASSIGN_(StartsWithMatcher);
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
};

// 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) {}

Abseil Team's avatar
Abseil Team committed
1098
1099
#if GTEST_INTERNAL_HAS_STRING_VIEW
  bool MatchAndExplain(const internal::StringView& s,
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1100
                       MatchResultListener* listener) const {
Abseil Team's avatar
Abseil Team committed
1101
    // This should fail to compile if StringView is used with wide
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1102
    // strings.
Abseil Team's avatar
Abseil Team committed
1103
    const StringType& str = std::string(s);
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1104
1105
    return MatchAndExplain(str, listener);
  }
Abseil Team's avatar
Abseil Team committed
1106
#endif  // GTEST_INTERNAL_HAS_STRING_VIEW
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1107

1108
1109
1110
1111
1112
1113
1114
  // Accepts pointer types, particularly:
  //   const char*
  //   char*
  //   const wchar_t*
  //   wchar_t*
  template <typename CharType>
  bool MatchAndExplain(CharType* s, MatchResultListener* listener) const {
1115
    return s != nullptr && MatchAndExplain(StringType(s), listener);
1116
1117
  }

1118
1119
1120
  // Matches anything that can convert to StringType.
  //
  // This is a template, not just a plain function with const StringType&,
Abseil Team's avatar
Abseil Team committed
1121
  // because StringView has some interfering non-explicit constructors.
1122
1123
  template <typename MatcheeStringType>
  bool MatchAndExplain(const MatcheeStringType& s,
1124
                       MatchResultListener* /* listener */) const {
1125
1126
1127
    const StringType& s2(s);
    return s2.length() >= suffix_.length() &&
        s2.substr(s2.length() - suffix_.length()) == suffix_;
1128
1129
1130
1131
  }

  void DescribeTo(::std::ostream* os) const {
    *os << "ends with ";
vladlosev's avatar
vladlosev committed
1132
    UniversalPrint(suffix_, os);
1133
1134
1135
1136
  }

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

1140
1141
 private:
  const StringType suffix_;
1142
1143

  GTEST_DISALLOW_ASSIGN_(EndsWithMatcher);
1144
1145
1146
1147
1148
1149
1150
};

// 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
1151
// used to match a std::tuple<int, short>, a std::tuple<const long&, double>,
1152
1153
// etc).  Therefore we use a template type conversion operator in the
// implementation.
1154
1155
1156
1157
template <typename D, typename Op>
class PairMatchBase {
 public:
  template <typename T1, typename T2>
Abseil Team's avatar
Abseil Team committed
1158
  operator Matcher<::std::tuple<T1, T2>>() const {
Abseil Team's avatar
Abseil Team committed
1159
    return Matcher<::std::tuple<T1, T2>>(new Impl<const ::std::tuple<T1, T2>&>);
1160
1161
  }
  template <typename T1, typename T2>
Abseil Team's avatar
Abseil Team committed
1162
1163
  operator Matcher<const ::std::tuple<T1, T2>&>() const {
    return MakeMatcher(new Impl<const ::std::tuple<T1, T2>&>);
1164
1165
1166
1167
1168
  }

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

1171
1172
1173
  template <typename Tuple>
  class Impl : public MatcherInterface<Tuple> {
   public:
Abseil Team's avatar
Abseil Team committed
1174
1175
    bool MatchAndExplain(Tuple args,
                         MatchResultListener* /* listener */) const override {
Abseil Team's avatar
Abseil Team committed
1176
      return Op()(::std::get<0>(args), ::std::get<1>(args));
1177
    }
Abseil Team's avatar
Abseil Team committed
1178
    void DescribeTo(::std::ostream* os) const override {
1179
1180
      *os << "are " << GetDesc;
    }
Abseil Team's avatar
Abseil Team committed
1181
    void DescribeNegationTo(::std::ostream* os) const override {
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
      *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"; }
};
1211

1212
1213
1214
1215
1216
// 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
1217
class NotMatcherImpl : public MatcherInterface<const T&> {
1218
1219
1220
1221
 public:
  explicit NotMatcherImpl(const Matcher<T>& matcher)
      : matcher_(matcher) {}

Abseil Team's avatar
Abseil Team committed
1222
  bool MatchAndExplain(const T& x,
Abseil Team's avatar
Abseil Team committed
1223
                       MatchResultListener* listener) const override {
zhanyong.wan's avatar
zhanyong.wan committed
1224
    return !matcher_.MatchAndExplain(x, listener);
1225
1226
  }

Abseil Team's avatar
Abseil Team committed
1227
  void DescribeTo(::std::ostream* os) const override {
1228
1229
1230
    matcher_.DescribeNegationTo(os);
  }

Abseil Team's avatar
Abseil Team committed
1231
  void DescribeNegationTo(::std::ostream* os) const override {
1232
1233
1234
1235
1236
    matcher_.DescribeTo(os);
  }

 private:
  const Matcher<T> matcher_;
1237
1238

  GTEST_DISALLOW_ASSIGN_(NotMatcherImpl);
1239
1240
};

1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
// 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 {
1252
    return Matcher<T>(new NotMatcherImpl<T>(SafeMatcherCast<T>(matcher_)));
1253
  }
1254

1255
 private:
1256
  InnerMatcher matcher_;
1257
1258

  GTEST_DISALLOW_ASSIGN_(NotMatcher);
1259
};
1260

1261
1262
1263
1264
1265
// 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
1266
class AllOfMatcherImpl : public MatcherInterface<const T&> {
1267
 public:
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1268
  explicit AllOfMatcherImpl(std::vector<Matcher<T> > matchers)
Abseil Team's avatar
Abseil Team committed
1269
      : matchers_(std::move(matchers)) {}
1270

Abseil Team's avatar
Abseil Team committed
1271
  void DescribeTo(::std::ostream* os) const override {
1272
    *os << "(";
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1273
1274
1275
1276
    for (size_t i = 0; i < matchers_.size(); ++i) {
      if (i != 0) *os << ") and (";
      matchers_[i].DescribeTo(os);
    }
1277
1278
    *os << ")";
  }
1279

Abseil Team's avatar
Abseil Team committed
1280
  void DescribeNegationTo(::std::ostream* os) const override {
1281
    *os << "(";
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1282
1283
1284
1285
    for (size_t i = 0; i < matchers_.size(); ++i) {
      if (i != 0) *os << ") or (";
      matchers_[i].DescribeNegationTo(os);
    }
1286
    *os << ")";
1287
  }
1288

Abseil Team's avatar
Abseil Team committed
1289
  bool MatchAndExplain(const T& x,
Abseil Team's avatar
Abseil Team committed
1290
                       MatchResultListener* listener) const override {
zhanyong.wan's avatar
zhanyong.wan committed
1291
1292
    // 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
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
    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
1311
    }
1312

zhanyong.wan's avatar
zhanyong.wan committed
1313
    // Otherwise we need to explain why *both* of them match.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1314
    *listener << all_match_result;
zhanyong.wan's avatar
zhanyong.wan committed
1315
    return true;
1316
  }
1317

1318
 private:
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1319
  const std::vector<Matcher<T> > matchers_;
1320

Gennadiy Civil's avatar
 
Gennadiy Civil committed
1321
  GTEST_DISALLOW_ASSIGN_(AllOfMatcherImpl);
1322
1323
};

1324
1325
1326
1327
1328
1329
1330
1331
// 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
1332
1333
1334
      : matchers_(matchers...) {
    static_assert(sizeof...(Args) > 0, "Must have at least one matcher.");
  }
1335
1336
1337
1338
1339
1340

  // 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
1341
1342
    std::vector<Matcher<T> > values;
    CreateVariadicMatcher<T>(&values, std::integral_constant<size_t, 0>());
Abseil Team's avatar
Abseil Team committed
1343
    return Matcher<T>(new CombiningMatcher<T>(std::move(values)));
1344
1345
1346
  }

 private:
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
  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 {}
1358

Abseil Team's avatar
Abseil Team committed
1359
  std::tuple<Args...> matchers_;
1360
1361
1362
1363
1364

  GTEST_DISALLOW_ASSIGN_(VariadicMatcher);
};

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

1367
1368
1369
1370
1371
// 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
1372
class AnyOfMatcherImpl : public MatcherInterface<const T&> {
1373
 public:
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1374
  explicit AnyOfMatcherImpl(std::vector<Matcher<T> > matchers)
Abseil Team's avatar
Abseil Team committed
1375
      : matchers_(std::move(matchers)) {}
1376

Abseil Team's avatar
Abseil Team committed
1377
  void DescribeTo(::std::ostream* os) const override {
1378
    *os << "(";
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1379
1380
1381
1382
    for (size_t i = 0; i < matchers_.size(); ++i) {
      if (i != 0) *os << ") or (";
      matchers_[i].DescribeTo(os);
    }
1383
1384
    *os << ")";
  }
1385

Abseil Team's avatar
Abseil Team committed
1386
  void DescribeNegationTo(::std::ostream* os) const override {
1387
    *os << "(";
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1388
1389
1390
1391
    for (size_t i = 0; i < matchers_.size(); ++i) {
      if (i != 0) *os << ") and (";
      matchers_[i].DescribeNegationTo(os);
    }
1392
    *os << ")";
1393
1394
  }

Abseil Team's avatar
Abseil Team committed
1395
  bool MatchAndExplain(const T& x,
Abseil Team's avatar
Abseil Team committed
1396
                       MatchResultListener* listener) const override {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1397
1398
    std::string no_match_result;

zhanyong.wan's avatar
zhanyong.wan committed
1399
1400
    // If either matcher1_ or matcher2_ matches x, we just need to
    // explain why *one* of them matches.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
    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
1417
    }
1418

zhanyong.wan's avatar
zhanyong.wan committed
1419
    // Otherwise we need to explain why *both* of them fail.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1420
    *listener << no_match_result;
zhanyong.wan's avatar
zhanyong.wan committed
1421
    return false;
1422
  }
1423

1424
 private:
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1425
  const std::vector<Matcher<T> > matchers_;
1426

Gennadiy Civil's avatar
 
Gennadiy Civil committed
1427
  GTEST_DISALLOW_ASSIGN_(AnyOfMatcherImpl);
1428
1429
};

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

Abseil Team's avatar
Abseil Team committed
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
// Wrapper for implementation of Any/AllOfArray().
template <template <class> class MatcherImpl, typename T>
class SomeOfArrayMatcher {
 public:
  // Constructs the matcher from a sequence of element values or
  // element matchers.
  template <typename Iter>
  SomeOfArrayMatcher(Iter first, Iter last) : matchers_(first, last) {}

  template <typename U>
  operator Matcher<U>() const {  // NOLINT
    using RawU = typename std::decay<U>::type;
    std::vector<Matcher<RawU>> matchers;
    for (const auto& matcher : matchers_) {
      matchers.push_back(MatcherCast<RawU>(matcher));
    }
    return Matcher<U>(new MatcherImpl<RawU>(std::move(matchers)));
  }

 private:
  const ::std::vector<T> matchers_;

  GTEST_DISALLOW_ASSIGN_(SomeOfArrayMatcher);
};

template <typename T>
using AllOfArrayMatcher = SomeOfArrayMatcher<AllOfMatcherImpl, T>;

template <typename T>
using AnyOfArrayMatcher = SomeOfArrayMatcher<AnyOfMatcherImpl, T>;

1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
// 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>
1477
1478
  bool MatchAndExplain(T& x,  // NOLINT
                       MatchResultListener* /* listener */) const {
1479
1480
1481
1482
1483
1484
1485
1486
1487
    // 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;
1488
1489
1490
1491
1492
1493
1494
1495
1496
  }

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

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

1498
1499
 private:
  Predicate predicate_;
1500
1501

  GTEST_DISALLOW_ASSIGN_(TrulyMatcher);
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
};

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

1536
1537
 private:
  M matcher_;
1538
1539

  GTEST_DISALLOW_ASSIGN_(MatcherAsPredicate);
1540
1541
1542
1543
1544
1545
1546
};

// 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
1547
  explicit PredicateFormatterFromMatcher(M m) : matcher_(std::move(m)) {}
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559

  // 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.
    //
1560
    // We write SafeMatcherCast<const T&>(matcher_) instead of
1561
1562
    // Matcher<const T&>(matcher_), as the latter won't compile when
    // matcher_ has type Matcher<T> (e.g. An<int>()).
1563
1564
1565
    // 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
1566
1567
1568
1569

    // 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)) {
1570
      return AssertionSuccess();
Abseil Team's avatar
Abseil Team committed
1571
    }
1572
1573
1574
1575
1576

    ::std::stringstream ss;
    ss << "Value of: " << value_text << "\n"
       << "Expected: ";
    matcher.DescribeTo(&ss);
Abseil Team's avatar
Abseil Team committed
1577

Krystian Kuzniarek's avatar
Krystian Kuzniarek committed
1578
    // Rerun the matcher to "PrintAndExplain" the failure.
Abseil Team's avatar
Abseil Team committed
1579
1580
1581
1582
1583
    StringMatchResultListener listener;
    if (MatchPrintAndExplain(x, matcher, &listener)) {
      ss << "\n  The matcher failed on the initial attempt; but passed when "
            "rerun to generate the explanation.";
    }
1584
1585
    ss << "\n  Actual: " << listener.str();
    return AssertionFailure() << ss.str();
1586
  }
1587

1588
1589
 private:
  const M matcher_;
1590
1591

  GTEST_DISALLOW_ASSIGN_(PredicateFormatterFromMatcher);
1592
1593
1594
1595
1596
};

// 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().
1597
// Implementation detail: 'matcher' is received by-value to force decaying.
1598
1599
template <typename M>
inline PredicateFormatterFromMatcher<M>
1600
MakePredicateFormatterFromMatcher(M matcher) {
Abseil Team's avatar
Abseil Team committed
1601
  return PredicateFormatterFromMatcher<M>(std::move(matcher));
1602
1603
}

Abseil Team's avatar
Abseil Team committed
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
// Implements the polymorphic IsNan() matcher, which matches any floating type
// value that is Nan.
class IsNanMatcher {
 public:
  template <typename FloatType>
  bool MatchAndExplain(const FloatType& f,
                       MatchResultListener* /* listener */) const {
    return (::std::isnan)(f);
  }

  void DescribeTo(::std::ostream* os) const { *os << "is NaN"; }
  void DescribeNegationTo(::std::ostream* os) const {
    *os << "isn't NaN";
  }
};

1620
1621
1622
1623
// 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.
1624
1625
1626
1627
template <typename FloatType>
class FloatingEqMatcher {
 public:
  // Constructor for FloatingEqMatcher.
1628
  // The matcher's input will be compared with expected.  The matcher treats two
1629
  // NANs as equal if nan_eq_nan is true.  Otherwise, under IEEE standards,
1630
1631
1632
  // 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.
1633
1634
  FloatingEqMatcher(FloatType expected, bool nan_eq_nan) :
    expected_(expected), nan_eq_nan_(nan_eq_nan), max_abs_error_(-1) {
1635
1636
1637
1638
1639
  }

  // 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.
1640
1641
1642
1643
1644
  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) {
1645
1646
1647
    GTEST_CHECK_(max_abs_error >= 0)
        << ", where max_abs_error is" << max_abs_error;
  }
1648
1649
1650
1651
1652

  // Implements floating point equality matcher as a Matcher<T>.
  template <typename T>
  class Impl : public MatcherInterface<T> {
   public:
1653
1654
1655
1656
    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) {}
1657

Abseil Team's avatar
Abseil Team committed
1658
1659
    bool MatchAndExplain(T value,
                         MatchResultListener* listener) const override {
1660
      const FloatingPoint<FloatType> actual(value), expected(expected_);
1661
1662

      // Compares NaNs first, if nan_eq_nan_ is true.
1663
1664
      if (actual.is_nan() || expected.is_nan()) {
        if (actual.is_nan() && expected.is_nan()) {
1665
1666
1667
1668
1669
1670
1671
          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
1672
        // of error bounds.  If the result of value - expected_ would result in
1673
1674
        // overflow or if either value is inf, the default result is infinity,
        // which should only match if max_abs_error_ is also infinity.
1675
1676
1677
1678
1679
        if (value == expected_) {
          return true;
        }

        const FloatType diff = value - expected_;
Abseil Team's avatar
Abseil Team committed
1680
        if (::std::fabs(diff) <= max_abs_error_) {
1681
1682
1683
1684
1685
1686
1687
          return true;
        }

        if (listener->IsInterested()) {
          *listener << "which is " << diff << " from " << expected_;
        }
        return false;
1688
      } else {
1689
        return actual.AlmostEquals(expected);
1690
1691
1692
      }
    }

Abseil Team's avatar
Abseil Team committed
1693
    void DescribeTo(::std::ostream* os) const override {
1694
1695
1696
1697
1698
      // 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);
1699
      if (FloatingPoint<FloatType>(expected_).is_nan()) {
1700
1701
1702
1703
1704
1705
        if (nan_eq_nan_) {
          *os << "is NaN";
        } else {
          *os << "never matches";
        }
      } else {
1706
        *os << "is approximately " << expected_;
1707
1708
1709
        if (HasMaxAbsError()) {
          *os << " (absolute error <= " << max_abs_error_ << ")";
        }
1710
1711
1712
1713
      }
      os->precision(old_precision);
    }

Abseil Team's avatar
Abseil Team committed
1714
    void DescribeNegationTo(::std::ostream* os) const override {
1715
1716
1717
      // As before, get original precision.
      const ::std::streamsize old_precision = os->precision(
          ::std::numeric_limits<FloatType>::digits10 + 2);
1718
      if (FloatingPoint<FloatType>(expected_).is_nan()) {
1719
        if (nan_eq_nan_) {
1720
          *os << "isn't NaN";
1721
1722
1723
1724
        } else {
          *os << "is anything";
        }
      } else {
1725
        *os << "isn't approximately " << expected_;
1726
1727
1728
        if (HasMaxAbsError()) {
          *os << " (absolute error > " << max_abs_error_ << ")";
        }
1729
1730
1731
1732
1733
1734
      }
      // Restore original precision.
      os->precision(old_precision);
    }

   private:
1735
1736
1737
1738
    bool HasMaxAbsError() const {
      return max_abs_error_ >= 0;
    }

1739
    const FloatType expected_;
1740
    const bool nan_eq_nan_;
1741
1742
    // max_abs_error will be used for value comparison when >= 0.
    const FloatType max_abs_error_;
1743
1744

    GTEST_DISALLOW_ASSIGN_(Impl);
1745
1746
  };

1747
1748
  // The following 3 type conversion operators allow FloatEq(expected) and
  // NanSensitiveFloatEq(expected) to be used as a Matcher<float>, a
1749
1750
1751
1752
1753
  // 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 {
1754
1755
    return MakeMatcher(
        new Impl<FloatType>(expected_, nan_eq_nan_, max_abs_error_));
1756
1757
1758
  }

  operator Matcher<const FloatType&>() const {
1759
    return MakeMatcher(
1760
        new Impl<const FloatType&>(expected_, nan_eq_nan_, max_abs_error_));
1761
1762
1763
  }

  operator Matcher<FloatType&>() const {
1764
1765
    return MakeMatcher(
        new Impl<FloatType&>(expected_, nan_eq_nan_, max_abs_error_));
1766
  }
1767

1768
 private:
1769
  const FloatType expected_;
1770
  const bool nan_eq_nan_;
1771
1772
  // max_abs_error will be used for value comparison when >= 0.
  const FloatType max_abs_error_;
1773
1774

  GTEST_DISALLOW_ASSIGN_(FloatingEqMatcher);
1775
1776
};

Gennadiy Civil's avatar
 
Gennadiy Civil committed
1777
1778
1779
1780
1781
1782
1783
1784
// 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:
1785
  FloatingEq2Matcher() { Init(-1, false); }
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1786

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

1789
1790
1791
  explicit FloatingEq2Matcher(FloatType max_abs_error) {
    Init(max_abs_error, false);
  }
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1792

1793
1794
1795
  FloatingEq2Matcher(FloatType max_abs_error, bool nan_eq_nan) {
    Init(max_abs_error, nan_eq_nan);
  }
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1796
1797

  template <typename T1, typename T2>
Abseil Team's avatar
Abseil Team committed
1798
  operator Matcher<::std::tuple<T1, T2>>() const {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1799
    return MakeMatcher(
Abseil Team's avatar
Abseil Team committed
1800
        new Impl<::std::tuple<T1, T2>>(max_abs_error_, nan_eq_nan_));
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1801
1802
  }
  template <typename T1, typename T2>
Abseil Team's avatar
Abseil Team committed
1803
  operator Matcher<const ::std::tuple<T1, T2>&>() const {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1804
    return MakeMatcher(
Abseil Team's avatar
Abseil Team committed
1805
        new Impl<const ::std::tuple<T1, T2>&>(max_abs_error_, nan_eq_nan_));
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
  }

 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
1820
1821
    bool MatchAndExplain(Tuple args,
                         MatchResultListener* listener) const override {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1822
      if (max_abs_error_ == -1) {
Abseil Team's avatar
Abseil Team committed
1823
1824
1825
        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
1826
      } else {
Abseil Team's avatar
Abseil Team committed
1827
        FloatingEqMatcher<FloatType> fm(::std::get<0>(args), nan_eq_nan_,
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1828
                                        max_abs_error_);
Abseil Team's avatar
Abseil Team committed
1829
1830
        return static_cast<Matcher<FloatType>>(fm).MatchAndExplain(
            ::std::get<1>(args), listener);
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1831
1832
      }
    }
Abseil Team's avatar
Abseil Team committed
1833
    void DescribeTo(::std::ostream* os) const override {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1834
1835
      *os << "are " << GetDesc;
    }
Abseil Team's avatar
Abseil Team committed
1836
    void DescribeNegationTo(::std::ostream* os) const override {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1837
1838
1839
1840
1841
1842
1843
1844
      *os << "aren't " << GetDesc;
    }

   private:
    FloatType max_abs_error_;
    const bool nan_eq_nan_;
  };

1845
1846
1847
1848
  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
1849
  FloatType max_abs_error_;
1850
  bool nan_eq_nan_;
Gennadiy Civil's avatar
 
Gennadiy Civil committed
1851
1852
};

1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
// 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
1870
    return Matcher<Pointer>(new Impl<const Pointer&>(matcher_));
1871
  }
1872

1873
1874
1875
1876
1877
 private:
  // The monomorphic implementation that works for a particular pointer type.
  template <typename Pointer>
  class Impl : public MatcherInterface<Pointer> {
   public:
1878
1879
    typedef typename PointeeOf<GTEST_REMOVE_REFERENCE_AND_CONST_(Pointer)>::type
        Pointee;
1880
1881
1882
1883

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

Abseil Team's avatar
Abseil Team committed
1884
    void DescribeTo(::std::ostream* os) const override {
1885
1886
1887
1888
      *os << "points to a value that ";
      matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
1889
    void DescribeNegationTo(::std::ostream* os) const override {
1890
1891
1892
1893
      *os << "does not point to a value that ";
      matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
1894
1895
    bool MatchAndExplain(Pointer pointer,
                         MatchResultListener* listener) const override {
1896
      if (GetRawPointer(pointer) == nullptr) return false;
1897

1898
1899
      *listener << "which points to ";
      return MatchPrintAndExplain(*pointer, matcher_, listener);
1900
    }
1901

1902
1903
   private:
    const Matcher<const Pointee&> matcher_;
1904
1905

    GTEST_DISALLOW_ASSIGN_(Impl);
1906
1907
1908
  };

  const InnerMatcher matcher_;
1909
1910

  GTEST_DISALLOW_ASSIGN_(PointeeMatcher);
1911
1912
};

1913
#if GTEST_HAS_RTTI
billydonahue's avatar
billydonahue committed
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
// 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_;

1939
  static std::string GetToName() {
billydonahue's avatar
billydonahue committed
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
    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 {
    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);
1978
    if (to == nullptr) {
billydonahue's avatar
billydonahue committed
1979
1980
1981
1982
1983
1984
      *listener << "which cannot be dynamic_cast to " << this->GetToName();
      return false;
    }
    return MatchPrintAndExplain(*to, this->matcher_, listener);
  }
};
1985
#endif  // GTEST_HAS_RTTI
billydonahue's avatar
billydonahue committed
1986

1987
1988
1989
1990
1991
1992
1993
// 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
1994
1995
1996
1997
1998
1999
2000
      : 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 + "` ") {}
2001
2002

  void DescribeTo(::std::ostream* os) const {
Gennadiy Civil's avatar
Gennadiy Civil committed
2003
    *os << "is an object " << whose_field_;
2004
2005
2006
2007
    matcher_.DescribeTo(os);
  }

  void DescribeNegationTo(::std::ostream* os) const {
Gennadiy Civil's avatar
Gennadiy Civil committed
2008
    *os << "is an object " << whose_field_;
2009
2010
2011
    matcher_.DescribeNegationTo(os);
  }

2012
2013
  template <typename T>
  bool MatchAndExplain(const T& value, MatchResultListener* listener) const {
Abseil Team's avatar
Abseil Team committed
2014
2015
    // FIXME: The dispatch on std::is_pointer was introduced as a workaround for
    // a compiler bug, and can now be removed.
2016
    return MatchAndExplainImpl(
2017
2018
        typename std::is_pointer<typename std::remove_const<T>::type>::type(),
        value, listener);
2019
2020
2021
  }

 private:
Abseil Team's avatar
Abseil Team committed
2022
2023
  bool MatchAndExplainImpl(std::false_type /* is_not_pointer */,
                           const Class& obj,
2024
                           MatchResultListener* listener) const {
Gennadiy Civil's avatar
Gennadiy Civil committed
2025
    *listener << whose_field_ << "is ";
2026
    return MatchPrintAndExplain(obj.*field_, matcher_, listener);
2027
2028
  }

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

2033
    *listener << "which points to an object ";
zhanyong.wan's avatar
zhanyong.wan committed
2034
2035
2036
    // 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
2037
    return MatchAndExplainImpl(std::false_type(), *p, listener);
2038
  }
2039

2040
2041
  const FieldType Class::*field_;
  const Matcher<const FieldType&> matcher_;
2042

Gennadiy Civil's avatar
Gennadiy Civil committed
2043
2044
2045
2046
  // 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_;

2047
  GTEST_DISALLOW_ASSIGN_(FieldMatcher);
2048
2049
2050
2051
};

// Implements the Property() matcher for matching a property
// (i.e. return value of a getter method) of an object.
2052
2053
2054
2055
//
// Property is a const-qualified member function of Class returning
// PropertyType.
template <typename Class, typename PropertyType, typename Property>
2056
2057
class PropertyMatcher {
 public:
Abseil Team's avatar
Abseil Team committed
2058
  typedef const PropertyType& RefToConstProperty;
2059

2060
  PropertyMatcher(Property property, const Matcher<RefToConstProperty>& matcher)
Gennadiy Civil's avatar
Gennadiy Civil committed
2061
2062
2063
2064
2065
2066
2067
2068
2069
      : 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 + "` ") {}
2070
2071

  void DescribeTo(::std::ostream* os) const {
Gennadiy Civil's avatar
Gennadiy Civil committed
2072
    *os << "is an object " << whose_property_;
2073
2074
2075
2076
    matcher_.DescribeTo(os);
  }

  void DescribeNegationTo(::std::ostream* os) const {
Gennadiy Civil's avatar
Gennadiy Civil committed
2077
    *os << "is an object " << whose_property_;
2078
2079
2080
    matcher_.DescribeNegationTo(os);
  }

2081
2082
2083
  template <typename T>
  bool MatchAndExplain(const T&value, MatchResultListener* listener) const {
    return MatchAndExplainImpl(
2084
2085
        typename std::is_pointer<typename std::remove_const<T>::type>::type(),
        value, listener);
2086
2087
2088
  }

 private:
Abseil Team's avatar
Abseil Team committed
2089
2090
  bool MatchAndExplainImpl(std::false_type /* is_not_pointer */,
                           const Class& obj,
2091
                           MatchResultListener* listener) const {
Gennadiy Civil's avatar
Gennadiy Civil committed
2092
    *listener << whose_property_ << "is ";
2093
2094
2095
2096
    // 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);
2097
2098
  }

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

2103
    *listener << "which points to an object ";
zhanyong.wan's avatar
zhanyong.wan committed
2104
2105
2106
    // 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
2107
    return MatchAndExplainImpl(std::false_type(), *p, listener);
2108
  }
2109

2110
  Property property_;
2111
  const Matcher<RefToConstProperty> matcher_;
2112

Gennadiy Civil's avatar
Gennadiy Civil committed
2113
2114
2115
2116
  // 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_;

2117
  GTEST_DISALLOW_ASSIGN_(PropertyMatcher);
2118
2119
2120
2121
2122
2123
2124
2125
};

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

2126
  static void CheckIsValid(Functor /* functor */) {}
2127
2128

  template <typename T>
Abseil Team's avatar
Abseil Team committed
2129
2130
2131
  static auto Invoke(Functor f, const T& arg) -> decltype(f(arg)) {
    return f(arg);
  }
2132
2133
2134
2135
2136
2137
2138
2139
2140
};

// 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)) {
2141
    GTEST_CHECK_(f != nullptr)
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
        << "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.
2152
template <typename Callable, typename InnerMatcher>
2153
2154
class ResultOfMatcher {
 public:
2155
  ResultOfMatcher(Callable callable, InnerMatcher matcher)
Abseil Team's avatar
Abseil Team committed
2156
      : callable_(std::move(callable)), matcher_(std::move(matcher)) {
2157
2158
2159
2160
2161
    CallableTraits<Callable>::CheckIsValid(callable_);
  }

  template <typename T>
  operator Matcher<T>() const {
Abseil Team's avatar
Abseil Team committed
2162
    return Matcher<T>(new Impl<const T&>(callable_, matcher_));
2163
2164
2165
2166
2167
2168
2169
  }

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

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

2173
   public:
2174
2175
2176
    template <typename M>
    Impl(const CallableStorageType& callable, const M& matcher)
        : callable_(callable), matcher_(MatcherCast<ResultType>(matcher)) {}
2177

Abseil Team's avatar
Abseil Team committed
2178
    void DescribeTo(::std::ostream* os) const override {
2179
      *os << "is mapped by the given callable to a value that ";
2180
2181
2182
      matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
2183
    void DescribeNegationTo(::std::ostream* os) const override {
2184
      *os << "is mapped by the given callable to a value that ";
2185
2186
2187
      matcher_.DescribeNegationTo(os);
    }

Abseil Team's avatar
Abseil Team committed
2188
    bool MatchAndExplain(T obj, MatchResultListener* listener) const override {
2189
      *listener << "which is mapped by the given callable to ";
2190
2191
2192
2193
      // 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&>).
2194
2195
2196
      ResultType result =
          CallableTraits<Callable>::template Invoke<T>(callable_, obj);
      return MatchPrintAndExplain(result, matcher_, listener);
2197
    }
2198

2199
2200
   private:
    // Functors often define operator() as non-const method even though
Troy Holsapple's avatar
Troy Holsapple committed
2201
    // they are actually stateless. But we need to use them even when
2202
    // 'this' is a const pointer. It's the user's responsibility not to
2203
    // use stateful callables with ResultOf(), which doesn't guarantee
2204
2205
2206
    // how many times the callable will be invoked.
    mutable CallableStorageType callable_;
    const Matcher<ResultType> matcher_;
2207
2208

    GTEST_DISALLOW_ASSIGN_(Impl);
2209
2210
2211
  };  // class Impl

  const CallableStorageType callable_;
2212
  const InnerMatcher matcher_;
2213
2214

  GTEST_DISALLOW_ASSIGN_(ResultOfMatcher);
2215
2216
};

zhanyong.wan's avatar
zhanyong.wan committed
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
// 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
2227
    return Matcher<Container>(new Impl<const Container&>(size_matcher_));
zhanyong.wan's avatar
zhanyong.wan committed
2228
2229
2230
2231
2232
  }

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

Abseil Team's avatar
Abseil Team committed
2237
    void DescribeTo(::std::ostream* os) const override {
zhanyong.wan's avatar
zhanyong.wan committed
2238
2239
2240
      *os << "size ";
      size_matcher_.DescribeTo(os);
    }
Abseil Team's avatar
Abseil Team committed
2241
    void DescribeNegationTo(::std::ostream* os) const override {
zhanyong.wan's avatar
zhanyong.wan committed
2242
2243
2244
2245
      *os << "size ";
      size_matcher_.DescribeNegationTo(os);
    }

Abseil Team's avatar
Abseil Team committed
2246
2247
    bool MatchAndExplain(Container container,
                         MatchResultListener* listener) const override {
zhanyong.wan's avatar
zhanyong.wan committed
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
      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);
};

2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
// 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
2277
    return Matcher<Container>(new Impl<const Container&>(distance_matcher_));
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
  }

  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
2291
    void DescribeTo(::std::ostream* os) const override {
2292
2293
2294
      *os << "distance between begin() and end() ";
      distance_matcher_.DescribeTo(os);
    }
Abseil Team's avatar
Abseil Team committed
2295
    void DescribeNegationTo(::std::ostream* os) const override {
2296
2297
2298
2299
      *os << "distance between begin() and end() ";
      distance_matcher_.DescribeNegationTo(os);
    }

Abseil Team's avatar
Abseil Team committed
2300
2301
    bool MatchAndExplain(Container container,
                         MatchResultListener* listener) const override {
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
      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
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
// 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:
2337
2338
2339
2340
  typedef internal::StlContainerView<Container> View;
  typedef typename View::type StlContainer;
  typedef typename View::const_reference StlContainerReference;

kuzkry's avatar
kuzkry committed
2341
2342
2343
2344
2345
  static_assert(!std::is_const<Container>::value,
                "Container type must not be const");
  static_assert(!std::is_reference<Container>::value,
                "Container type must not be a reference");

2346
  // We make a copy of expected in case the elements in it are modified
2347
  // after this matcher is created.
2348
  explicit ContainerEqMatcher(const Container& expected)
kuzkry's avatar
kuzkry committed
2349
      : expected_(View::Copy(expected)) {}
2350

zhanyong.wan's avatar
zhanyong.wan committed
2351
2352
  void DescribeTo(::std::ostream* os) const {
    *os << "equals ";
2353
    UniversalPrint(expected_, os);
zhanyong.wan's avatar
zhanyong.wan committed
2354
2355
2356
  }
  void DescribeNegationTo(::std::ostream* os) const {
    *os << "does not equal ";
2357
    UniversalPrint(expected_, os);
zhanyong.wan's avatar
zhanyong.wan committed
2358
2359
  }

2360
  template <typename LhsContainer>
2361
2362
  bool MatchAndExplain(const LhsContainer& lhs,
                       MatchResultListener* listener) const {
2363
2364
    typedef internal::StlContainerView<
        typename std::remove_const<LhsContainer>::type>
2365
2366
2367
        LhsView;
    typedef typename LhsView::type LhsStlContainer;
    StlContainerReference lhs_stl_container = LhsView::ConstReference(lhs);
2368
    if (lhs_stl_container == expected_)
2369
      return true;
2370

2371
    ::std::ostream* const os = listener->stream();
2372
    if (os != nullptr) {
2373
      // Something is different. Check for extra values first.
2374
2375
2376
2377
      bool printed_header = false;
      for (typename LhsStlContainer::const_iterator it =
               lhs_stl_container.begin();
           it != lhs_stl_container.end(); ++it) {
2378
2379
        if (internal::ArrayAwareFind(expected_.begin(), expected_.end(), *it) ==
            expected_.end()) {
2380
2381
2382
          if (printed_header) {
            *os << ", ";
          } else {
2383
            *os << "which has these unexpected elements: ";
2384
2385
            printed_header = true;
          }
vladlosev's avatar
vladlosev committed
2386
          UniversalPrint(*it, os);
zhanyong.wan's avatar
zhanyong.wan committed
2387
2388
2389
        }
      }

2390
      // Now check for missing values.
2391
      bool printed_header2 = false;
2392
2393
      for (typename StlContainer::const_iterator it = expected_.begin();
           it != expected_.end(); ++it) {
2394
2395
2396
2397
2398
2399
        if (internal::ArrayAwareFind(
                lhs_stl_container.begin(), lhs_stl_container.end(), *it) ==
            lhs_stl_container.end()) {
          if (printed_header2) {
            *os << ", ";
          } else {
2400
2401
            *os << (printed_header ? ",\nand" : "which")
                << " doesn't have these expected elements: ";
2402
2403
            printed_header2 = true;
          }
vladlosev's avatar
vladlosev committed
2404
          UniversalPrint(*it, os);
zhanyong.wan's avatar
zhanyong.wan committed
2405
2406
2407
        }
      }
    }
2408
2409

    return false;
zhanyong.wan's avatar
zhanyong.wan committed
2410
  }
2411

zhanyong.wan's avatar
zhanyong.wan committed
2412
 private:
2413
  const StlContainer expected_;
2414
2415

  GTEST_DISALLOW_ASSIGN_(ContainerEqMatcher);
zhanyong.wan's avatar
zhanyong.wan committed
2416
2417
};

2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
// 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;
2444
2445
2446
2447
    // 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;
2448
2449
2450
2451

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

Abseil Team's avatar
Abseil Team committed
2452
    void DescribeTo(::std::ostream* os) const override {
2453
2454
2455
2456
      *os << "(when sorted) ";
      matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
2457
    void DescribeNegationTo(::std::ostream* os) const override {
2458
2459
2460
2461
      *os << "(when sorted) ";
      matcher_.DescribeNegationTo(os);
    }

Abseil Team's avatar
Abseil Team committed
2462
2463
    bool MatchAndExplain(LhsContainer lhs,
                         MatchResultListener* listener) const override {
2464
      LhsStlContainerReference lhs_stl_container = LhsView::ConstReference(lhs);
2465
2466
2467
2468
      ::std::vector<LhsValue> sorted_container(lhs_stl_container.begin(),
                                               lhs_stl_container.end());
      ::std::sort(
           sorted_container.begin(), sorted_container.end(), comparator_);
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488

      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_;
2489
    const Matcher<const ::std::vector<LhsValue>&> matcher_;
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500

    GTEST_DISALLOW_COPY_AND_ASSIGN_(Impl);
  };

 private:
  const Comparator comparator_;
  const ContainerMatcher matcher_;

  GTEST_DISALLOW_ASSIGN_(WhenSortedByMatcher);
};

zhanyong.wan's avatar
zhanyong.wan committed
2501
// Implements Pointwise(tuple_matcher, rhs_container).  tuple_matcher
Abseil Team's avatar
Abseil Team committed
2502
// must be able to be safely cast to Matcher<std::tuple<const T1&, const
zhanyong.wan's avatar
zhanyong.wan committed
2503
2504
2505
2506
// 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
2507
2508
2509
2510
  GTEST_COMPILE_ASSERT_(
      !IsHashTable<GTEST_REMOVE_REFERENCE_AND_CONST_(RhsContainer)>::value,
      use_UnorderedPointwise_with_hash_tables);

zhanyong.wan's avatar
zhanyong.wan committed
2511
2512
2513
2514
2515
 public:
  typedef internal::StlContainerView<RhsContainer> RhsView;
  typedef typename RhsView::type RhsStlContainer;
  typedef typename RhsStlContainer::value_type RhsValue;

kuzkry's avatar
kuzkry committed
2516
2517
2518
2519
2520
  static_assert(!std::is_const<RhsContainer>::value,
                "RhsContainer type must not be const");
  static_assert(!std::is_reference<RhsContainer>::value,
                "RhsContainer type must not be a reference");

zhanyong.wan's avatar
zhanyong.wan committed
2521
2522
2523
  // 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)
kuzkry's avatar
kuzkry committed
2524
      : tuple_matcher_(tuple_matcher), rhs_(RhsView::Copy(rhs)) {}
zhanyong.wan's avatar
zhanyong.wan committed
2525
2526
2527

  template <typename LhsContainer>
  operator Matcher<LhsContainer>() const {
Gennadiy Civil's avatar
Gennadiy Civil committed
2528
2529
2530
2531
    GTEST_COMPILE_ASSERT_(
        !IsHashTable<GTEST_REMOVE_REFERENCE_AND_CONST_(LhsContainer)>::value,
        use_UnorderedPointwise_with_hash_tables);

Abseil Team's avatar
Abseil Team committed
2532
2533
    return Matcher<LhsContainer>(
        new Impl<const LhsContainer&>(tuple_matcher_, rhs_));
zhanyong.wan's avatar
zhanyong.wan committed
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
  }

  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
2548
    typedef ::std::tuple<const LhsValue&, const RhsValue&> InnerMatcherArg;
zhanyong.wan's avatar
zhanyong.wan committed
2549
2550
2551
2552
2553
2554

    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
2555
    void DescribeTo(::std::ostream* os) const override {
zhanyong.wan's avatar
zhanyong.wan committed
2556
2557
2558
2559
2560
2561
      *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
2562
    void DescribeNegationTo(::std::ostream* os) const override {
zhanyong.wan's avatar
zhanyong.wan committed
2563
2564
2565
2566
2567
2568
2569
2570
      *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
2571
2572
    bool MatchAndExplain(LhsContainer lhs,
                         MatchResultListener* listener) const override {
zhanyong.wan's avatar
zhanyong.wan committed
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
      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
2585
2586
2587
          // 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
2588
          if (!mono_tuple_matcher_.MatchAndExplain(
Gennadiy Civil's avatar
Gennadiy Civil committed
2589
2590
2591
                  InnerMatcherArg(ImplicitCast_<const LhsValue&>(*left),
                                  ImplicitCast_<const RhsValue&>(*right)),
                  &inner_listener)) {
zhanyong.wan's avatar
zhanyong.wan committed
2592
2593
2594
2595
2596
2597
2598
2599
2600
            *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
2601
2602
2603
          if (!mono_tuple_matcher_.Matches(
                  InnerMatcherArg(ImplicitCast_<const LhsValue&>(*left),
                                  ImplicitCast_<const RhsValue&>(*right))))
zhanyong.wan's avatar
zhanyong.wan committed
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
            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);
};

2625
// Holds the logic common to ContainsMatcherImpl and EachMatcherImpl.
2626
template <typename Container>
2627
class QuantifierMatcherImpl : public MatcherInterface<Container> {
2628
 public:
zhanyong.wan's avatar
zhanyong.wan committed
2629
  typedef GTEST_REMOVE_REFERENCE_AND_CONST_(Container) RawContainer;
2630
2631
2632
2633
2634
2635
  typedef StlContainerView<RawContainer> View;
  typedef typename View::type StlContainer;
  typedef typename View::const_reference StlContainerReference;
  typedef typename StlContainer::value_type Element;

  template <typename InnerMatcher>
2636
  explicit QuantifierMatcherImpl(InnerMatcher inner_matcher)
2637
      : inner_matcher_(
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
           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) {}
2677
2678

  // Describes what this matcher does.
Abseil Team's avatar
Abseil Team committed
2679
  void DescribeTo(::std::ostream* os) const override {
2680
    *os << "contains at least one element that ";
2681
    this->inner_matcher_.DescribeTo(os);
2682
2683
  }

Abseil Team's avatar
Abseil Team committed
2684
  void DescribeNegationTo(::std::ostream* os) const override {
2685
    *os << "doesn't contain any element that ";
2686
    this->inner_matcher_.DescribeTo(os);
2687
2688
  }

Abseil Team's avatar
Abseil Team committed
2689
2690
  bool MatchAndExplain(Container container,
                       MatchResultListener* listener) const override {
2691
    return this->MatchAndExplainImpl(false, container, listener);
2692
2693
2694
  }

 private:
2695
  GTEST_DISALLOW_ASSIGN_(ContainsMatcherImpl);
2696
2697
};

2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
// 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
2708
  void DescribeTo(::std::ostream* os) const override {
2709
2710
2711
2712
    *os << "only contains elements that ";
    this->inner_matcher_.DescribeTo(os);
  }

Abseil Team's avatar
Abseil Team committed
2713
  void DescribeNegationTo(::std::ostream* os) const override {
2714
2715
2716
2717
    *os << "contains some element that ";
    this->inner_matcher_.DescribeNegationTo(os);
  }

Abseil Team's avatar
Abseil Team committed
2718
2719
  bool MatchAndExplain(Container container,
                       MatchResultListener* listener) const override {
2720
2721
2722
2723
2724
2725
2726
    return this->MatchAndExplainImpl(true, container, listener);
  }

 private:
  GTEST_DISALLOW_ASSIGN_(EachMatcherImpl);
};

2727
2728
2729
2730
2731
2732
2733
2734
// 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
2735
2736
    return Matcher<Container>(
        new ContainsMatcherImpl<const Container&>(inner_matcher_));
2737
2738
2739
2740
  }

 private:
  const M inner_matcher_;
2741
2742

  GTEST_DISALLOW_ASSIGN_(ContainsMatcher);
2743
2744
};

2745
2746
2747
2748
2749
2750
2751
2752
// 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
2753
2754
    return Matcher<Container>(
        new EachMatcherImpl<const Container&>(inner_matcher_));
2755
2756
2757
2758
2759
2760
2761
2762
  }

 private:
  const M inner_matcher_;

  GTEST_DISALLOW_ASSIGN_(EachMatcher);
};

Gennadiy Civil's avatar
 
Gennadiy Civil committed
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
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

2787
2788
2789
2790
2791
2792
2793
// 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
2794
  typedef GTEST_REMOVE_REFERENCE_AND_CONST_(PairType) RawPairType;
2795
2796
2797
2798
2799
2800
2801
2802
  typedef typename RawPairType::first_type KeyType;

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

2803
2804
  // Returns true if and only if 'key_value.first' (the key) matches the inner
  // matcher.
Abseil Team's avatar
Abseil Team committed
2805
2806
  bool MatchAndExplain(PairType key_value,
                       MatchResultListener* listener) const override {
2807
    StringMatchResultListener inner_listener;
Gennadiy Civil's avatar
Gennadiy Civil committed
2808
2809
    const bool match = inner_matcher_.MatchAndExplain(
        pair_getters::First(key_value, Rank0()), &inner_listener);
2810
    const std::string explanation = inner_listener.str();
2811
2812
2813
2814
    if (explanation != "") {
      *listener << "whose first field is a value " << explanation;
    }
    return match;
2815
2816
2817
  }

  // Describes what this matcher does.
Abseil Team's avatar
Abseil Team committed
2818
  void DescribeTo(::std::ostream* os) const override {
2819
2820
2821
2822
2823
    *os << "has a key that ";
    inner_matcher_.DescribeTo(os);
  }

  // Describes what the negation of this matcher does.
Abseil Team's avatar
Abseil Team committed
2824
  void DescribeNegationTo(::std::ostream* os) const override {
2825
2826
2827
2828
2829
2830
    *os << "doesn't have a key that ";
    inner_matcher_.DescribeTo(os);
  }

 private:
  const Matcher<const KeyType&> inner_matcher_;
2831
2832

  GTEST_DISALLOW_ASSIGN_(KeyMatcherImpl);
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
};

// 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 {
Abseil Team's avatar
Abseil Team committed
2843
2844
    return Matcher<PairType>(
        new KeyMatcherImpl<const PairType&>(matcher_for_key_));
2845
2846
2847
2848
  }

 private:
  const M matcher_for_key_;
2849
2850

  GTEST_DISALLOW_ASSIGN_(KeyMatcher);
2851
2852
};

2853
2854
2855
2856
2857
// 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
2858
  typedef GTEST_REMOVE_REFERENCE_AND_CONST_(PairType) RawPairType;
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
  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
2871
  void DescribeTo(::std::ostream* os) const override {
2872
2873
2874
2875
2876
2877
2878
    *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
2879
  void DescribeNegationTo(::std::ostream* os) const override {
2880
2881
2882
2883
2884
2885
    *os << "has a first field that ";
    first_matcher_.DescribeNegationTo(os);
    *os << ", or has a second field that ";
    second_matcher_.DescribeNegationTo(os);
  }

2886
2887
  // Returns true if and only if 'a_pair.first' matches first_matcher and
  // 'a_pair.second' matches second_matcher.
Abseil Team's avatar
Abseil Team committed
2888
2889
  bool MatchAndExplain(PairType a_pair,
                       MatchResultListener* listener) const override {
2890
2891
2892
    if (!listener->IsInterested()) {
      // If the listener is not interested, we don't need to construct the
      // explanation.
Gennadiy Civil's avatar
Gennadiy Civil committed
2893
2894
      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
2895
    }
2896
    StringMatchResultListener first_inner_listener;
Gennadiy Civil's avatar
Gennadiy Civil committed
2897
    if (!first_matcher_.MatchAndExplain(pair_getters::First(a_pair, Rank0()),
2898
2899
                                        &first_inner_listener)) {
      *listener << "whose first field does not match";
2900
      PrintIfNotEmpty(first_inner_listener.str(), listener->stream());
zhanyong.wan's avatar
zhanyong.wan committed
2901
      return false;
2902
    }
2903
    StringMatchResultListener second_inner_listener;
Gennadiy Civil's avatar
Gennadiy Civil committed
2904
    if (!second_matcher_.MatchAndExplain(pair_getters::Second(a_pair, Rank0()),
2905
2906
                                         &second_inner_listener)) {
      *listener << "whose second field does not match";
2907
      PrintIfNotEmpty(second_inner_listener.str(), listener->stream());
zhanyong.wan's avatar
zhanyong.wan committed
2908
      return false;
2909
    }
2910
2911
    ExplainSuccess(first_inner_listener.str(), second_inner_listener.str(),
                   listener);
zhanyong.wan's avatar
zhanyong.wan committed
2912
    return true;
2913
2914
2915
  }

 private:
2916
2917
  void ExplainSuccess(const std::string& first_explanation,
                      const std::string& second_explanation,
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
                      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;
    }
  }

2934
2935
  const Matcher<const FirstType&> first_matcher_;
  const Matcher<const SecondType&> second_matcher_;
2936
2937

  GTEST_DISALLOW_ASSIGN_(PairMatcherImpl);
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
};

// 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 {
Abseil Team's avatar
Abseil Team committed
2949
2950
    return Matcher<PairType>(
        new PairMatcherImpl<const PairType&>(first_matcher_, second_matcher_));
2951
2952
2953
2954
2955
  }

 private:
  const FirstMatcher first_matcher_;
  const SecondMatcher second_matcher_;
2956
2957

  GTEST_DISALLOW_ASSIGN_(PairMatcher);
2958
2959
};

2960
2961
2962
2963
// Implements ElementsAre() and ElementsAreArray().
template <typename Container>
class ElementsAreMatcherImpl : public MatcherInterface<Container> {
 public:
zhanyong.wan's avatar
zhanyong.wan committed
2964
  typedef GTEST_REMOVE_REFERENCE_AND_CONST_(Container) RawContainer;
2965
2966
2967
2968
2969
2970
2971
2972
  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>
2973
2974
2975
  ElementsAreMatcherImpl(InputIter first, InputIter last) {
    while (first != last) {
      matchers_.push_back(MatcherCast<const Element&>(*first++));
2976
2977
2978
2979
    }
  }

  // Describes what this matcher does.
Abseil Team's avatar
Abseil Team committed
2980
  void DescribeTo(::std::ostream* os) const override {
2981
2982
2983
2984
2985
2986
2987
2988
    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) {
2989
        *os << "element #" << i << " ";
2990
2991
2992
2993
2994
2995
2996
2997
2998
        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
2999
  void DescribeNegationTo(::std::ostream* os) const override {
3000
    if (count() == 0) {
3001
      *os << "isn't empty";
3002
3003
3004
      return;
    }

3005
    *os << "doesn't have " << Elements(count()) << ", or\n";
3006
    for (size_t i = 0; i != count(); ++i) {
3007
      *os << "element #" << i << " ";
3008
3009
3010
3011
3012
3013
3014
      matchers_[i].DescribeNegationTo(os);
      if (i + 1 < count()) {
        *os << ", or\n";
      }
    }
  }

Abseil Team's avatar
Abseil Team committed
3015
3016
  bool MatchAndExplain(Container container,
                       MatchResultListener* listener) const override {
3017
3018
3019
3020
3021
3022
    // 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.
3023
    ::std::vector<std::string> explanations(count());
3024
    StlContainerReference stl_container = View::ConstReference(container);
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
    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
3057
3058
3059
3060
3061
    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.
3062
      if (listener_interested && (actual_count != 0)) {
3063
        *listener << "which has " << Elements(actual_count);
3064
      }
zhanyong.wan's avatar
zhanyong.wan committed
3065
3066
      return false;
    }
3067

3068
3069
3070
3071
3072
    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
3073
      }
3074
      return false;
zhanyong.wan's avatar
zhanyong.wan committed
3075
    }
3076

zhanyong.wan's avatar
zhanyong.wan committed
3077
3078
    // Every element matches its expectation.  We need to explain why
    // (the obvious ones can be skipped).
3079
3080
3081
    if (listener_interested) {
      bool reason_printed = false;
      for (size_t i = 0; i != count(); ++i) {
3082
        const std::string& s = explanations[i];
3083
3084
3085
3086
3087
3088
        if (!s.empty()) {
          if (reason_printed) {
            *listener << ",\nand ";
          }
          *listener << "whose element #" << i << " matches, " << s;
          reason_printed = true;
3089
3090
3091
        }
      }
    }
zhanyong.wan's avatar
zhanyong.wan committed
3092
    return true;
3093
3094
3095
3096
3097
3098
3099
3100
  }

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

  size_t count() const { return matchers_.size(); }
3101
3102

  ::std::vector<Matcher<const Element&> > matchers_;
3103
3104

  GTEST_DISALLOW_ASSIGN_(ElementsAreMatcherImpl);
3105
3106
};

3107
3108
3109
3110
3111
// 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 {
3112
 public:
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
  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();

3135
  std::string DebugString() const;
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158

 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
3159
3160
3161
3162
3163
3164
3165
struct UnorderedMatcherRequire {
  enum Flags {
    Superset = 1 << 0,
    Subset = 1 << 1,
    ExactMatch = Superset | Subset,
  };
};
3166
3167
3168
3169
3170
3171

// 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
3172
3173
3174
3175
  explicit UnorderedElementsAreMatcherImplBase(
      UnorderedMatcherRequire::Flags matcher_flags)
      : match_flags_(matcher_flags) {}

3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
  // 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
3187
3188
3189
3190
3191
3192
  bool VerifyMatchMatrix(const ::std::vector<std::string>& element_printouts,
                         const MatchMatrix& matrix,
                         MatchResultListener* listener) const;

  bool FindPairing(const MatchMatrix& matrix,
                   MatchResultListener* listener) const;
3193
3194
3195
3196
3197
3198
3199
3200
3201

  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
3202
3203
  UnorderedMatcherRequire::Flags match_flags() const { return match_flags_; }

3204
 private:
Gennadiy Civil's avatar
Gennadiy Civil committed
3205
  UnorderedMatcherRequire::Flags match_flags_;
3206
3207
3208
3209
3210
  MatcherDescriberVec matcher_describers_;

  GTEST_DISALLOW_ASSIGN_(UnorderedElementsAreMatcherImplBase);
};

Gennadiy Civil's avatar
Gennadiy Civil committed
3211
3212
// Implements UnorderedElementsAre, UnorderedElementsAreArray, IsSubsetOf, and
// IsSupersetOf.
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
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
3226
3227
3228
  UnorderedElementsAreMatcherImpl(UnorderedMatcherRequire::Flags matcher_flags,
                                  InputIter first, InputIter last)
      : UnorderedElementsAreMatcherImplBase(matcher_flags) {
3229
3230
3231
3232
3233
3234
3235
    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
3236
  void DescribeTo(::std::ostream* os) const override {
3237
3238
3239
3240
    return UnorderedElementsAreMatcherImplBase::DescribeToImpl(os);
  }

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

Abseil Team's avatar
Abseil Team committed
3245
3246
  bool MatchAndExplain(Container container,
                       MatchResultListener* listener) const override {
3247
    StlContainerReference stl_container = View::ConstReference(container);
3248
    ::std::vector<std::string> element_printouts;
Gennadiy Civil's avatar
Gennadiy Civil committed
3249
3250
3251
    MatchMatrix matrix =
        AnalyzeElements(stl_container.begin(), stl_container.end(),
                        &element_printouts, listener);
3252

Gennadiy Civil's avatar
Gennadiy Civil committed
3253
    if (matrix.LhsSize() == 0 && matrix.RhsSize() == 0) {
3254
3255
      return true;
    }
Gennadiy Civil's avatar
Gennadiy Civil committed
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266

    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;
3267
3268
3269
      }
    }

Gennadiy Civil's avatar
Gennadiy Civil committed
3270
    return VerifyMatchMatrix(element_printouts, matrix, listener) &&
3271
3272
3273
3274
3275
3276
           FindPairing(matrix, listener);
  }

 private:
  template <typename ElementIter>
  MatchMatrix AnalyzeElements(ElementIter elem_first, ElementIter elem_last,
3277
                              ::std::vector<std::string>* element_printouts,
3278
                              MatchResultListener* listener) const {
3279
    element_printouts->clear();
3280
3281
    ::std::vector<char> did_match;
    size_t num_elements = 0;
Abseil Team's avatar
Abseil Team committed
3282
    DummyMatchResultListener dummy;
3283
3284
3285
3286
3287
    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) {
Abseil Team's avatar
Abseil Team committed
3288
3289
        did_match.push_back(
            matchers_[irhs].MatchAndExplain(*elem_first, &dummy));
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
      }
    }

    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
3303
  ::std::vector<Matcher<const Element&> > matchers_;
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331

  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
3332
    matchers.reserve(::std::tuple_size<MatcherTuple>::value);
3333
3334
    TransformTupleValues(CastAndAppendTransform<const Element&>(), matchers_,
                         ::std::back_inserter(matchers));
Abseil Team's avatar
Abseil Team committed
3335
3336
3337
3338
    return Matcher<Container>(
        new UnorderedElementsAreMatcherImpl<const Container&>(
            UnorderedMatcherRequire::ExactMatch, matchers.begin(),
            matchers.end()));
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
  }

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

// Implements ElementsAre.
template <typename MatcherTuple>
class ElementsAreMatcher {
 public:
  explicit ElementsAreMatcher(const MatcherTuple& args) : matchers_(args) {}
3351
3352
3353

  template <typename Container>
  operator Matcher<Container>() const {
Gennadiy Civil's avatar
Gennadiy Civil committed
3354
3355
    GTEST_COMPILE_ASSERT_(
        !IsHashTable<GTEST_REMOVE_REFERENCE_AND_CONST_(Container)>::value ||
Abseil Team's avatar
Abseil Team committed
3356
            ::std::tuple_size<MatcherTuple>::value < 2,
Gennadiy Civil's avatar
Gennadiy Civil committed
3357
3358
        use_UnorderedElementsAre_with_hash_tables);

zhanyong.wan's avatar
zhanyong.wan committed
3359
    typedef GTEST_REMOVE_REFERENCE_AND_CONST_(Container) RawContainer;
3360
3361
3362
3363
    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
3364
    matchers.reserve(::std::tuple_size<MatcherTuple>::value);
3365
3366
    TransformTupleValues(CastAndAppendTransform<const Element&>(), matchers_,
                         ::std::back_inserter(matchers));
Abseil Team's avatar
Abseil Team committed
3367
3368
    return Matcher<Container>(new ElementsAreMatcherImpl<const Container&>(
        matchers.begin(), matchers.end()));
3369
3370
3371
3372
3373
3374
  }

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

Gennadiy Civil's avatar
Gennadiy Civil committed
3376
// Implements UnorderedElementsAreArray(), IsSubsetOf(), and IsSupersetOf().
3377
3378
3379
3380
template <typename T>
class UnorderedElementsAreArrayMatcher {
 public:
  template <typename Iter>
Gennadiy Civil's avatar
Gennadiy Civil committed
3381
3382
3383
  UnorderedElementsAreArrayMatcher(UnorderedMatcherRequire::Flags match_flags,
                                   Iter first, Iter last)
      : match_flags_(match_flags), matchers_(first, last) {}
3384
3385
3386

  template <typename Container>
  operator Matcher<Container>() const {
Abseil Team's avatar
Abseil Team committed
3387
3388
3389
    return Matcher<Container>(
        new UnorderedElementsAreMatcherImpl<const Container&>(
            match_flags_, matchers_.begin(), matchers_.end()));
3390
  }
3391
3392

 private:
Gennadiy Civil's avatar
Gennadiy Civil committed
3393
  UnorderedMatcherRequire::Flags match_flags_;
3394
3395
3396
  ::std::vector<T> matchers_;

  GTEST_DISALLOW_ASSIGN_(UnorderedElementsAreArrayMatcher);
3397
3398
3399
3400
3401
3402
};

// Implements ElementsAreArray().
template <typename T>
class ElementsAreArrayMatcher {
 public:
3403
3404
  template <typename Iter>
  ElementsAreArrayMatcher(Iter first, Iter last) : matchers_(first, last) {}
3405
3406
3407

  template <typename Container>
  operator Matcher<Container>() const {
Gennadiy Civil's avatar
Gennadiy Civil committed
3408
3409
3410
3411
    GTEST_COMPILE_ASSERT_(
        !IsHashTable<GTEST_REMOVE_REFERENCE_AND_CONST_(Container)>::value,
        use_UnorderedElementsAreArray_with_hash_tables);

Abseil Team's avatar
Abseil Team committed
3412
    return Matcher<Container>(new ElementsAreMatcherImpl<const Container&>(
3413
        matchers_.begin(), matchers_.end()));
3414
3415
3416
  }

 private:
3417
  const ::std::vector<T> matchers_;
3418
3419

  GTEST_DISALLOW_ASSIGN_(ElementsAreArrayMatcher);
3420
3421
};

3422
3423
// Given a 2-tuple matcher tm of type Tuple2Matcher and a value second
// of type Second, BoundSecondMatcher<Tuple2Matcher, Second>(tm,
3424
3425
// second) is a polymorphic matcher that matches a value x if and only if
// tm matches tuple (x, second).  Useful for implementing
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
// 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) {}

Abseil Team's avatar
Abseil Team committed
3437
3438
  BoundSecondMatcher(const BoundSecondMatcher& other) = default;

3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
  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
3460
    typedef ::std::tuple<T, Second> ArgTuple;
3461
3462
3463
3464
3465

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

Abseil Team's avatar
Abseil Team committed
3466
    void DescribeTo(::std::ostream* os) const override {
3467
3468
3469
3470
3471
3472
      *os << "and ";
      UniversalPrint(second_value_, os);
      *os << " ";
      mono_tuple2_matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
3473
    bool MatchAndExplain(T x, MatchResultListener* listener) const override {
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
      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
3491
3492
// value x if and only if tm matches tuple (x, second).  Useful for
// implementing UnorderedPointwise() in terms of UnorderedElementsAreArray().
3493
3494
3495
3496
3497
3498
template <typename Tuple2Matcher, typename Second>
BoundSecondMatcher<Tuple2Matcher, Second> MatcherBindSecond(
    const Tuple2Matcher& tm, const Second& second) {
  return BoundSecondMatcher<Tuple2Matcher, Second>(tm, second);
}

3499
3500
3501
3502
3503
// 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.
3504
3505
3506
GTEST_API_ std::string FormatMatcherDescription(bool negation,
                                                const char* matcher_name,
                                                const Strings& param_values);
3507

Gennadiy Civil's avatar
Gennadiy Civil committed
3508
3509
3510
3511
3512
3513
3514
3515
3516
// 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 {
Abseil Team's avatar
Abseil Team committed
3517
    return Matcher<Optional>(new Impl<const Optional&>(value_matcher_));
Gennadiy Civil's avatar
Gennadiy Civil committed
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
  }

  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
3528
    void DescribeTo(::std::ostream* os) const override {
Gennadiy Civil's avatar
Gennadiy Civil committed
3529
3530
3531
3532
      *os << "value ";
      value_matcher_.DescribeTo(os);
    }

Abseil Team's avatar
Abseil Team committed
3533
    void DescribeNegationTo(::std::ostream* os) const override {
Gennadiy Civil's avatar
Gennadiy Civil committed
3534
3535
3536
3537
      *os << "value ";
      value_matcher_.DescribeNegationTo(os);
    }

Abseil Team's avatar
Abseil Team committed
3538
3539
    bool MatchAndExplain(Optional optional,
                         MatchResultListener* listener) const override {
Gennadiy Civil's avatar
Gennadiy Civil committed
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
      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
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
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
3575
      : matcher_(std::move(matcher)) {}
Xiaoyi Zhang's avatar
Xiaoyi Zhang committed
3576
3577
3578
3579

  template <typename Variant>
  bool MatchAndExplain(const Variant& value,
                       ::testing::MatchResultListener* listener) const {
Abseil Team's avatar
Abseil Team committed
3580
    using std::get;
Xiaoyi Zhang's avatar
Xiaoyi Zhang committed
3581
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
3608
3609
3610
3611
    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
3612
  static std::string GetTypeName() {
Xiaoyi Zhang's avatar
Xiaoyi Zhang committed
3613
#if GTEST_HAS_RTTI
Gennadiy Civil's avatar
 
Gennadiy Civil committed
3614
3615
    GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(
        return internal::GetTypeName<T>());
Xiaoyi Zhang's avatar
Xiaoyi Zhang committed
3616
3617
3618
3619
3620
3621
3622
3623
3624
#endif
    return "the element type";
  }

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

}  // namespace variant_matcher

Gennadiy Civil's avatar
 
Gennadiy Civil committed
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
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);
3643
      return ptr != nullptr && matcher_.Matches(*ptr);
Gennadiy Civil's avatar
 
Gennadiy Civil committed
3644
3645
3646
    }

    const T* elem = any_cast<T>(&value);
3647
    if (elem == nullptr) {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
      *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
3675
3676
    GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(
        return internal::GetTypeName<T>());
Gennadiy Civil's avatar
 
Gennadiy Civil committed
3677
3678
3679
3680
3681
3682
3683
3684
#endif
    return "the element type";
  }

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

}  // namespace any_cast_matcher
Abseil Team's avatar
Abseil Team committed
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758

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

3759
3760
}  // namespace internal

Gennadiy Civil's avatar
Gennadiy Civil committed
3761
// ElementsAreArray(iterator_first, iterator_last)
3762
3763
// ElementsAreArray(pointer, count)
// ElementsAreArray(array)
3764
// ElementsAreArray(container)
3765
// ElementsAreArray({ e1, e2, ..., en })
3766
//
3767
3768
3769
3770
3771
3772
// 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.
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
//
// 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);
}

3796
3797
3798
3799
template <typename Container>
inline internal::ElementsAreArrayMatcher<typename Container::value_type>
ElementsAreArray(const Container& container) {
  return ElementsAreArray(container.begin(), container.end());
3800
3801
}

3802
3803
3804
3805
3806
3807
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
3808
// UnorderedElementsAreArray(iterator_first, iterator_last)
3809
3810
// UnorderedElementsAreArray(pointer, count)
// UnorderedElementsAreArray(array)
3811
// UnorderedElementsAreArray(container)
3812
// UnorderedElementsAreArray({ e1, e2, ..., en })
3813
//
Gennadiy Civil's avatar
Gennadiy Civil committed
3814
3815
3816
3817
3818
3819
3820
// 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.

3821
3822
3823
3824
3825
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
3826
3827
  return internal::UnorderedElementsAreArrayMatcher<T>(
      internal::UnorderedMatcherRequire::ExactMatch, first, last);
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
}

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

3842
3843
3844
3845
3846
template <typename Container>
inline internal::UnorderedElementsAreArrayMatcher<
    typename Container::value_type>
UnorderedElementsAreArray(const Container& container) {
  return UnorderedElementsAreArray(container.begin(), container.end());
3847
3848
}

3849
3850
3851
3852
3853
template <typename T>
inline internal::UnorderedElementsAreArrayMatcher<T>
UnorderedElementsAreArray(::std::initializer_list<T> xs) {
  return UnorderedElementsAreArray(xs.begin(), xs.end());
}
3854

3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
// _ 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
3867
3868
3869
inline Matcher<T> A() {
  return Matcher<T>(new internal::AnyMatcherImpl<T>());
}
3870
3871
3872
3873
3874

// 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
3875
3876
template <typename T, typename M>
Matcher<T> internal::MatcherCastImpl<T, M>::CastImpl(
3877
3878
    const M& value, std::false_type /* convertible_to_matcher */,
    std::false_type /* convertible_to_T */) {
Gennadiy Civil's avatar
 
Gennadiy Civil committed
3879
3880
3881
  return Eq(value);
}

zhanyong.wan's avatar
zhanyong.wan committed
3882
3883
3884
3885
3886
// Creates a polymorphic matcher that matches any NULL pointer.
inline PolymorphicMatcher<internal::IsNullMatcher > IsNull() {
  return MakePolymorphicMatcher(internal::IsNullMatcher());
}

3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
// 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);
}

Abseil Team's avatar
Abseil Team committed
3901
3902
3903
3904
3905
// Creates a polymorphic matcher that matches any NaN floating point.
inline PolymorphicMatcher<internal::IsNanMatcher> IsNan() {
  return MakePolymorphicMatcher(internal::IsNanMatcher());
}

3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
// 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);
}

3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
// 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);
}

3934
3935
3936
3937
3938
3939
// 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);
}

3940
// Creates a matcher that matches any float argument approximately
3941
3942
3943
3944
3945
// equal to rhs, including NaN values when rhs is NaN.
inline internal::FloatingEqMatcher<float> NanSensitiveFloatEq(float rhs) {
  return internal::FloatingEqMatcher<float>(rhs, true);
}

3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
// 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);
}

3962
3963
3964
3965
3966
3967
3968
3969
// 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);
}

3970
#if GTEST_HAS_RTTI
billydonahue's avatar
billydonahue committed
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
// 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));
}
3983
#endif  // GTEST_HAS_RTTI
billydonahue's avatar
billydonahue committed
3984

3985
3986
3987
// Creates a matcher that matches an object whose given field matches
// 'matcher'.  For example,
//   Field(&Foo::number, Ge(5))
3988
// matches a Foo object x if and only if x.number >= 5.
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
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
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
// 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)));
}

4012
4013
4014
// Creates a matcher that matches an object whose given property
// matches 'matcher'.  For example,
//   Property(&Foo::str, StartsWith("hi"))
4015
// matches a Foo object x if and only if x.str() starts with "hi".
4016
template <typename Class, typename PropertyType, typename PropertyMatcher>
4017
4018
4019
4020
inline PolymorphicMatcher<internal::PropertyMatcher<
    Class, PropertyType, PropertyType (Class::*)() const> >
Property(PropertyType (Class::*property)() const,
         const PropertyMatcher& matcher) {
4021
  return MakePolymorphicMatcher(
4022
4023
      internal::PropertyMatcher<Class, PropertyType,
                                PropertyType (Class::*)() const>(
Abseil Team's avatar
Abseil Team committed
4024
          property, MatcherCast<const PropertyType&>(matcher)));
4025
4026
4027
4028
4029
4030
  // 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
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
// 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
4042
          property_name, property, MatcherCast<const PropertyType&>(matcher)));
Gennadiy Civil's avatar
Gennadiy Civil committed
4043
4044
}

4045
4046
4047
4048
4049
4050
4051
4052
// 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
4053
4054
                                PropertyType (Class::*)() const&>(
          property, MatcherCast<const PropertyType&>(matcher)));
4055
}
Gennadiy Civil's avatar
 
Gennadiy Civil committed
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065

// 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
4066
4067
                                PropertyType (Class::*)() const&>(
          property_name, property, MatcherCast<const PropertyType&>(matcher)));
Gennadiy Civil's avatar
 
Gennadiy Civil committed
4068
}
4069

4070
4071
// Creates a matcher that matches an object if and only if the result of
// applying a callable to x matches 'matcher'. For example,
4072
//   ResultOf(f, StartsWith("hi"))
4073
// matches a Foo object x if and only if f(x) starts with "hi".
4074
4075
4076
4077
4078
4079
4080
4081
// `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
4082
      std::move(callable), std::move(matcher));
4083
4084
4085
4086
4087
}

// String matchers.

// Matches a string equal to str.
4088
4089
4090
4091
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::string> > StrEq(
    const std::string& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::string>(str, true, true));
4092
4093
4094
}

// Matches a string not equal to str.
4095
4096
4097
4098
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::string> > StrNe(
    const std::string& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::string>(str, false, true));
4099
4100
4101
}

// Matches a string equal to str, ignoring case.
4102
4103
4104
4105
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::string> > StrCaseEq(
    const std::string& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::string>(str, true, false));
4106
4107
4108
}

// Matches a string not equal to str, ignoring case.
4109
4110
4111
4112
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::string> > StrCaseNe(
    const std::string& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::string>(str, false, false));
4113
4114
4115
4116
}

// Creates a matcher that matches any string, std::string, or C string
// that contains the given substring.
4117
4118
4119
4120
inline PolymorphicMatcher<internal::HasSubstrMatcher<std::string> > HasSubstr(
    const std::string& substring) {
  return MakePolymorphicMatcher(
      internal::HasSubstrMatcher<std::string>(substring));
4121
4122
4123
}

// Matches a string that starts with 'prefix' (case-sensitive).
4124
4125
4126
4127
inline PolymorphicMatcher<internal::StartsWithMatcher<std::string> > StartsWith(
    const std::string& prefix) {
  return MakePolymorphicMatcher(
      internal::StartsWithMatcher<std::string>(prefix));
4128
4129
4130
}

// Matches a string that ends with 'suffix' (case-sensitive).
4131
4132
4133
inline PolymorphicMatcher<internal::EndsWithMatcher<std::string> > EndsWith(
    const std::string& suffix) {
  return MakePolymorphicMatcher(internal::EndsWithMatcher<std::string>(suffix));
4134
4135
}

Abseil Team's avatar
Abseil Team committed
4136
#if GTEST_HAS_STD_WSTRING
4137
4138
4139
// Wide string matchers.

// Matches a string equal to str.
Gennadiy Civil's avatar
Gennadiy Civil committed
4140
4141
4142
4143
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::wstring> > StrEq(
    const std::wstring& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::wstring>(str, true, true));
4144
4145
4146
}

// Matches a string not equal to str.
Gennadiy Civil's avatar
Gennadiy Civil committed
4147
4148
4149
4150
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::wstring> > StrNe(
    const std::wstring& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::wstring>(str, false, true));
4151
4152
4153
}

// Matches a string equal to str, ignoring case.
Gennadiy Civil's avatar
Gennadiy Civil committed
4154
4155
4156
4157
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::wstring> >
StrCaseEq(const std::wstring& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::wstring>(str, true, false));
4158
4159
4160
}

// Matches a string not equal to str, ignoring case.
Gennadiy Civil's avatar
Gennadiy Civil committed
4161
4162
4163
4164
inline PolymorphicMatcher<internal::StrEqualityMatcher<std::wstring> >
StrCaseNe(const std::wstring& str) {
  return MakePolymorphicMatcher(
      internal::StrEqualityMatcher<std::wstring>(str, false, false));
4165
4166
}

Gennadiy Civil's avatar
Gennadiy Civil committed
4167
// Creates a matcher that matches any ::wstring, std::wstring, or C wide string
4168
// that contains the given substring.
Gennadiy Civil's avatar
Gennadiy Civil committed
4169
4170
4171
4172
inline PolymorphicMatcher<internal::HasSubstrMatcher<std::wstring> > HasSubstr(
    const std::wstring& substring) {
  return MakePolymorphicMatcher(
      internal::HasSubstrMatcher<std::wstring>(substring));
4173
4174
4175
}

// Matches a string that starts with 'prefix' (case-sensitive).
Gennadiy Civil's avatar
Gennadiy Civil committed
4176
4177
4178
4179
inline PolymorphicMatcher<internal::StartsWithMatcher<std::wstring> >
StartsWith(const std::wstring& prefix) {
  return MakePolymorphicMatcher(
      internal::StartsWithMatcher<std::wstring>(prefix));
4180
4181
4182
}

// Matches a string that ends with 'suffix' (case-sensitive).
Gennadiy Civil's avatar
Gennadiy Civil committed
4183
4184
4185
4186
inline PolymorphicMatcher<internal::EndsWithMatcher<std::wstring> > EndsWith(
    const std::wstring& suffix) {
  return MakePolymorphicMatcher(
      internal::EndsWithMatcher<std::wstring>(suffix));
4187
4188
}

Abseil Team's avatar
Abseil Team committed
4189
#endif  // GTEST_HAS_STD_WSTRING
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

// 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
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
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
// 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);
}

4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
// 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
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
// 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);
}

4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
// 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
4306
4307
4308
4309
4310
// 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>
4311
4312
4313
inline PolymorphicMatcher<internal::ContainerEqMatcher<
    typename std::remove_const<Container>::type>>
ContainerEq(const Container& rhs) {
4314
  return MakePolymorphicMatcher(internal::ContainerEqMatcher<Container>(rhs));
4315
4316
}

4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
// 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
4337
4338
4339
// 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
4340
// TupleMatcher must be able to be safely cast to Matcher<std::tuple<const
zhanyong.wan's avatar
zhanyong.wan committed
4341
4342
4343
4344
// 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,
4345
                                  typename std::remove_const<Container>::type>
zhanyong.wan's avatar
zhanyong.wan committed
4346
Pointwise(const TupleMatcher& tuple_matcher, const Container& rhs) {
4347
4348
  return internal::PointwiseMatcher<TupleMatcher, Container>(tuple_matcher,
                                                             rhs);
zhanyong.wan's avatar
zhanyong.wan committed
4349
4350
}

4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364

// 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
4365
// cast to Matcher<std::tuple<const T1&, const T2&> >, where T1 and T2 are
4366
4367
4368
4369
4370
4371
4372
4373
// 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<
4374
4375
4376
        Tuple2Matcher,
        typename internal::StlContainerView<
            typename std::remove_const<RhsContainer>::type>::type::value_type>>
4377
4378
4379
4380
UnorderedPointwise(const Tuple2Matcher& tuple2_matcher,
                   const RhsContainer& rhs_container) {
  // RhsView allows the same code to handle RhsContainer being a
  // STL-style container and it being a native C-style array.
4381
  typedef typename internal::StlContainerView<RhsContainer> RhsView;
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
  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));
}


4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
// 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
4423
4424
//   EXPECT_THAT(page_lengths,
//               Contains(::std::pair<const int, size_t>(1, 100)));
4425
4426
4427
4428
4429
4430
//
//   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
4431
4432
}

Gennadiy Civil's avatar
Gennadiy Civil committed
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
// 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());
}

4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
// 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);
}

4583
4584
4585
4586
4587
4588
4589
4590
// 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);
}

4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
// 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);
}

4603
4604
4605
4606
4607
4608
4609
// 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);
}

4610
// Returns true if and only if the value matches the matcher.
4611
4612
4613
4614
4615
template <typename T, typename M>
inline bool Value(const T& value, M matcher) {
  return testing::Matches(matcher)(value);
}

4616
4617
4618
// Matches the value against the given matcher and explains the match
// result to listener.
template <typename T, typename M>
4619
inline bool ExplainMatchResult(
4620
4621
4622
4623
    M matcher, const T& value, MatchResultListener* listener) {
  return SafeMatcherCast<const T&>(matcher).MatchAndExplain(value, listener);
}

Gennadiy Civil's avatar
Gennadiy Civil committed
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
// 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
4646
template <typename... Args>
Abseil Team's avatar
Abseil Team committed
4647
4648
internal::ElementsAreMatcher<
    std::tuple<typename std::decay<const Args&>::type...>>
Gennadiy Civil's avatar
 
Gennadiy Civil committed
4649
4650
ElementsAre(const Args&... matchers) {
  return internal::ElementsAreMatcher<
Abseil Team's avatar
Abseil Team committed
4651
4652
      std::tuple<typename std::decay<const Args&>::type...>>(
      std::make_tuple(matchers...));
Gennadiy Civil's avatar
 
Gennadiy Civil committed
4653
4654
4655
}

template <typename... Args>
Gennadiy Civil's avatar
Gennadiy Civil committed
4656
internal::UnorderedElementsAreMatcher<
Abseil Team's avatar
Abseil Team committed
4657
    std::tuple<typename std::decay<const Args&>::type...>>
Gennadiy Civil's avatar
 
Gennadiy Civil committed
4658
4659
UnorderedElementsAre(const Args&... matchers) {
  return internal::UnorderedElementsAreMatcher<
Abseil Team's avatar
Abseil Team committed
4660
4661
      std::tuple<typename std::decay<const Args&>::type...>>(
      std::make_tuple(matchers...));
Gennadiy Civil's avatar
 
Gennadiy Civil committed
4662
4663
}

misterg's avatar
misterg committed
4664
// Define variadic matcher versions.
misterg's avatar
misterg committed
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
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
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
// AnyOfArray(array)
// AnyOfArray(pointer, count)
// AnyOfArray(container)
// AnyOfArray({ e1, e2, ..., en })
// AnyOfArray(iterator_first, iterator_last)
//
// AnyOfArray() verifies whether a given value matches any member of a
// collection of matchers.
//
// AllOfArray(array)
// AllOfArray(pointer, count)
// AllOfArray(container)
// AllOfArray({ e1, e2, ..., en })
// AllOfArray(iterator_first, iterator_last)
//
// AllOfArray() verifies whether a given value matches all members of a
// collection of matchers.
//
// 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::AnyOfArrayMatcher<
    typename ::std::iterator_traits<Iter>::value_type>
AnyOfArray(Iter first, Iter last) {
  return internal::AnyOfArrayMatcher<
      typename ::std::iterator_traits<Iter>::value_type>(first, last);
}

template <typename Iter>
inline internal::AllOfArrayMatcher<
    typename ::std::iterator_traits<Iter>::value_type>
AllOfArray(Iter first, Iter last) {
  return internal::AllOfArrayMatcher<
      typename ::std::iterator_traits<Iter>::value_type>(first, last);
}

template <typename T>
inline internal::AnyOfArrayMatcher<T> AnyOfArray(const T* ptr, size_t count) {
  return AnyOfArray(ptr, ptr + count);
}

template <typename T>
inline internal::AllOfArrayMatcher<T> AllOfArray(const T* ptr, size_t count) {
  return AllOfArray(ptr, ptr + count);
}

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

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

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

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

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

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

Abseil Team's avatar
Abseil Team committed
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
// 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));
}

4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
// 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
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
// 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
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
// 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));
}

4814
4815
// These macros allow using matchers to check values in Google Test
// tests.  ASSERT_THAT(value, matcher) and EXPECT_THAT(value, matcher)
4816
4817
// succeed if and only if the value matches the matcher.  If the assertion
// fails, the value and the description of the matcher will be printed.
4818
4819
4820
4821
4822
#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)

Abseil Team's avatar
Abseil Team committed
4823
// MATCHER* macroses itself are listed below.
Abseil Team's avatar
Abseil Team committed
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
#define MATCHER(name, description)                                             \
  class name##Matcher                                                          \
      : public ::testing::internal::MatcherBaseImpl<name##Matcher> {           \
   public:                                                                     \
    template <typename arg_type>                                               \
    class gmock_Impl : public ::testing::MatcherInterface<const arg_type&> {   \
     public:                                                                   \
      gmock_Impl() {}                                                          \
      bool MatchAndExplain(                                                    \
          const arg_type& arg,                                                 \
          ::testing::MatchResultListener* result_listener) const override;     \
      void DescribeTo(::std::ostream* gmock_os) const override {               \
        *gmock_os << FormatDescription(false);                                 \
      }                                                                        \
      void DescribeNegationTo(::std::ostream* gmock_os) const override {       \
        *gmock_os << FormatDescription(true);                                  \
      }                                                                        \
                                                                               \
     private:                                                                  \
      ::std::string FormatDescription(bool negation) const {                   \
        ::std::string gmock_description = (description);                       \
        if (!gmock_description.empty()) {                                      \
          return gmock_description;                                            \
        }                                                                      \
        return ::testing::internal::FormatMatcherDescription(negation, #name,  \
                                                             {});              \
      }                                                                        \
    };                                                                         \
  };                                                                           \
  GTEST_ATTRIBUTE_UNUSED_ inline name##Matcher name() { return {}; }           \
  template <typename arg_type>                                                 \
  bool name##Matcher::gmock_Impl<arg_type>::MatchAndExplain(                   \
      const arg_type& arg,                                                     \
      ::testing::MatchResultListener* result_listener GTEST_ATTRIBUTE_UNUSED_) \
      const

Abseil Team's avatar
Abseil Team committed
4860
#define MATCHER_P(name, p0, description) \
Abseil Team's avatar
Abseil Team committed
4861
  GMOCK_INTERNAL_MATCHER(name, name##MatcherP, description, (p0))
Abseil Team's avatar
Abseil Team committed
4862
#define MATCHER_P2(name, p0, p1, description) \
Abseil Team's avatar
Abseil Team committed
4863
  GMOCK_INTERNAL_MATCHER(name, name##MatcherP2, description, (p0, p1))
Abseil Team's avatar
Abseil Team committed
4864
#define MATCHER_P3(name, p0, p1, p2, description) \
Abseil Team's avatar
Abseil Team committed
4865
  GMOCK_INTERNAL_MATCHER(name, name##MatcherP3, description, (p0, p1, p2))
Abseil Team's avatar
Abseil Team committed
4866
#define MATCHER_P4(name, p0, p1, p2, p3, description) \
Abseil Team's avatar
Abseil Team committed
4867
4868
4869
4870
  GMOCK_INTERNAL_MATCHER(name, name##MatcherP4, description, (p0, p1, p2, p3))
#define MATCHER_P5(name, p0, p1, p2, p3, p4, description)    \
  GMOCK_INTERNAL_MATCHER(name, name##MatcherP5, description, \
                         (p0, p1, p2, p3, p4))
Abseil Team's avatar
Abseil Team committed
4871
#define MATCHER_P6(name, p0, p1, p2, p3, p4, p5, description) \
Abseil Team's avatar
Abseil Team committed
4872
4873
  GMOCK_INTERNAL_MATCHER(name, name##MatcherP6, description,  \
                         (p0, p1, p2, p3, p4, p5))
Abseil Team's avatar
Abseil Team committed
4874
#define MATCHER_P7(name, p0, p1, p2, p3, p4, p5, p6, description) \
Abseil Team's avatar
Abseil Team committed
4875
4876
  GMOCK_INTERNAL_MATCHER(name, name##MatcherP7, description,      \
                         (p0, p1, p2, p3, p4, p5, p6))
Abseil Team's avatar
Abseil Team committed
4877
#define MATCHER_P8(name, p0, p1, p2, p3, p4, p5, p6, p7, description) \
Abseil Team's avatar
Abseil Team committed
4878
4879
4880
4881
4882
  GMOCK_INTERNAL_MATCHER(name, name##MatcherP8, description,          \
                         (p0, p1, p2, p3, p4, p5, p6, p7))
#define MATCHER_P9(name, p0, p1, p2, p3, p4, p5, p6, p7, p8, description) \
  GMOCK_INTERNAL_MATCHER(name, name##MatcherP9, description,              \
                         (p0, p1, p2, p3, p4, p5, p6, p7, p8))
Abseil Team's avatar
Abseil Team committed
4883
#define MATCHER_P10(name, p0, p1, p2, p3, p4, p5, p6, p7, p8, p9, description) \
Abseil Team's avatar
Abseil Team committed
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
  GMOCK_INTERNAL_MATCHER(name, name##MatcherP10, description,                  \
                         (p0, p1, p2, p3, p4, p5, p6, p7, p8, p9))

#define GMOCK_INTERNAL_MATCHER(name, full_name, description, args)             \
  template <GMOCK_INTERNAL_MATCHER_TEMPLATE_PARAMS(args)>                      \
  class full_name : public ::testing::internal::MatcherBaseImpl<               \
                        full_name<GMOCK_INTERNAL_MATCHER_TYPE_PARAMS(args)>> { \
   public:                                                                     \
    using full_name::MatcherBaseImpl::MatcherBaseImpl;                         \
    template <typename arg_type>                                               \
    class gmock_Impl : public ::testing::MatcherInterface<const arg_type&> {   \
     public:                                                                   \
      explicit gmock_Impl(GMOCK_INTERNAL_MATCHER_FUNCTION_ARGS(args))          \
          : GMOCK_INTERNAL_MATCHER_FORWARD_ARGS(args) {}                       \
      bool MatchAndExplain(                                                    \
          const arg_type& arg,                                                 \
          ::testing::MatchResultListener* result_listener) const override;     \
      void DescribeTo(::std::ostream* gmock_os) const override {               \
        *gmock_os << FormatDescription(false);                                 \
      }                                                                        \
      void DescribeNegationTo(::std::ostream* gmock_os) const override {       \
        *gmock_os << FormatDescription(true);                                  \
      }                                                                        \
      GMOCK_INTERNAL_MATCHER_MEMBERS(args)                                     \
                                                                               \
     private:                                                                  \
      ::std::string FormatDescription(bool negation) const {                   \
        ::std::string gmock_description = (description);                       \
        if (!gmock_description.empty()) {                                      \
          return gmock_description;                                            \
        }                                                                      \
        return ::testing::internal::FormatMatcherDescription(                  \
            negation, #name,                                                   \
            ::testing::internal::UniversalTersePrintTupleFieldsToStrings(      \
                ::std::tuple<GMOCK_INTERNAL_MATCHER_TYPE_PARAMS(args)>(        \
                    GMOCK_INTERNAL_MATCHER_MEMBERS_USAGE(args))));             \
      }                                                                        \
    };                                                                         \
  };                                                                           \
  template <GMOCK_INTERNAL_MATCHER_TEMPLATE_PARAMS(args)>                      \
  inline full_name<GMOCK_INTERNAL_MATCHER_TYPE_PARAMS(args)> name(             \
      GMOCK_INTERNAL_MATCHER_FUNCTION_ARGS(args)) {                            \
    return full_name<GMOCK_INTERNAL_MATCHER_TYPE_PARAMS(args)>(                \
        GMOCK_INTERNAL_MATCHER_ARGS_USAGE(args));                              \
  }                                                                            \
  template <GMOCK_INTERNAL_MATCHER_TEMPLATE_PARAMS(args)>                      \
  template <typename arg_type>                                                 \
  bool full_name<GMOCK_INTERNAL_MATCHER_TYPE_PARAMS(args)>::gmock_Impl<        \
      arg_type>::MatchAndExplain(const arg_type& arg,                          \
                                 ::testing::MatchResultListener*               \
                                     result_listener GTEST_ATTRIBUTE_UNUSED_)  \
      const

#define GMOCK_INTERNAL_MATCHER_TEMPLATE_PARAMS(args) \
  GMOCK_PP_TAIL(                                     \
      GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_MATCHER_TEMPLATE_PARAM, , args))
#define GMOCK_INTERNAL_MATCHER_TEMPLATE_PARAM(i_unused, data_unused, arg) \
  , typename arg##_type

#define GMOCK_INTERNAL_MATCHER_TYPE_PARAMS(args) \
  GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_MATCHER_TYPE_PARAM, , args))
#define GMOCK_INTERNAL_MATCHER_TYPE_PARAM(i_unused, data_unused, arg) \
  , arg##_type

#define GMOCK_INTERNAL_MATCHER_FUNCTION_ARGS(args) \
  GMOCK_PP_TAIL(dummy_first GMOCK_PP_FOR_EACH(     \
      GMOCK_INTERNAL_MATCHER_FUNCTION_ARG, , args))
#define GMOCK_INTERNAL_MATCHER_FUNCTION_ARG(i, data_unused, arg) \
  , arg##_type gmock_p##i

#define GMOCK_INTERNAL_MATCHER_FORWARD_ARGS(args) \
  GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_MATCHER_FORWARD_ARG, , args))
#define GMOCK_INTERNAL_MATCHER_FORWARD_ARG(i, data_unused, arg) \
  , arg(::std::forward<arg##_type>(gmock_p##i))

#define GMOCK_INTERNAL_MATCHER_MEMBERS(args) \
  GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_MATCHER_MEMBER, , args)
#define GMOCK_INTERNAL_MATCHER_MEMBER(i_unused, data_unused, arg) \
  const arg##_type arg;

#define GMOCK_INTERNAL_MATCHER_MEMBERS_USAGE(args) \
  GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_MATCHER_MEMBER_USAGE, , args))
#define GMOCK_INTERNAL_MATCHER_MEMBER_USAGE(i_unused, data_unused, arg) , arg

#define GMOCK_INTERNAL_MATCHER_ARGS_USAGE(args) \
  GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_MATCHER_ARG_USAGE, , args))
#define GMOCK_INTERNAL_MATCHER_ARG_USAGE(i, data_unused, arg_unused) \
  , gmock_p##i
Abseil Team's avatar
Abseil Team committed
4972

4973
4974
}  // namespace testing

misterg's avatar
misterg committed
4975
GTEST_DISABLE_MSC_WARNINGS_POP_()  //  4251 5046
misterg's avatar
misterg committed
4976

4977
4978
4979
4980
// 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
4981

4982
#endif  // GMOCK_INCLUDE_GMOCK_GMOCK_MATCHERS_H_