Google C++ Mocking Framework============================http://code.google.com/p/googlemock/Overview--------Google's framework for writing and using C++ mock classes on a varietyof platforms (Linux, Mac OS X, Windows, Windows CE, Symbian, etc).Inspired by jMock, EasyMock, and Hamcrest, and designed with C++'sspecifics in mind, it can help you derive better designs of yoursystem and write better tests.Google Mock:- provides a declarative syntax for defining mocks,- can easily define partial (hybrid) mocks, which are a cross of real  and mock objects,- handles functions of arbitrary types and overloaded functions,- comes with a rich set of matchers for validating function arguments,- uses an intuitive syntax for controlling the behavior of a mock,- does automatic verification of expectations (no record-and-replay  needed),- allows arbitrary (partial) ordering constraints on  function calls to be expressed,- lets a user extend it by defining new matchers and actions.- does not use exceptions, and- is easy to learn and use.Please see the project page above for more information as well as themailing list for questions, discussions, and development.  There isalso an IRC channel on OFTC (irc.oftc.net) #gtest available.  Pleasejoin us!Please note that code under scripts/generator/ is from the cppcleanproject (http://code.google.com/p/cppclean/) and under the ApacheLicense, which is different from Google Mock's license.Requirements for End Users--------------------------Google Mock is implemented on top of the Google Test C++ testingframework (http://code.google.com/p/googletest/), and includes thelatter as part of the SVN repositary and distribution package.  Youmust use the bundled version of Google Test when using Google Mock, oryou may get compiler/linker errors.You can also easily configure Google Mock to work with another testingframework of your choice; although it will still need Google Test asan internal dependency.  Please readhttp://code.google.com/p/googlemock/wiki/ForDummies#Using_Google_Mock_with_Any_Testing_Frameworkfor how to do it.Google Mock depends on advanced C++ features and thus requires a moremodern compiler.  The following are needed to use Google Mock:### Linux Requirements ###These are the base requirements to build and use Google Mock from a sourcepackage (as described below):  * GNU-compatible Make or "gmake"  * POSIX-standard shell  * POSIX(-2) Regular Expressions (regex.h)  * C++98-standard-compliant compiler (e.g. GCC 3.4 or newer)### Windows Requirements ###  * Microsoft Visual C++ 8.0 SP1 or newer### Mac OS X Requirements ###  * Mac OS X 10.4 Tiger or newer  * Developer Tools InstalledRequirements for Contributors-----------------------------We welcome patches.  If you plan to contribute a patch, you need tobuild Google Mock and its own tests from an SVN checkout (describedbelow), which has further requirements:  * Automake version 1.9 or newer  * Autoconf version 2.59 or newer  * Libtool / Libtoolize  * Python version 2.3 or newer (for running some of the tests and    re-generating certain source files from templates)Getting the Source------------------There are two primary ways of getting Google Mock's source code: youcan download a stable source release in your preferred archive format,or directly check out the source from our Subversion (SVN) repositary.The SVN checkout requires a few extra steps and some extra softwarepackages on your system, but lets you track development and makepatches much more easily, so we highly encourage it.### Source Package ###Google Mock is released in versioned source packages which can bedownloaded from the download page [1].  Several different archiveformats are provided, but the only difference is the tools needed toextract their contents, and the size of the resulting file.  Downloadwhichever you are most comfortable with.  [1]http://code.google.com/p/googlemock/downloads/listOnce downloaded expand the archive using whichever tools you preferfor that type.  This will always result in a new directory with thename "gmock-X.Y.Z" which contains all of the source code.  Here aresome examples on Linux:  tar -xvzf gmock-X.Y.Z.tar.gz  tar -xvjf gmock-X.Y.Z.tar.bz2  unzip gmock-X.Y.Z.zip### SVN Checkout ###To check out the main branch (also known as the "trunk") of GoogleMock, run the following Subversion command:  svn checkouthttp://googlemock.googlecode.com/svn/trunk/ gmock-svnIf you are using a *nix system and plan to use the GNU Autotools buildsystem to build Google Mock (described below), you'll need toconfigure it now.  Otherwise you are done with getting the sourcefiles.To prepare the Autotools build system, enter the target directory ofthe checkout command you used ('gmock-svn') and proceed with thefollowing command:  autoreconf -fviOnce you have completed this step, you are ready to build the library.Note that you should only need to complete this step once.  Thesubsequent 'make' invocations will automatically re-generate the bitsof the build system that need to be changed.If your system uses older versions of the autotools, the above commandwill fail.  You may need to explicitly specify a version to use.  Forinstance, if you have both GNU Automake 1.4 and 1.9 installed and'automake' would invoke the 1.4, use instead:  AUTOMAKE=automake-1.9 ACLOCAL=aclocal-1.9 autoreconf -fviMake sure you're using the same version of automake and aclocal.Setting up the Build--------------------To build Google Mock and your tests that use it, you need to tell yourbuild system where to find its headers and source files.  The exactway to do it depends on which build system you use, and is usuallystraightforward.### Generic Build Instructions ###This section shows how you can integrate Google Mock into yourexisting build system.Suppose you put Google Mock in directory ${GMOCK_DIR} and Google Testin ${GTEST_DIR} (the latter is ${GMOCK_DIR}/gtest by default).  Tobuild Google Mock, create a library build target (or a project ascalled by Visual Studio and Xcode) to compile  ${GTEST_DIR}/src/gtest-all.cc and ${GMOCK_DIR}/src/gmock-all.ccwith  ${GTEST_DIR}/include, ${GTEST_DIR}, ${GMOCK_DIR}/include, and ${GMOCK_DIR}in the header search path.  Assuming a Linux-like system and gcc,something like the following will do:  g++ -I${GTEST_DIR}/include -I${GTEST_DIR} -I${GMOCK_DIR}/include \      -I${GMOCK_DIR} -c ${GTEST_DIR}/src/gtest-all.cc  g++ -I${GTEST_DIR}/include -I${GTEST_DIR} -I${GMOCK_DIR}/include \      -I${GMOCK_DIR} -c ${GMOCK_DIR}/src/gmock-all.cc  ar -rv libgmock.a gtest-all.o gmock-all.oNext, you should compile your test source file with${GTEST_DIR}/include and ${GMOCK_DIR}/include in the header searchpath, and link it with gmock and any other necessary libraries:  g++ -I${GTEST_DIR}/include -I${GMOCK_DIR}/include \      path/to/your_test.cc libgmock.a -o your_testAs an example, the make/ directory contains a Makefile that you canuse to build Google Mock on systems where GNU make is available(e.g. Linux, Mac OS X, and Cygwin).  It doesn't try to build GoogleMock's own tests.  Instead, it just builds the Google Mock library anda sample test.  You can use it as a starting point for your own buildscript.If the default settings are correct for your environment, thefollowing commands should succeed:  cd ${GMOCK_DIR}/make  make  ./gmock_testIf you see errors, try to tweak the contents of make/Makefile to makethem go away.  There are instructions in make/Makefile on how to doit.### Windows ###The msvc/2005 directory contains VC++ 2005 projects and the msvc/2010directory contains VC++ 2010 projects for building Google Mock andselected tests.Change to the appropriate directory and run "msbuild gmock.sln" tobuild the library and tests (or open the gmock.sln in the MSVC IDE).If you want to create your own project to use with Google Mock, you'llhave to configure it to use the gmock_config propety sheet.  For that: * Open the Property Manager window (View | Other Windows | Property Manager) * Right-click on your project and select "Add Existing Property Sheet..." * Navigate to gmock_config.vsprops or gmock_config.props and select it. * In Project Properties | Configuration Properties | General | Additional   Include Directories, type <path to Google Mock>/include.Tweaking Google Mock--------------------Google Mock can be used in diverse environments.  The defaultconfiguration may not work (or may not work well) out of the box insome environments.  However, you can easily tweak Google Mock bydefining control macros on the compiler command line.  Generally,these macros are named like GTEST_XYZ and you define them to either 1or 0 to enable or disable a certain feature.We list the most frequently used macros below.  For a complete list,see file ${GTEST_DIR}/include/gtest/internal/gtest-port.h.### Choosing a TR1 Tuple Library ###Google Mock uses the C++ Technical Report 1 (TR1) tuple libraryheavily.  Unfortunately TR1 tuple is not yet widely available with allcompilers.  The good news is that Google Test 1.4.0+ implements asubset of TR1 tuple that's enough for Google Mock's need.  Google Mockwill automatically use that implementation when the compiler doesn'tprovide TR1 tuple.Usually you don't need to care about which tuple library Google Testand Google Mock use.  However, if your project already uses TR1 tuple,you need to tell Google Test and Google Mock to use the same TR1 tuplelibrary the rest of your project uses, or the two tupleimplementations will clash.  To do that, add  -DGTEST_USE_OWN_TR1_TUPLE=0to the compiler flags while compiling Google Test, Google Mock, andyour tests.  If you want to force Google Test and Google Mock to usetheir own tuple library, just add  -DGTEST_USE_OWN_TR1_TUPLE=1to the compiler flags instead.If you want to use Boost's TR1 tuple library with Google Mock, pleaserefer to the Boost website (http://www.boost.org/) for how to obtainit and set it up.### As a Shared Library (DLL) ###Google Mock is compact, so most users can build and link it as a staticlibrary for the simplicity.  Google Mock can be used as a DLL, but thesame DLL must contain Google Test as well.  See Google Test's READMEfile for instructions on how to set up necessary compiler settings.### Tweaking Google Mock ###Most of Google Test's control macros apply to Google Mock as well.Please see file ${GTEST_DIR}/README for how to tweak them.Upgrading from an Earlier Version---------------------------------We strive to keep Google Mock releases backward compatible.Sometimes, though, we have to make some breaking changes for theusers' long-term benefits.  This section describes what you'll need todo if you are upgrading from an earlier version of Google Mock.### Upgrading from 1.1.0 or Earlier ###You may need to explicitly enable or disable Google Test's own TR1tuple library.  See the instructions in section "Choosing a TR1 TupleLibrary".### Upgrading from 1.4.0 or Earlier ###On platforms where the pthread library is available, Google Test andGoogle Mock use it in order to be thread-safe.  For this to work, youmay need to tweak your compiler and/or linker flags.  Please see the"Multi-threaded Tests" section in file ${GTEST_DIR}/README for whatyou may need to do.If you have custom matchers defined using MatcherInterface orMakePolymorphicMatcher(), you'll need to update their definitions touse the new matcher API [2].  Matchers defined using MATCHER() orMATCHER_P*() aren't affected.  [2]http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Monomorphic_Matchers,http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Polymorphic_MatchersDeveloping Google Mock----------------------This section discusses how to make your own changes to Google Mock.### Testing Google Mock Itself ###To make sure your changes work as intended and don't break existingfunctionality, you'll want to compile and run Google Test's own tests.For that you'll need Autotools.  First, make sure you have followedthe instructions in section "SVN Checkout" to configure Google Mock.Then, create a build output directory and enter it.  Next,  ${GMOCK_DIR}/configure  # Standard GNU configure script, --help for more infoOnce you have successfully configured Google Mock, the build steps arestandard for GNU-style OSS packages.  make        # Standard makefile following GNU conventions  make check  # Builds and runs all tests - all should pass.Note that when building your project against Google Mock, you are buildingagainst Google Test as well.  There is no need to configure Google Testseparately.### Regenerating Source Files ###Some of Google Mock's source files are generated from templates (notin the C++ sense) using a script.  A template file is named FOO.pump,where FOO is the name of the file it will generate.  For example, thefile include/gmock/gmock-generated-actions.h.pump is used to generategmock-generated-actions.h in the same directory.Normally you don't need to worry about regenerating the source files,unless you need to modify them.  In that case, you should modify thecorresponding .pump files instead and run the 'pump' script (for Pumpis Useful for Meta Programming) to regenerate them.  You can findpump.py in the ${GTEST_DIR}/scripts/ directory.  Read the Pump manual[3] for how to use it.  [3]http://code.google.com/p/googletest/wiki/PumpManual.### Contributing a Patch ###We welcome patches.  Please read the Google Mock developer's guide [4]for how you can contribute.  In particular, make sure you have signedthe Contributor License Agreement, or we won't be able to accept thepatch.  [4]http://code.google.com/p/googlemock/wiki/DevGuideHappy testing!