1c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Copyright 2007, Google Inc. 2c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// All rights reserved. 3c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 4c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Redistribution and use in source and binary forms, with or without 5c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// modification, are permitted provided that the following conditions are 6c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// met: 7c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 8c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// * Redistributions of source code must retain the above copyright 9c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// notice, this list of conditions and the following disclaimer. 10c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// * Redistributions in binary form must reproduce the above 11c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// copyright notice, this list of conditions and the following disclaimer 12c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// in the documentation and/or other materials provided with the 13c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// distribution. 14c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// * Neither the name of Google Inc. nor the names of its 15c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// contributors may be used to endorse or promote products derived from 16c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// this software without specific prior written permission. 17c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 18c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 30c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Author: wan@google.com (Zhanyong Wan) 31c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 32c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Google Mock - a framework for writing C++ mock classes. 33c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 34c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// This is the main header file a user should include. 35c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 36c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#ifndef GMOCK_INCLUDE_GMOCK_GMOCK_H_ 37c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#define GMOCK_INCLUDE_GMOCK_GMOCK_H_ 38c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 39c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// This file implements the following syntax: 40c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 41c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// ON_CALL(mock_object.Method(...)) 42c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// .With(...) ? 43c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// .WillByDefault(...); 44c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 45c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// where With() is optional and WillByDefault() must appear exactly 46c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// once. 47c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 48c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// EXPECT_CALL(mock_object.Method(...)) 49c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// .With(...) ? 50c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// .Times(...) ? 51c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// .InSequence(...) * 52c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// .WillOnce(...) * 53c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// .WillRepeatedly(...) ? 54c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// .RetiresOnSaturation() ? ; 55c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 56c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// where all clauses are optional and WillOnce() can be repeated. 57c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 58dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include "gmock/gmock-actions.h" 59dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include "gmock/gmock-cardinalities.h" 60dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include "gmock/gmock-generated-actions.h" 61dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include "gmock/gmock-generated-function-mockers.h" 62dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include "gmock/gmock-generated-matchers.h" 63dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include "gmock/gmock-more-actions.h" 64dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include "gmock/gmock-generated-nice-strict.h" 65dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include "gmock/gmock-matchers.h" 66dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include "gmock/internal/gmock-internal-utils.h" 67c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 68c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochnamespace testing { 69c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 70c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Declares Google Mock flags that we want a user to use programmatically. 71c407dc5cd9bdc5668497f21b26b09d988ab439deBen MurdochGMOCK_DECLARE_bool_(catch_leaked_mocks); 72c407dc5cd9bdc5668497f21b26b09d988ab439deBen MurdochGMOCK_DECLARE_string_(verbose); 73c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 74c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Initializes Google Mock. This must be called before running the 75c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// tests. In particular, it parses the command line for the flags 76c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// that Google Mock recognizes. Whenever a Google Mock flag is seen, 77c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// it is removed from argv, and *argc is decremented. 78c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 79c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// No value is returned. Instead, the Google Mock flag variables are 80c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// updated. 81c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 82c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Since Google Test is needed for Google Mock to work, this function 83c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// also initializes Google Test and parses its flags, if that hasn't 84c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// been done. 85c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochvoid InitGoogleMock(int* argc, char** argv); 86c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 87c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// This overloaded version can be used in Windows programs compiled in 88c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// UNICODE mode. 89c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochvoid InitGoogleMock(int* argc, wchar_t** argv); 90c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 91c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch} // namespace testing 92c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 93c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#endif // GMOCK_INCLUDE_GMOCK_GMOCK_H_ 94