PrecompiledHeader.cmake 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. # Function for setting up precompiled headers. Usage:
  2. #
  3. # add_library/executable(target
  4. # pchheader.c pchheader.cpp pchheader.h)
  5. #
  6. # add_precompiled_header(target pchheader.h
  7. # [FORCEINCLUDE]
  8. # [SOURCE_C pchheader.c]
  9. # [SOURCE_CXX pchheader.cpp])
  10. #
  11. # Options:
  12. #
  13. # FORCEINCLUDE: Add compiler flags to automatically include the
  14. # pchheader.h from every source file. Works with both GCC and
  15. # MSVC. This is recommended.
  16. #
  17. # SOURCE_C/CXX: Specifies the .c/.cpp source file that includes
  18. # pchheader.h for generating the pre-compiled header
  19. # output. Defaults to pchheader.c. Only required for MSVC.
  20. #
  21. # Caveats:
  22. #
  23. # * Its not currently possible to use the same precompiled-header in
  24. # more than a single target in the same directory (No way to set
  25. # the source file properties differently for each target).
  26. #
  27. # * MSVC: A source file with the same name as the header must exist
  28. # and be included in the target (E.g. header.cpp). Name of file
  29. # can be changed using the SOURCE_CXX/SOURCE_C options.
  30. #
  31. # License:
  32. #
  33. # Copyright (C) 2009-2017 Lars Christensen <larsch@belunktum.dk>
  34. #
  35. # Permission is hereby granted, free of charge, to any person
  36. # obtaining a copy of this software and associated documentation files
  37. # (the 'Software') deal in the Software without restriction,
  38. # including without limitation the rights to use, copy, modify, merge,
  39. # publish, distribute, sublicense, and/or sell copies of the Software,
  40. # and to permit persons to whom the Software is furnished to do so,
  41. # subject to the following conditions:
  42. #
  43. # The above copyright notice and this permission notice shall be
  44. # included in all copies or substantial portions of the Software.
  45. #
  46. # THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
  47. # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  48. # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  49. # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  50. # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  51. # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  52. # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  53. # SOFTWARE.
  54. include(CMakeParseArguments)
  55. macro(combine_arguments _variable)
  56. set(_result "")
  57. foreach(_element ${${_variable}})
  58. set(_result "${_result} \"${_element}\"")
  59. endforeach()
  60. string(STRIP "${_result}" _result)
  61. set(${_variable} "${_result}")
  62. endmacro()
  63. function(export_all_flags _filename)
  64. set(_include_directories "$<TARGET_PROPERTY:${_target},INCLUDE_DIRECTORIES>")
  65. set(_compile_definitions "$<TARGET_PROPERTY:${_target},COMPILE_DEFINITIONS>")
  66. set(_compile_flags "$<TARGET_PROPERTY:${_target},COMPILE_FLAGS>")
  67. set(_compile_options "$<TARGET_PROPERTY:${_target},COMPILE_OPTIONS>")
  68. #handle config-specific cxx flags
  69. string(TOUPPER ${CMAKE_BUILD_TYPE} _config)
  70. set(_build_cxx_flags ${CMAKE_CXX_FLAGS_${_config}})
  71. #handle fpie option
  72. get_target_property(_fpie ${_target} POSITION_INDEPENDENT_CODE)
  73. if (_fpie AND CMAKE_POSITION_INDEPENDENT_CODE)
  74. list(APPEND _compile_options ${CMAKE_CXX_COMPILE_OPTIONS_PIC})
  75. endif()
  76. #handle compiler standard (GCC only)
  77. if(CMAKE_COMPILER_IS_GNUCXX)
  78. get_target_property(_cxx_standard ${_target} CXX_STANDARD)
  79. if ((NOT "${_cxx_standard}" STREQUAL NOTFOUND) AND (NOT "${_cxx_standard}" STREQUAL ""))
  80. get_target_property(_cxx_extensions ${_target} CXX_EXTENSIONS)
  81. get_property(_exists TARGET ${_target} PROPERTY CXX_EXTENSIONS SET)
  82. if (NOT _exists OR ${_cxx_extensions})
  83. list(APPEND _compile_options "-std=gnu++${_cxx_standard}")
  84. else()
  85. list(APPEND _compile_options "-std=c++${_cxx_standard}")
  86. endif()
  87. endif()
  88. endif()
  89. set(_include_directories "$<$<BOOL:${_include_directories}>:-I$<JOIN:${_include_directories},\n-I>\n>")
  90. set(_compile_definitions "$<$<BOOL:${_compile_definitions}>:-D$<JOIN:${_compile_definitions},\n-D>\n>")
  91. set(_compile_flags "$<$<BOOL:${_compile_flags}>:$<JOIN:${_compile_flags},\n>\n>")
  92. set(_compile_options "$<$<BOOL:${_compile_options}>:$<JOIN:${_compile_options},\n>\n>")
  93. set(_cxx_flags "$<$<BOOL:${CMAKE_CXX_FLAGS}>:${CMAKE_CXX_FLAGS}\n>$<$<BOOL:${_build_cxx_flags}>:${_build_cxx_flags}\n>")
  94. file(GENERATE OUTPUT "${_filename}" CONTENT "${_compile_definitions}${_include_directories}${_compile_flags}${_compile_options}${_cxx_flags}\n")
  95. endfunction()
  96. function(add_precompiled_header _target _input)
  97. cmake_parse_arguments(_PCH "FORCEINCLUDE" "SOURCE_CXX;SOURCE_C" "" ${ARGN})
  98. get_filename_component(_input_we ${_input} NAME_WE)
  99. get_filename_component(_input_full ${_input} ABSOLUTE)
  100. file(TO_NATIVE_PATH "${_input_full}" _input_fullpath)
  101. if(NOT _PCH_SOURCE_CXX)
  102. set(_PCH_SOURCE_CXX "${_input_we}.cpp")
  103. endif()
  104. if(NOT _PCH_SOURCE_C)
  105. set(_PCH_SOURCE_C "${_input_we}.c")
  106. endif()
  107. if(MSVC)
  108. set(_pch_cxx_pch "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/cxx_${_input_we}.pch")
  109. set(_pch_c_pch "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/c_${_input_we}.pch")
  110. get_target_property(sources ${_target} SOURCES)
  111. foreach(_source ${sources})
  112. set(_pch_compile_flags "")
  113. if(_source MATCHES \\.\(cc|cxx|cpp|c\)$)
  114. if(_source MATCHES \\.\(cpp|cxx|cc\)$)
  115. set(_pch_header "${_input}")
  116. set(_pch "${_pch_cxx_pch}")
  117. else()
  118. set(_pch_header "${_input}")
  119. set(_pch "${_pch_c_pch}")
  120. endif()
  121. if(_source STREQUAL "${_PCH_SOURCE_CXX}")
  122. set(_pch_compile_flags "${_pch_compile_flags} \"/Fp${_pch_cxx_pch}\" \"/Yc${_input}\"")
  123. set(_pch_source_cxx_found TRUE)
  124. set_source_files_properties("${_source}" PROPERTIES OBJECT_OUTPUTS "${_pch_cxx_pch}")
  125. elseif(_source STREQUAL "${_PCH_SOURCE_C}")
  126. set(_pch_compile_flags "${_pch_compile_flags} \"/Fp${_pch_c_pch}\" \"/Yc${_input}\"")
  127. set(_pch_source_c_found TRUE)
  128. set_source_files_properties("${_source}" PROPERTIES OBJECT_OUTPUTS "${_pch_c_pch}")
  129. else()
  130. if(_source MATCHES \\.\(cpp|cxx|cc\)$)
  131. set(_pch_compile_flags "${_pch_compile_flags} \"/Fp${_pch_cxx_pch}\" \"/Yu${_input_fullpath}\"")
  132. set(_pch_source_cxx_needed TRUE)
  133. set_source_files_properties("${_source}" PROPERTIES OBJECT_DEPENDS "${_pch_cxx_pch}")
  134. else()
  135. set(_pch_compile_flags "${_pch_compile_flags} \"/Fp${_pch_c_pch}\" \"/Yu${_input_fullpath}\"")
  136. set(_pch_source_c_needed TRUE)
  137. set_source_files_properties("${_source}" PROPERTIES OBJECT_DEPENDS "${_pch_c_pch}")
  138. endif()
  139. if(_PCH_FORCEINCLUDE)
  140. set(_pch_compile_flags "${_pch_compile_flags} /FI${_input_fullpath}")
  141. endif(_PCH_FORCEINCLUDE)
  142. endif()
  143. get_source_file_property(_object_depends "${_source}" OBJECT_DEPENDS)
  144. if(NOT _object_depends)
  145. set(_object_depends)
  146. endif()
  147. if(_PCH_FORCEINCLUDE)
  148. list(APPEND _object_depends "${CMAKE_CURRENT_SOURCE_DIR}/${_pch_header}")
  149. endif()
  150. set_source_files_properties(${_source} PROPERTIES
  151. COMPILE_FLAGS "${_pch_compile_flags}"
  152. OBJECT_DEPENDS "${_object_depends}")
  153. endif()
  154. endforeach()
  155. if(_pch_source_cxx_needed AND NOT _pch_source_cxx_found)
  156. message(FATAL_ERROR "A source file ${_PCH_SOURCE_CXX} for ${_input} is required for MSVC builds. Can be set with the SOURCE_CXX option.")
  157. endif()
  158. if(_pch_source_c_needed AND NOT _pch_source_c_found)
  159. message(FATAL_ERROR "A source file ${_PCH_SOURCE_C} for ${_input} is required for MSVC builds. Can be set with the SOURCE_C option.")
  160. endif()
  161. endif(MSVC)
  162. if(CMAKE_COMPILER_IS_GNUCXX)
  163. get_filename_component(_name ${_input} NAME)
  164. set(_pch_header "${CMAKE_CURRENT_SOURCE_DIR}/${_input}")
  165. set(_pch_binary_dir "${CMAKE_CURRENT_BINARY_DIR}/${_target}_pch")
  166. set(_pchfile "${_pch_binary_dir}/${_input}")
  167. set(_outdir "${CMAKE_CURRENT_BINARY_DIR}/${_target}_pch/${_name}.gch")
  168. file(MAKE_DIRECTORY "${_outdir}")
  169. set(_output_cxx "${_outdir}/.c++")
  170. set(_output_c "${_outdir}/.c")
  171. set(_pch_flags_file "${_pch_binary_dir}/compile_flags.rsp")
  172. export_all_flags("${_pch_flags_file}")
  173. set(_compiler_FLAGS "@${_pch_flags_file}")
  174. add_custom_command(
  175. OUTPUT "${_pchfile}"
  176. COMMAND "${CMAKE_COMMAND}" -E copy "${_pch_header}" "${_pchfile}"
  177. DEPENDS "${_pch_header}"
  178. COMMENT "Updating ${_name}")
  179. add_custom_command(
  180. OUTPUT "${_output_cxx}"
  181. COMMAND "${CMAKE_CXX_COMPILER}" ${_compiler_FLAGS} -x c++-header -o "${_output_cxx}" "${_pchfile}"
  182. DEPENDS "${_pchfile}" "${_pch_flags_file}"
  183. COMMENT "Precompiling ${_name} for ${_target} (C++)")
  184. add_custom_command(
  185. OUTPUT "${_output_c}"
  186. COMMAND "${CMAKE_C_COMPILER}" ${_compiler_FLAGS} -x c-header -o "${_output_c}" "${_pchfile}"
  187. DEPENDS "${_pchfile}" "${_pch_flags_file}"
  188. COMMENT "Precompiling ${_name} for ${_target} (C)")
  189. get_property(_sources TARGET ${_target} PROPERTY SOURCES)
  190. foreach(_source ${_sources})
  191. set(_pch_compile_flags "")
  192. if(_source MATCHES \\.\(cc|cxx|cpp|c\)$)
  193. get_source_file_property(_pch_compile_flags "${_source}" COMPILE_FLAGS)
  194. if(NOT _pch_compile_flags)
  195. set(_pch_compile_flags)
  196. endif()
  197. separate_arguments(_pch_compile_flags)
  198. list(APPEND _pch_compile_flags -Winvalid-pch)
  199. if(_PCH_FORCEINCLUDE)
  200. list(APPEND _pch_compile_flags -include "${_pchfile}")
  201. else(_PCH_FORCEINCLUDE)
  202. list(APPEND _pch_compile_flags "-I${_pch_binary_dir}")
  203. endif(_PCH_FORCEINCLUDE)
  204. get_source_file_property(_object_depends "${_source}" OBJECT_DEPENDS)
  205. if(NOT _object_depends)
  206. set(_object_depends)
  207. endif()
  208. list(APPEND _object_depends "${_pchfile}")
  209. if(_source MATCHES \\.\(cc|cxx|cpp\)$)
  210. list(APPEND _object_depends "${_output_cxx}")
  211. else()
  212. list(APPEND _object_depends "${_output_c}")
  213. endif()
  214. combine_arguments(_pch_compile_flags)
  215. set_source_files_properties(${_source} PROPERTIES
  216. COMPILE_FLAGS "${_pch_compile_flags}"
  217. OBJECT_DEPENDS "${_object_depends}")
  218. endif()
  219. endforeach()
  220. endif(CMAKE_COMPILER_IS_GNUCXX)
  221. endfunction()