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