Wed, 31 Dec 2014 07:53:36 +0100
Correct small whitespace inconsistency, lost while renaming variables.
1 # Defines functions and macros useful for building Google Test and
2 # Google Mock.
3 #
4 # Note:
5 #
6 # - This file will be run twice when building Google Mock (once via
7 # Google Test's CMakeLists.txt, and once via Google Mock's).
8 # Therefore it shouldn't have any side effects other than defining
9 # the functions and macros.
10 #
11 # - The functions/macros defined in this file may depend on Google
12 # Test and Google Mock's option() definitions, and thus must be
13 # called *after* the options have been defined.
15 # Tweaks CMake's default compiler/linker settings to suit Google Test's needs.
16 #
17 # This must be a macro(), as inside a function string() can only
18 # update variables in the function scope.
19 macro(fix_default_compiler_settings_)
20 if (MSVC)
21 # For MSVC, CMake sets certain flags to defaults we want to override.
22 # This replacement code is taken from sample in the CMake Wiki at
23 # http://www.cmake.org/Wiki/CMake_FAQ#Dynamic_Replace.
24 foreach (flag_var
25 CMAKE_CXX_FLAGS CMAKE_CXX_FLAGS_DEBUG CMAKE_CXX_FLAGS_RELEASE
26 CMAKE_CXX_FLAGS_MINSIZEREL CMAKE_CXX_FLAGS_RELWITHDEBINFO)
27 if (NOT BUILD_SHARED_LIBS AND NOT gtest_force_shared_crt)
28 # When Google Test is built as a shared library, it should also use
29 # shared runtime libraries. Otherwise, it may end up with multiple
30 # copies of runtime library data in different modules, resulting in
31 # hard-to-find crashes. When it is built as a static library, it is
32 # preferable to use CRT as static libraries, as we don't have to rely
33 # on CRT DLLs being available. CMake always defaults to using shared
34 # CRT libraries, so we override that default here.
35 string(REPLACE "/MD" "-MT" ${flag_var} "${${flag_var}}")
36 endif()
38 # We prefer more strict warning checking for building Google Test.
39 # Replaces /W3 with /W4 in defaults.
40 string(REPLACE "/W3" "-W4" ${flag_var} "${${flag_var}}")
41 endforeach()
42 endif()
43 endmacro()
45 # Defines the compiler/linker flags used to build Google Test and
46 # Google Mock. You can tweak these definitions to suit your need. A
47 # variable's value is empty before it's explicitly assigned to.
48 macro(config_compiler_and_linker)
49 if (NOT gtest_disable_pthreads)
50 # Defines CMAKE_USE_PTHREADS_INIT and CMAKE_THREAD_LIBS_INIT.
51 find_package(Threads)
52 endif()
54 fix_default_compiler_settings_()
55 if (MSVC)
56 # Newlines inside flags variables break CMake's NMake generator.
57 # TODO(vladl@google.com): Add -RTCs and -RTCu to debug builds.
58 set(cxx_base_flags "-GS -W4 -WX -wd4127 -wd4251 -wd4275 -nologo -J -Zi")
59 if (MSVC_VERSION LESS 1400)
60 # Suppress spurious warnings MSVC 7.1 sometimes issues.
61 # Forcing value to bool.
62 set(cxx_base_flags "${cxx_base_flags} -wd4800")
63 # Copy constructor and assignment operator could not be generated.
64 set(cxx_base_flags "${cxx_base_flags} -wd4511 -wd4512")
65 # Compatibility warnings not applicable to Google Test.
66 # Resolved overload was found by argument-dependent lookup.
67 set(cxx_base_flags "${cxx_base_flags} -wd4675")
68 endif()
69 set(cxx_base_flags "${cxx_base_flags} -D_UNICODE -DUNICODE -DWIN32 -D_WIN32")
70 set(cxx_base_flags "${cxx_base_flags} -DSTRICT -DWIN32_LEAN_AND_MEAN")
71 set(cxx_exception_flags "-EHsc -D_HAS_EXCEPTIONS=1")
72 set(cxx_no_exception_flags "-D_HAS_EXCEPTIONS=0")
73 set(cxx_no_rtti_flags "-GR-")
74 elseif (CMAKE_COMPILER_IS_GNUCXX)
75 set(cxx_base_flags "-Wall -Wshadow")
76 set(cxx_exception_flags "-fexceptions")
77 set(cxx_no_exception_flags "-fno-exceptions")
78 # Until version 4.3.2, GCC doesn't define a macro to indicate
79 # whether RTTI is enabled. Therefore we define GTEST_HAS_RTTI
80 # explicitly.
81 set(cxx_no_rtti_flags "-fno-rtti -DGTEST_HAS_RTTI=0")
82 set(cxx_strict_flags
83 "-Wextra -Wno-unused-parameter -Wno-missing-field-initializers")
84 elseif (CMAKE_CXX_COMPILER_ID STREQUAL "SunPro")
85 set(cxx_exception_flags "-features=except")
86 # Sun Pro doesn't provide macros to indicate whether exceptions and
87 # RTTI are enabled, so we define GTEST_HAS_* explicitly.
88 set(cxx_no_exception_flags "-features=no%except -DGTEST_HAS_EXCEPTIONS=0")
89 set(cxx_no_rtti_flags "-features=no%rtti -DGTEST_HAS_RTTI=0")
90 elseif (CMAKE_CXX_COMPILER_ID STREQUAL "VisualAge" OR
91 CMAKE_CXX_COMPILER_ID STREQUAL "XL")
92 # CMake 2.8 changes Visual Age's compiler ID to "XL".
93 set(cxx_exception_flags "-qeh")
94 set(cxx_no_exception_flags "-qnoeh")
95 # Until version 9.0, Visual Age doesn't define a macro to indicate
96 # whether RTTI is enabled. Therefore we define GTEST_HAS_RTTI
97 # explicitly.
98 set(cxx_no_rtti_flags "-qnortti -DGTEST_HAS_RTTI=0")
99 elseif (CMAKE_CXX_COMPILER_ID STREQUAL "HP")
100 set(cxx_base_flags "-AA -mt")
101 set(cxx_exception_flags "-DGTEST_HAS_EXCEPTIONS=1")
102 set(cxx_no_exception_flags "+noeh -DGTEST_HAS_EXCEPTIONS=0")
103 # RTTI can not be disabled in HP aCC compiler.
104 set(cxx_no_rtti_flags "")
105 endif()
107 if (CMAKE_USE_PTHREADS_INIT) # The pthreads library is available and allowed.
108 set(cxx_base_flags "${cxx_base_flags} -DGTEST_HAS_PTHREAD=1")
109 else()
110 set(cxx_base_flags "${cxx_base_flags} -DGTEST_HAS_PTHREAD=0")
111 endif()
113 # For building gtest's own tests and samples.
114 set(cxx_exception "${CMAKE_CXX_FLAGS} ${cxx_base_flags} ${cxx_exception_flags}")
115 set(cxx_no_exception
116 "${CMAKE_CXX_FLAGS} ${cxx_base_flags} ${cxx_no_exception_flags}")
117 set(cxx_default "${cxx_exception}")
118 set(cxx_no_rtti "${cxx_default} ${cxx_no_rtti_flags}")
119 set(cxx_use_own_tuple "${cxx_default} -DGTEST_USE_OWN_TR1_TUPLE=1")
121 # For building the gtest libraries.
122 set(cxx_strict "${cxx_default} ${cxx_strict_flags}")
123 endmacro()
125 # Defines the gtest & gtest_main libraries. User tests should link
126 # with one of them.
127 function(cxx_library_with_type name type cxx_flags)
128 # type can be either STATIC or SHARED to denote a static or shared library.
129 # ARGN refers to additional arguments after 'cxx_flags'.
130 add_library(${name} ${type} ${ARGN})
131 set_target_properties(${name}
132 PROPERTIES
133 COMPILE_FLAGS "${cxx_flags}")
134 if (BUILD_SHARED_LIBS OR type STREQUAL "SHARED")
135 set_target_properties(${name}
136 PROPERTIES
137 COMPILE_DEFINITIONS "GTEST_CREATE_SHARED_LIBRARY=1")
138 endif()
139 if (CMAKE_USE_PTHREADS_INIT)
140 target_link_libraries(${name} ${CMAKE_THREAD_LIBS_INIT})
141 endif()
142 endfunction()
144 ########################################################################
145 #
146 # Helper functions for creating build targets.
148 function(cxx_shared_library name cxx_flags)
149 cxx_library_with_type(${name} SHARED "${cxx_flags}" ${ARGN})
150 endfunction()
152 function(cxx_library name cxx_flags)
153 cxx_library_with_type(${name} "" "${cxx_flags}" ${ARGN})
154 endfunction()
156 # cxx_executable_with_flags(name cxx_flags libs srcs...)
157 #
158 # creates a named C++ executable that depends on the given libraries and
159 # is built from the given source files with the given compiler flags.
160 function(cxx_executable_with_flags name cxx_flags libs)
161 add_executable(${name} ${ARGN})
162 if (cxx_flags)
163 set_target_properties(${name}
164 PROPERTIES
165 COMPILE_FLAGS "${cxx_flags}")
166 endif()
167 if (BUILD_SHARED_LIBS)
168 set_target_properties(${name}
169 PROPERTIES
170 COMPILE_DEFINITIONS "GTEST_LINKED_AS_SHARED_LIBRARY=1")
171 endif()
172 # To support mixing linking in static and dynamic libraries, link each
173 # library in with an extra call to target_link_libraries.
174 foreach (lib "${libs}")
175 target_link_libraries(${name} ${lib})
176 endforeach()
177 endfunction()
179 # cxx_executable(name dir lib srcs...)
180 #
181 # creates a named target that depends on the given libs and is built
182 # from the given source files. dir/name.cc is implicitly included in
183 # the source file list.
184 function(cxx_executable name dir libs)
185 cxx_executable_with_flags(
186 ${name} "${cxx_default}" "${libs}" "${dir}/${name}.cc" ${ARGN})
187 endfunction()
189 # Sets PYTHONINTERP_FOUND and PYTHON_EXECUTABLE.
190 find_package(PythonInterp)
192 # cxx_test_with_flags(name cxx_flags libs srcs...)
193 #
194 # creates a named C++ test that depends on the given libs and is built
195 # from the given source files with the given compiler flags.
196 function(cxx_test_with_flags name cxx_flags libs)
197 cxx_executable_with_flags(${name} "${cxx_flags}" "${libs}" ${ARGN})
198 add_test(${name} ${name})
199 endfunction()
201 # cxx_test(name libs srcs...)
202 #
203 # creates a named test target that depends on the given libs and is
204 # built from the given source files. Unlike cxx_test_with_flags,
205 # test/name.cc is already implicitly included in the source file list.
206 function(cxx_test name libs)
207 cxx_test_with_flags("${name}" "${cxx_default}" "${libs}"
208 "test/${name}.cc" ${ARGN})
209 endfunction()
211 # py_test(name)
212 #
213 # creates a Python test with the given name whose main module is in
214 # test/name.py. It does nothing if Python is not installed.
215 function(py_test name)
216 # We are not supporting Python tests on Linux yet as they consider
217 # all Linux environments to be google3 and try to use google3 features.
218 if (PYTHONINTERP_FOUND)
219 # ${CMAKE_BINARY_DIR} is known at configuration time, so we can
220 # directly bind it from cmake. ${CTEST_CONFIGURATION_TYPE} is known
221 # only at ctest runtime (by calling ctest -c <Configuration>), so
222 # we have to escape $ to delay variable substitution here.
223 add_test(${name}
224 ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test/${name}.py
225 --build_dir=${CMAKE_CURRENT_BINARY_DIR}/\${CTEST_CONFIGURATION_TYPE})
226 endif()
227 endfunction()