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 | // Google Mock - a framework for writing C++ mock classes. |
31 | // |
32 | // This is the main header file a user should include. |
33 | |
34 | // GOOGLETEST_CM0002 DO NOT DELETE |
35 | |
36 | #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_H_ |
37 | #define GMOCK_INCLUDE_GMOCK_GMOCK_H_ |
38 | |
39 | // This file implements the following syntax: |
40 | // |
41 | // ON_CALL(mock_object, Method(...)) |
42 | // .With(...) ? |
43 | // .WillByDefault(...); |
44 | // |
45 | // where With() is optional and WillByDefault() must appear exactly |
46 | // once. |
47 | // |
48 | // EXPECT_CALL(mock_object, Method(...)) |
49 | // .With(...) ? |
50 | // .Times(...) ? |
51 | // .InSequence(...) * |
52 | // .WillOnce(...) * |
53 | // .WillRepeatedly(...) ? |
54 | // .RetiresOnSaturation() ? ; |
55 | // |
56 | // where all clauses are optional and WillOnce() can be repeated. |
57 | |
58 | #include "gmock/gmock-actions.h" |
59 | #include "gmock/gmock-cardinalities.h" |
60 | #include "gmock/gmock-function-mocker.h" |
61 | #include "gmock/gmock-generated-actions.h" |
62 | #include "gmock/gmock-generated-function-mockers.h" |
63 | #include "gmock/gmock-generated-matchers.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 | #include "gmock/internal/gmock-port.h" |
70 | |
71 | #ifdef __clang__ |
72 | #if __has_warning("-Wdeprecated-copy") |
73 | #pragma clang diagnostic push |
74 | #pragma clang diagnostic ignored "-Wdeprecated-copy" |
75 | #endif |
76 | #endif |
77 | |
78 | namespace testing { |
79 | |
80 | // Declares Google Mock flags that we want a user to use programmatically. |
81 | GMOCK_DECLARE_bool_(catch_leaked_mocks); |
82 | GMOCK_DECLARE_string_(verbose); |
83 | GMOCK_DECLARE_int32_(default_mock_behavior); |
84 | |
85 | // Initializes Google Mock. This must be called before running the |
86 | // tests. In particular, it parses the command line for the flags |
87 | // that Google Mock recognizes. Whenever a Google Mock flag is seen, |
88 | // it is removed from argv, and *argc is decremented. |
89 | // |
90 | // No value is returned. Instead, the Google Mock flag variables are |
91 | // updated. |
92 | // |
93 | // Since Google Test is needed for Google Mock to work, this function |
94 | // also initializes Google Test and parses its flags, if that hasn't |
95 | // been done. |
96 | GTEST_API_ void InitGoogleMock(int* argc, char** argv); |
97 | |
98 | // This overloaded version can be used in Windows programs compiled in |
99 | // UNICODE mode. |
100 | GTEST_API_ void InitGoogleMock(int* argc, wchar_t** argv); |
101 | |
102 | // This overloaded version can be used on Arduino/embedded platforms where |
103 | // there is no argc/argv. |
104 | GTEST_API_ void InitGoogleMock(); |
105 | |
106 | } // namespace testing |
107 | |
108 | #ifdef __clang__ |
109 | #if __has_warning("-Wdeprecated-copy") |
110 | #pragma clang diagnostic pop |
111 | #endif |
112 | #endif |
113 | |
114 | #endif // GMOCK_INCLUDE_GMOCK_GMOCK_H_ |
115 | |