1 // Copyright 2007, Google Inc.
2 // All rights reserved.
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
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
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.
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.
30 // Author: wan@google.com (Zhanyong Wan)
32 // Google Mock - a framework for writing C++ mock classes.
34 // This is the main header file a user should include.
36 #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_H_
37 #define GMOCK_INCLUDE_GMOCK_GMOCK_H_
39 // This file implements the following syntax:
41 // ON_CALL(mock_object.Method(...))
42 // .WithArguments(...) ?
43 // .WillByDefault(...);
45 // where WithArguments() is optional and WillByDefault() must appear
48 // EXPECT_CALL(mock_object.Method(...))
49 // .WithArguments(...) ?
53 // .WillRepeatedly(...) ?
54 // .RetiresOnSaturation() ? ;
56 // where all clauses are optional and WillOnce() can be repeated.
58 #include <gmock/gmock-actions.h>
59 #include <gmock/gmock-cardinalities.h>
60 #include <gmock/gmock-generated-actions.h>
61 #include <gmock/gmock-generated-function-mockers.h>
62 #include <gmock/gmock-generated-matchers.h>
63 #include <gmock/gmock-generated-nice-strict.h>
64 #include <gmock/gmock-matchers.h>
65 #include <gmock/gmock-printers.h>
66 #include <gmock/internal/gmock-internal-utils.h>
70 // Declares Google Mock flags that we want a user to use programmatically.
71 GMOCK_DECLARE_bool_(catch_leaked_mocks);
72 GMOCK_DECLARE_string_(verbose);
74 // Initializes Google Mock. This must be called before running the
75 // tests. In particular, it parses the command line for the flags
76 // that Google Mock recognizes. Whenever a Google Mock flag is seen,
77 // it is removed from argv, and *argc is decremented.
79 // No value is returned. Instead, the Google Mock flag variables are
82 // Since Google Test is needed for Google Mock to work, this function
83 // also initializes Google Test and parses its flags, if that hasn't
85 void InitGoogleMock(int* argc, char** argv);
87 // This overloaded version can be used in Windows programs compiled in
89 void InitGoogleMock(int* argc, wchar_t** argv);
91 } // namespace testing
93 #endif // GMOCK_INCLUDE_GMOCK_GMOCK_H_