source/build-cmake/cmake/single-build/PrecompiledHeader.cmake

   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
  55 include(CMakeParseArguments)
  56
  57 macro(combine_arguments _variable)
  58   set(_result "")
  59   foreach(_element ${${_variable}})
  60     set(_result "${_result} \"${_element}\"")
  61   endforeach()
  62   string(STRIP "${_result}" _result)
  63   set(${_variable} "${_result}")
  64 endmacro()
  65
  66 function(export_all_flags _filename)
  67   set(_include_directories "$<TARGET_PROPERTY:${_target},INCLUDE_DIRECTORIES>")
  68   set(_compile_definitions "$<TARGET_PROPERTY:${_target},COMPILE_DEFINITIONS>")
  69   set(_compile_flags "$<TARGET_PROPERTY:${_target},COMPILE_FLAGS>")
  70   set(_compile_options "$<TARGET_PROPERTY:${_target},COMPILE_OPTIONS>")
  71   set(_include_directories "$<$<BOOL:${_include_directories}>:-I$<JOIN:${_include_directories},\n-I>\n>")
  72   set(_compile_definitions "$<$<BOOL:${_compile_definitions}>:-D$<JOIN:${_compile_definitions},\n-D>\n>")
  73   set(_compile_flags "$<$<BOOL:${_compile_flags}>:$<JOIN:${_compile_flags},\n>\n>")
  74   set(_compile_options "$<$<BOOL:${_compile_options}>:$<JOIN:${_compile_options},\n>\n>")
  75   file(GENERATE OUTPUT "${_filename}" CONTENT "${_compile_definitions}${_include_directories}${_compile_flags}${_compile_options}\n")
  76 endfunction()
  77
  78 function(add_precompiled_header _target _input)
  79   cmake_parse_arguments(_PCH "FORCEINCLUDE" "SOURCE_CXX;SOURCE_C" "" ${ARGN})
  80
  81   get_filename_component(_input_we ${_input} NAME_WE)
  82   if(NOT _PCH_SOURCE_CXX)
  83     set(_PCH_SOURCE_CXX "${_input_we}.cpp")
  84   endif()
  85   if(NOT _PCH_SOURCE_C)
  86     set(_PCH_SOURCE_C "${_input_we}.c")
  87   endif()
  88
  89   if(MSVC)
  90     set(_pch_cxx_pch "${CMAKE_CFG_INTDIR}/cxx_${_input_we}.pch")
  91     set(_pch_c_pch "${CMAKE_CFG_INTDIR}/c_${_input_we}.pch")
  92
  93     get_target_property(sources ${_target} SOURCES)
  94     foreach(_source ${sources})
  95       set(_pch_compile_flags "")
  96       if(_source MATCHES \\.\(cc|cxx|cpp|c\)$)
  97         if(_source MATCHES \\.\(cpp|cxx|cc\)$)
  98           set(_pch_header "${_input}")
  99           set(_pch "${_pch_cxx_pch}")
 100         else()
 101           set(_pch_header "${_input}")
 102           set(_pch "${_pch_c_pch}")
 103         endif()
 104
 105         if(_source STREQUAL "${_PCH_SOURCE_CXX}")
 106           set(_pch_compile_flags "${_pch_compile_flags} \"/Fp${_pch_cxx_pch}\" \"/Yc${_input}\"")
 107           set(_pch_source_cxx_found TRUE)
 108           set_source_files_properties("${_source}" PROPERTIES OBJECT_OUTPUTS "${_pch_cxx_pch}")
 109         elseif(_source STREQUAL "${_PCH_SOURCE_C}")
 110           set(_pch_compile_flags "${_pch_compile_flags} \"/Fp${_pch_c_pch}\" \"/Yc${_input}\"")
 111           set(_pch_source_c_found TRUE)
 112           set_source_files_properties("${_source}" PROPERTIES OBJECT_OUTPUTS "${_pch_c_pch}")
 113         else()
 114           if(_source MATCHES \\.\(cpp|cxx|cc\)$)
 115             set(_pch_compile_flags "${_pch_compile_flags} \"/Fp${_pch_cxx_pch}\" \"/Yu${_input}\"")
 116             set(_pch_source_cxx_needed TRUE)
 117             set_source_files_properties("${_source}" PROPERTIES OBJECT_DEPENDS "${_pch_cxx_pch}")
 118           else()
 119             set(_pch_compile_flags "${_pch_compile_flags} \"/Fp${_pch_c_pch}\" \"/Yu${_input}\"")
 120             set(_pch_source_c_needed TRUE)
 121             set_source_files_properties("${_source}" PROPERTIES OBJECT_DEPENDS "${_pch_c_pch}")
 122           endif()
 123           if(_PCH_FORCEINCLUDE)
 124             set(_pch_compile_flags "${_pch_compile_flags} /FI${_input}")
 125           endif(_PCH_FORCEINCLUDE)
 126         endif()
 127
 128         get_source_file_property(_object_depends "${_source}" OBJECT_DEPENDS)
 129         if(NOT _object_depends)
 130           set(_object_depends)
 131         endif()
 132         if(_PCH_FORCEINCLUDE)
 133           list(APPEND _object_depends "${CMAKE_CURRENT_SOURCE_DIR}/${_pch_header}")
 134         endif()
 135
 136         set_source_files_properties(${_source} PROPERTIES
 137           COMPILE_FLAGS "${_pch_compile_flags}"
 138           OBJECT_DEPENDS "${_object_depends}")
 139       endif()
 140     endforeach()
 141
 142     if(_pch_source_cxx_needed AND NOT _pch_source_cxx_found)
 143       message(FATAL_ERROR "A source file ${_PCH_SOURCE_CXX} for ${_input} is required for MSVC builds. Can be set with the SOURCE_CXX option.")
 144     endif()
 145     if(_pch_source_c_needed AND NOT _pch_source_c_found)
 146       message(FATAL_ERROR "A source file ${_PCH_SOURCE_C} for ${_input} is required for MSVC builds. Can be set with the SOURCE_C option.")
 147     endif()
 148   endif(MSVC)
 149
 150   if(CMAKE_COMPILER_IS_GNUCXX)
 151     get_filename_component(_name ${_input} NAME)
 152     set(_pch_header "${CMAKE_CURRENT_SOURCE_DIR}/${_input}")
 153     set(_pch_binary_dir "${CMAKE_CURRENT_BINARY_DIR}/${_target}_pch")
 154     set(_pchfile "${_pch_binary_dir}/${_input}")
 155     set(_outdir "${CMAKE_CURRENT_BINARY_DIR}/${_target}_pch/${_name}.gch")
 156     file(MAKE_DIRECTORY "${_outdir}")
 157     set(_output_cxx "${_outdir}/.c++")
 158     set(_output_c "${_outdir}/.c")
 159
 160     set(_pch_flags_file "${_pch_binary_dir}/compile_flags.rsp")
 161     export_all_flags("${_pch_flags_file}")
 162     set(_compiler_FLAGS "@${_pch_flags_file}")
 163     add_custom_command(
 164       OUTPUT "${_pchfile}"
 165       COMMAND "${CMAKE_COMMAND}" -E copy "${_pch_header}" "${_pchfile}"
 166       DEPENDS "${_pch_header}"
 167       COMMENT "Updating ${_name}")
 168     add_custom_command(
 169       OUTPUT "${_output_cxx}"
 170       COMMAND "${CMAKE_CXX_COMPILER}" ${_compiler_FLAGS} -x c++-header -o "${_output_cxx}" "${_pchfile}"
 171       DEPENDS "${_pchfile}" "${_pch_flags_file}"
 172       COMMENT "Precompiling ${_name} for ${_target} (C++)")
 173     add_custom_command(
 174       OUTPUT "${_output_c}"
 175       COMMAND "${CMAKE_C_COMPILER}" ${_compiler_FLAGS} -x c-header -o "${_output_c}" "${_pchfile}"
 176       DEPENDS "${_pchfile}" "${_pch_flags_file}"
 177       COMMENT "Precompiling ${_name} for ${_target} (C)")
 178
 179     get_property(_sources TARGET ${_target} PROPERTY SOURCES)
 180     foreach(_source ${_sources})
 181       set(_pch_compile_flags "")
 182
 183       if(_source MATCHES \\.\(cc|cxx|cpp|c\)$)
 184         get_source_file_property(_pch_compile_flags "${_source}" COMPILE_FLAGS)
 185         if(NOT _pch_compile_flags)
 186           set(_pch_compile_flags)
 187         endif()
 188         separate_arguments(_pch_compile_flags)
 189         list(APPEND _pch_compile_flags -Winvalid-pch)
 190         if(_PCH_FORCEINCLUDE)
 191           list(APPEND _pch_compile_flags -include "${_pchfile}")
 192         else(_PCH_FORCEINCLUDE)
 193           list(APPEND _pch_compile_flags "-I${_pch_binary_dir}")
 194         endif(_PCH_FORCEINCLUDE)
 195
 196         get_source_file_property(_object_depends "${_source}" OBJECT_DEPENDS)
 197         if(NOT _object_depends)
 198           set(_object_depends)
 199         endif()
 200         list(APPEND _object_depends "${_pchfile}")
 201         if(_source MATCHES \\.\(cc|cxx|cpp\)$)
 202           list(APPEND _object_depends "${_output_cxx}")
 203         else()
 204           list(APPEND _object_depends "${_output_c}")
 205         endif()
 206
 207         combine_arguments(_pch_compile_flags)
 208         set_source_files_properties(${_source} PROPERTIES
 209           COMPILE_FLAGS "${_pch_compile_flags}"
 210           OBJECT_DEPENDS "${_object_depends}")
 211       endif()
 212     endforeach()
 213   endif(CMAKE_COMPILER_IS_GNUCXX)
 214 endfunction()