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