include/gmock/gmock.h

0001 // Copyright 2007, Google Inc.
0002 // All rights reserved.
0003 //
0004 // Redistribution and use in source and binary forms, with or without
0005 // modification, are permitted provided that the following conditions are
0006 // met:
0007 //
0008 //     * Redistributions of source code must retain the above copyright
0009 // notice, this list of conditions and the following disclaimer.
0010 //     * Redistributions in binary form must reproduce the above
0011 // copyright notice, this list of conditions and the following disclaimer
0012 // in the documentation and/or other materials provided with the
0013 // distribution.
0014 //     * Neither the name of Google Inc. nor the names of its
0015 // contributors may be used to endorse or promote products derived from
0016 // this software without specific prior written permission.
0017 //
0018 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0019 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0020 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0021 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0022 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0023 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0024 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0025 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0026 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0027 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0028 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0029 //
0030 // Author: wan@google.com (Zhanyong Wan)
0031
0032 // Google Mock - a framework for writing C++ mock classes.
0033 //
0034 // This is the main header file a user should include.
0035
0036 #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_H_
0037 #define GMOCK_INCLUDE_GMOCK_GMOCK_H_
0038
0039 // This file implements the following syntax:
0040 //
0041 //   ON_CALL(mock_object.Method(...))
0042 //     .With(...) ?
0043 //     .WillByDefault(...);
0044 //
0045 // where With() is optional and WillByDefault() must appear exactly
0046 // once.
0047 //
0048 //   EXPECT_CALL(mock_object.Method(...))
0049 //     .With(...) ?
0050 //     .Times(...) ?
0051 //     .InSequence(...) *
0052 //     .WillOnce(...) *
0053 //     .WillRepeatedly(...) ?
0054 //     .RetiresOnSaturation() ? ;
0055 //
0056 // where all clauses are optional and WillOnce() can be repeated.
0057
0058 #include "gmock/gmock-actions.h"
0059 #include "gmock/gmock-cardinalities.h"
0060 #include "gmock/gmock-generated-actions.h"
0061 #include "gmock/gmock-generated-function-mockers.h"
0062 #include "gmock/gmock-generated-nice-strict.h"
0063 #include "gmock/gmock-generated-matchers.h"
0064 #include "gmock/gmock-matchers.h"
0065 #include "gmock/gmock-more-actions.h"
0066 #include "gmock/gmock-more-matchers.h"
0067 #include "gmock/internal/gmock-internal-utils.h"
0068
0069 namespace testing {
0070
0071 // Declares Google Mock flags that we want a user to use programmatically.
0072 GMOCK_DECLARE_bool_(catch_leaked_mocks);
0073 GMOCK_DECLARE_string_(verbose);
0074
0075 // Initializes Google Mock.  This must be called before running the
0076 // tests.  In particular, it parses the command line for the flags
0077 // that Google Mock recognizes.  Whenever a Google Mock flag is seen,
0078 // it is removed from argv, and *argc is decremented.
0079 //
0080 // No value is returned.  Instead, the Google Mock flag variables are
0081 // updated.
0082 //
0083 // Since Google Test is needed for Google Mock to work, this function
0084 // also initializes Google Test and parses its flags, if that hasn't
0085 // been done.
0086 GTEST_API_ void InitGoogleMock(int* argc, char** argv);
0087
0088 // This overloaded version can be used in Windows programs compiled in
0089 // UNICODE mode.
0090 GTEST_API_ void InitGoogleMock(int* argc, wchar_t** argv);
0091
0092 }  // namespace testing
0093
0094 #endif  // GMOCK_INCLUDE_GMOCK_GMOCK_H_