aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/restricted/googletest/googlemock/include/gmock/gmock.h
blob: 0ad0fa8d72db99d4a6859683b0c4bbcab248274c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
// Copyright 2007, Google Inc. 
// All rights reserved. 
// 
// Redistribution and use in source and binary forms, with or without 
// modification, are permitted provided that the following conditions are 
// met: 
// 
//     * Redistributions of source code must retain the above copyright 
// notice, this list of conditions and the following disclaimer. 
//     * Redistributions in binary form must reproduce the above 
// copyright notice, this list of conditions and the following disclaimer 
// in the documentation and/or other materials provided with the 
// distribution. 
//     * Neither the name of Google Inc. nor the names of its 
// contributors may be used to endorse or promote products derived from 
// this software without specific prior written permission. 
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 

// Google Mock - a framework for writing C++ mock classes. 
// 
// This is the main header file a user should include. 
 
// GOOGLETEST_CM0002 DO NOT DELETE

#ifndef GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_H_
#define GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_H_
 
// This file implements the following syntax: 
// 
//   ON_CALL(mock_object, Method(...))
//     .With(...) ? 
//     .WillByDefault(...); 
// 
// where With() is optional and WillByDefault() must appear exactly 
// once. 
// 
//   EXPECT_CALL(mock_object, Method(...))
//     .With(...) ? 
//     .Times(...) ? 
//     .InSequence(...) * 
//     .WillOnce(...) * 
//     .WillRepeatedly(...) ? 
//     .RetiresOnSaturation() ? ; 
// 
// where all clauses are optional and WillOnce() can be repeated. 
 
#include "gmock/gmock-actions.h"
#include "gmock/gmock-cardinalities.h"
#include "gmock/gmock-function-mocker.h"
#include "gmock/gmock-matchers.h"
#include "gmock/gmock-more-actions.h"
#include "gmock/gmock-more-matchers.h"
#include "gmock/gmock-nice-strict.h"
#include "gmock/internal/gmock-internal-utils.h"
 
namespace testing { 
 
// Declares Google Mock flags that we want a user to use programmatically. 
GMOCK_DECLARE_bool_(catch_leaked_mocks); 
GMOCK_DECLARE_string_(verbose); 
GMOCK_DECLARE_int32_(default_mock_behavior);
 
// Initializes Google Mock.  This must be called before running the 
// tests.  In particular, it parses the command line for the flags 
// that Google Mock recognizes.  Whenever a Google Mock flag is seen, 
// it is removed from argv, and *argc is decremented. 
// 
// No value is returned.  Instead, the Google Mock flag variables are 
// updated. 
// 
// Since Google Test is needed for Google Mock to work, this function 
// also initializes Google Test and parses its flags, if that hasn't 
// been done. 
GTEST_API_ void InitGoogleMock(int* argc, char** argv); 
 
// This overloaded version can be used in Windows programs compiled in 
// UNICODE mode. 
GTEST_API_ void InitGoogleMock(int* argc, wchar_t** argv); 
 
// This overloaded version can be used on Arduino/embedded platforms where
// there is no argc/argv.
GTEST_API_ void InitGoogleMock();

}  // namespace testing 
 
#endif  // GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_H_