blob: 01fd463dda7f4c944300508d3ff6ee182144b7dc [file] [log] [blame]
shiqiane35fdd92008-12-10 05:08:54 +00001
2The Google Mock class generator is an application that is part of cppclean.
Gennadiy Civil8977af02018-05-23 11:49:11 -04003For more information about cppclean, visit http://code.google.com/p/cppclean/
shiqiane35fdd92008-12-10 05:08:54 +00004
Gennadiy Civil8977af02018-05-23 11:49:11 -04005The mock generator requires Python 2.3.5 or later. If you don't have Python
6installed on your system, you will also need to install it. You can download
7Python from: http://www.python.org/download/releases/
shiqiane35fdd92008-12-10 05:08:54 +00008
9To use the Google Mock class generator, you need to call it
10on the command line passing the header file and class for which you want
11to generate a Google Mock class.
12
13Make sure to install the scripts somewhere in your path. Then you can
14run the program.
15
zhanyong.wan84b8e4c2009-05-07 20:38:25 +000016 gmock_gen.py header-file.h [ClassName]...
nnorwitzce607842009-05-06 05:57:09 +000017
18If no ClassNames are specified, all classes in the file are emitted.
shiqiane35fdd92008-12-10 05:08:54 +000019
20To change the indentation from the default of 2, set INDENT in
21the environment. For example to use an indent of 4 spaces:
22
23INDENT=4 gmock_gen.py header-file.h ClassName
24
zhanyong.wanb8243162009-06-04 05:48:20 +000025This version was made from SVN revision 281 in the cppclean repository.
shiqiane35fdd92008-12-10 05:08:54 +000026
27Known Limitations
28-----------------
29Not all code will be generated properly. For example, when mocking templated
30classes, the template information is lost. You will need to add the template
31information manually.
32
33Not all permutations of using multiple pointers/references will be rendered
34properly. These will also have to be fixed manually.