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 GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_H_
38 #define GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_H_
39 
40 #define GMOCK_INCLUDE_GMOCK_GMOCK_H_ // Android: backwards compatibility.
41 
42 // This file implements the following syntax:
43 //
44 //   ON_CALL(mock_object, Method(...))
45 //     .With(...) ?
46 //     .WillByDefault(...);
47 //
48 // where With() is optional and WillByDefault() must appear exactly
49 // once.
50 //
51 //   EXPECT_CALL(mock_object, Method(...))
52 //     .With(...) ?
53 //     .Times(...) ?
54 //     .InSequence(...) *
55 //     .WillOnce(...) *
56 //     .WillRepeatedly(...) ?
57 //     .RetiresOnSaturation() ? ;
58 //
59 // where all clauses are optional and WillOnce() can be repeated.
60 
61 #include "gmock/gmock-actions.h"
62 #include "gmock/gmock-cardinalities.h"
63 #include "gmock/gmock-function-mocker.h"
64 #include "gmock/gmock-matchers.h"
65 #include "gmock/gmock-more-actions.h"
66 #include "gmock/gmock-more-matchers.h"
67 #include "gmock/gmock-nice-strict.h"
68 #include "gmock/internal/gmock-internal-utils.h"
69 
70 namespace testing {
71 
72 // Declares Google Mock flags that we want a user to use programmatically.
73 GMOCK_DECLARE_bool_(catch_leaked_mocks);
74 GMOCK_DECLARE_string_(verbose);
75 GMOCK_DECLARE_int32_(default_mock_behavior);
76 
77 // Initializes Google Mock.  This must be called before running the
78 // tests.  In particular, it parses the command line for the flags
79 // that Google Mock recognizes.  Whenever a Google Mock flag is seen,
80 // it is removed from argv, and *argc is decremented.
81 //
82 // No value is returned.  Instead, the Google Mock flag variables are
83 // updated.
84 //
85 // Since Google Test is needed for Google Mock to work, this function
86 // also initializes Google Test and parses its flags, if that hasn't
87 // been done.
88 GTEST_API_ void InitGoogleMock(int* argc, char** argv);
89 
90 // This overloaded version can be used in Windows programs compiled in
91 // UNICODE mode.
92 GTEST_API_ void InitGoogleMock(int* argc, wchar_t** argv);
93 
94 // This overloaded version can be used on Arduino/embedded platforms where
95 // there is no argc/argv.
96 GTEST_API_ void InitGoogleMock();
97 
98 }  // namespace testing
99 
100 #endif  // GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_H_
101