You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

98 lines
3.6 KiB

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