1dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Copyright 2007, Google Inc.
2dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// All rights reserved.
3dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter//
4dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Redistribution and use in source and binary forms, with or without
5dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// modification, are permitted provided that the following conditions are
6dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// met:
7dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter//
8dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter//     * Redistributions of source code must retain the above copyright
9dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// notice, this list of conditions and the following disclaimer.
10dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter//     * Redistributions in binary form must reproduce the above
11dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// copyright notice, this list of conditions and the following disclaimer
12dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// in the documentation and/or other materials provided with the
13dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// distribution.
14dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter//     * Neither the name of Google Inc. nor the names of its
15dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// contributors may be used to endorse or promote products derived from
16dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// this software without specific prior written permission.
17dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter//
18dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter//
30dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Author: wan@google.com (Zhanyong Wan)
31dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
32dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Google Mock - a framework for writing C++ mock classes.
33dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter//
34dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// This file implements cardinalities.
35dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
3646108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan#include "gmock/gmock-cardinalities.h"
37dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
38dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#include <limits.h>
39dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#include <ostream>  // NOLINT
40dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#include <sstream>
41dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#include <string>
4246108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan#include "gmock/internal/gmock-internal-utils.h"
4346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan#include "gtest/gtest.h"
44dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
45dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixternamespace testing {
46dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
47dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixternamespace {
48dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
49dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Implements the Between(m, n) cardinality.
50dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixterclass BetweenCardinalityImpl : public CardinalityInterface {
51dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter public:
52dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  BetweenCardinalityImpl(int min, int max)
53dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter      : min_(min >= 0 ? min : 0),
54dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter        max_(max >= min_ ? max : min_) {
55dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    std::stringstream ss;
56dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    if (min < 0) {
57dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter      ss << "The invocation lower bound must be >= 0, "
58dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter         << "but is actually " << min << ".";
59dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter      internal::Expect(false, __FILE__, __LINE__, ss.str());
60dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    } else if (max < 0) {
61dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter      ss << "The invocation upper bound must be >= 0, "
62dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter         << "but is actually " << max << ".";
63dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter      internal::Expect(false, __FILE__, __LINE__, ss.str());
64dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    } else if (min > max) {
65dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter      ss << "The invocation upper bound (" << max
66dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter         << ") must be >= the invocation lower bound (" << min
67dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter         << ").";
68dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter      internal::Expect(false, __FILE__, __LINE__, ss.str());
69dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    }
70dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  }
71dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
72dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  // Conservative estimate on the lower/upper bound of the number of
73dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  // calls allowed.
74dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  virtual int ConservativeLowerBound() const { return min_; }
75dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  virtual int ConservativeUpperBound() const { return max_; }
76dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
77dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  virtual bool IsSatisfiedByCallCount(int call_count) const {
7846108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan    return min_ <= call_count && call_count <= max_;
79dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  }
80dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
81dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  virtual bool IsSaturatedByCallCount(int call_count) const {
82dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    return call_count >= max_;
83dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  }
84dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
85dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  virtual void DescribeTo(::std::ostream* os) const;
8646108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan
87dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter private:
88dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  const int min_;
89dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  const int max_;
90dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
91dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  GTEST_DISALLOW_COPY_AND_ASSIGN_(BetweenCardinalityImpl);
92dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter};
93dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
94dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Formats "n times" in a human-friendly way.
95dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixterinline internal::string FormatTimes(int n) {
96dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  if (n == 1) {
97dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    return "once";
98dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  } else if (n == 2) {
99dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    return "twice";
100dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  } else {
101dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    std::stringstream ss;
102dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    ss << n << " times";
103dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    return ss.str();
104dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  }
105dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter}
106dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
107dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Describes the Between(m, n) cardinality in human-friendly text.
108dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixtervoid BetweenCardinalityImpl::DescribeTo(::std::ostream* os) const {
109dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  if (min_ == 0) {
110dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    if (max_ == 0) {
111dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter      *os << "never called";
112dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    } else if (max_ == INT_MAX) {
113dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter      *os << "called any number of times";
114dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    } else {
115dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter      *os << "called at most " << FormatTimes(max_);
116dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    }
117dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  } else if (min_ == max_) {
118dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    *os << "called " << FormatTimes(min_);
119dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  } else if (max_ == INT_MAX) {
120dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    *os << "called at least " << FormatTimes(min_);
121dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  } else {
122dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    // 0 < min_ < max_ < INT_MAX
123dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    *os << "called between " << min_ << " and " << max_ << " times";
124dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  }
125dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter}
126dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
127dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter}  // Unnamed namespace
128dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
129dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Describes the given call count to an ostream.
130dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixtervoid Cardinality::DescribeActualCallCountTo(int actual_call_count,
131dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter                                            ::std::ostream* os) {
132dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  if (actual_call_count > 0) {
133dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    *os << "called " << FormatTimes(actual_call_count);
134dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  } else {
135dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter    *os << "never called";
136dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  }
137dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter}
138dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
139dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Creates a cardinality that allows at least n calls.
14046108a219a4b812dd8f36fee479a0340ea5963f5Ben ChanGTEST_API_ Cardinality AtLeast(int n) { return Between(n, INT_MAX); }
141dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
142dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Creates a cardinality that allows at most n calls.
14346108a219a4b812dd8f36fee479a0340ea5963f5Ben ChanGTEST_API_ Cardinality AtMost(int n) { return Between(0, n); }
144dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
145dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Creates a cardinality that allows any number of calls.
14646108a219a4b812dd8f36fee479a0340ea5963f5Ben ChanGTEST_API_ Cardinality AnyNumber() { return AtLeast(0); }
147dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
148dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Creates a cardinality that allows between min and max calls.
14946108a219a4b812dd8f36fee479a0340ea5963f5Ben ChanGTEST_API_ Cardinality Between(int min, int max) {
150dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter  return Cardinality(new BetweenCardinalityImpl(min, max));
151dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter}
152dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
153dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Creates a cardinality that allows exactly n calls.
15446108a219a4b812dd8f36fee479a0340ea5963f5Ben ChanGTEST_API_ Cardinality Exactly(int n) { return Between(n, n); }
155dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter
156dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter}  // namespace testing
157