# Function for setting up precompiled headers. Usage: # # add_library/executable(target # pchheader.c pchheader.cpp pchheader.h) # # add_precompiled_header(target pchheader.h # [FORCEINCLUDE] # [SOURCE_C pchheader.c] # [SOURCE_CXX pchheader.cpp]) # # Options: # # FORCEINCLUDE: Add compiler flags to automatically include the # pchheader.h from every source file. Works with both GCC and # MSVC. This is recommended. # # SOURCE_C/CXX: Specifies the .c/.cpp source file that includes # pchheader.h for generating the pre-compiled header # output. Defaults to pchheader.c. Only required for MSVC. # # Caveats: # # * Its not currently possible to use the same precompiled-header in # more than a single target in the same directory (No way to set # the source file properties differently for each target). # # * MSVC: A source file with the same name as the header must exist # and be included in the target (E.g. header.cpp). Name of file # can be changed using the SOURCE_CXX/SOURCE_C options. # # License: # # Copyright (C) 2009-2017 Lars Christensen # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the 'Software') deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. # Use the new builtin CMake function if possible or fall back to the old one. if (CMAKE_VERSION VERSION_LESS 3.16) include(CMakeParseArguments) macro(combine_arguments _variable) set(_result "") foreach(_element ${${_variable}}) set(_result "${_result} \"${_element}\"") endforeach() string(STRIP "${_result}" _result) set(${_variable} "${_result}") endmacro() function(export_all_flags _filename) set(_include_directories "$") set(_compile_definitions "$") set(_compile_flags "$") set(_compile_options "$") #handle config-specific cxx flags string(TOUPPER ${CMAKE_BUILD_TYPE} _config) set(_build_cxx_flags ${CMAKE_CXX_FLAGS_${_config}}) #handle fpie option get_target_property(_fpie ${_target} POSITION_INDEPENDENT_CODE) if (_fpie AND CMAKE_POSITION_INDEPENDENT_CODE) list(APPEND _compile_options ${CMAKE_CXX_COMPILE_OPTIONS_PIC}) endif() #handle compiler standard (GCC only) if(CMAKE_COMPILER_IS_GNUCXX) get_target_property(_cxx_standard ${_target} CXX_STANDARD) if ((NOT "${_cxx_standard}" STREQUAL NOTFOUND) AND (NOT "${_cxx_standard}" STREQUAL "")) get_target_property(_cxx_extensions ${_target} CXX_EXTENSIONS) get_property(_exists TARGET ${_target} PROPERTY CXX_EXTENSIONS SET) if (NOT _exists OR ${_cxx_extensions}) list(APPEND _compile_options "-std=gnu++${_cxx_standard}") else() list(APPEND _compile_options "-std=c++${_cxx_standard}") endif() endif() endif() set(_include_directories "$<$:-I$\n>") set(_compile_definitions "$<$:-D$\n>") set(_compile_flags "$<$:$\n>") set(_compile_options "$<$:$\n>") set(_cxx_flags "$<$:${CMAKE_CXX_FLAGS}\n>$<$:${_build_cxx_flags}\n>") file(GENERATE OUTPUT "${_filename}" CONTENT "${_compile_definitions}${_include_directories}${_compile_flags}${_compile_options}${_cxx_flags}\n") endfunction() function(add_precompiled_header _target _input) message(STATUS "Adding precompiled header ${_input} to target ${_target} with legacy method. " "Update your cmake instance to use the native PCH functions.") cmake_parse_arguments(_PCH "FORCEINCLUDE" "SOURCE_CXX;SOURCE_C" "" ${ARGN}) get_filename_component(_input_we ${_input} NAME_WE) get_filename_component(_input_full ${_input} ABSOLUTE) file(TO_NATIVE_PATH "${_input_full}" _input_fullpath) if(NOT _PCH_SOURCE_CXX) set(_PCH_SOURCE_CXX "${_input_we}.cpp") endif() if(NOT _PCH_SOURCE_C) set(_PCH_SOURCE_C "${_input_we}.c") endif() if(MSVC) set(_pch_cxx_pch "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/cxx_${_input_we}.pch") set(_pch_c_pch "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/c_${_input_we}.pch") get_target_property(sources ${_target} SOURCES) foreach(_source ${sources}) set(_pch_compile_flags "") if(_source MATCHES \\.\(cc|cxx|cpp|c\)$) if(_source MATCHES \\.\(cpp|cxx|cc\)$) set(_pch_header "${_input}") set(_pch "${_pch_cxx_pch}") else() set(_pch_header "${_input}") set(_pch "${_pch_c_pch}") endif() if(_source STREQUAL "${_PCH_SOURCE_CXX}") set(_pch_compile_flags "${_pch_compile_flags} \"/Fp${_pch_cxx_pch}\" \"/Yc${_input}\"") set(_pch_source_cxx_found TRUE) set_source_files_properties("${_source}" PROPERTIES OBJECT_OUTPUTS "${_pch_cxx_pch}") elseif(_source STREQUAL "${_PCH_SOURCE_C}") set(_pch_compile_flags "${_pch_compile_flags} \"/Fp${_pch_c_pch}\" \"/Yc${_input}\"") set(_pch_source_c_found TRUE) set_source_files_properties("${_source}" PROPERTIES OBJECT_OUTPUTS "${_pch_c_pch}") else() if(_source MATCHES \\.\(cpp|cxx|cc\)$) set(_pch_compile_flags "${_pch_compile_flags} \"/Fp${_pch_cxx_pch}\" \"/Yu${_input_fullpath}\"") set(_pch_source_cxx_needed TRUE) set_source_files_properties("${_source}" PROPERTIES OBJECT_DEPENDS "${_pch_cxx_pch}") else() set(_pch_compile_flags "${_pch_compile_flags} \"/Fp${_pch_c_pch}\" \"/Yu${_input_fullpath}\"") set(_pch_source_c_needed TRUE) set_source_files_properties("${_source}" PROPERTIES OBJECT_DEPENDS "${_pch_c_pch}") endif() if(_PCH_FORCEINCLUDE) set(_pch_compile_flags "${_pch_compile_flags} /FI${_input_fullpath}") endif(_PCH_FORCEINCLUDE) endif() get_source_file_property(_object_depends "${_source}" OBJECT_DEPENDS) if(NOT _object_depends) set(_object_depends) endif() if(_PCH_FORCEINCLUDE) list(APPEND _object_depends "${CMAKE_CURRENT_SOURCE_DIR}/${_pch_header}") endif() set_source_files_properties(${_source} PROPERTIES COMPILE_FLAGS "${_pch_compile_flags}" OBJECT_DEPENDS "${_object_depends}") endif() endforeach() if(_pch_source_cxx_needed AND NOT _pch_source_cxx_found) message(FATAL_ERROR "A source file ${_PCH_SOURCE_CXX} for ${_input} is required for MSVC builds. Can be set with the SOURCE_CXX option.") endif() if(_pch_source_c_needed AND NOT _pch_source_c_found) message(FATAL_ERROR "A source file ${_PCH_SOURCE_C} for ${_input} is required for MSVC builds. Can be set with the SOURCE_C option.") endif() endif(MSVC) if(CMAKE_COMPILER_IS_GNUCXX) get_filename_component(_name ${_input} NAME) set(_pch_header "${CMAKE_CURRENT_SOURCE_DIR}/${_input}") set(_pch_binary_dir "${CMAKE_CURRENT_BINARY_DIR}/${_target}_pch") set(_pchfile "${_pch_binary_dir}/${_input}") set(_outdir "${CMAKE_CURRENT_BINARY_DIR}/${_target}_pch/${_name}.gch") file(MAKE_DIRECTORY "${_outdir}") set(_output_cxx "${_outdir}/.c++") set(_output_c "${_outdir}/.c") set(_pch_flags_file "${_pch_binary_dir}/compile_flags.rsp") export_all_flags("${_pch_flags_file}") set(_compiler_FLAGS "@${_pch_flags_file}") add_custom_command( OUTPUT "${_pchfile}" COMMAND "${CMAKE_COMMAND}" -E copy "${_pch_header}" "${_pchfile}" DEPENDS "${_pch_header}" COMMENT "Updating ${_name}") add_custom_command( OUTPUT "${_output_cxx}" COMMAND "${CMAKE_CXX_COMPILER}" ${_compiler_FLAGS} -x c++-header -o "${_output_cxx}" "${_pchfile}" DEPENDS "${_pchfile}" "${_pch_flags_file}" COMMENT "Precompiling ${_name} for ${_target} (C++)") add_custom_command( OUTPUT "${_output_c}" COMMAND "${CMAKE_C_COMPILER}" ${_compiler_FLAGS} -x c-header -o "${_output_c}" "${_pchfile}" DEPENDS "${_pchfile}" "${_pch_flags_file}" COMMENT "Precompiling ${_name} for ${_target} (C)") get_property(_sources TARGET ${_target} PROPERTY SOURCES) foreach(_source ${_sources}) set(_pch_compile_flags "") if(_source MATCHES \\.\(cc|cxx|cpp|c\)$) get_source_file_property(_pch_compile_flags "${_source}" COMPILE_FLAGS) if(NOT _pch_compile_flags) set(_pch_compile_flags) endif() separate_arguments(_pch_compile_flags) list(APPEND _pch_compile_flags -Winvalid-pch) if(_PCH_FORCEINCLUDE) list(APPEND _pch_compile_flags -include "${_pchfile}") else(_PCH_FORCEINCLUDE) list(APPEND _pch_compile_flags "-I${_pch_binary_dir}") endif(_PCH_FORCEINCLUDE) get_source_file_property(_object_depends "${_source}" OBJECT_DEPENDS) if(NOT _object_depends) set(_object_depends) endif() list(APPEND _object_depends "${_pchfile}") if(_source MATCHES \\.\(cc|cxx|cpp\)$) list(APPEND _object_depends "${_output_cxx}") else() list(APPEND _object_depends "${_output_c}") endif() combine_arguments(_pch_compile_flags) set_source_files_properties(${_source} PROPERTIES COMPILE_FLAGS "${_pch_compile_flags}" OBJECT_DEPENDS "${_object_depends}") endif() endforeach() endif(CMAKE_COMPILER_IS_GNUCXX) endfunction() else () function(add_precompiled_header _target _input) message(STATUS "Adding precompiled header ${_input} to target ${_target}.") target_precompile_headers(${_target} PRIVATE ${_input}) get_target_property(_sources ${_target} SOURCES) list(FILTER _sources INCLUDE REGEX ".*\\.mm?") if (_sources) message(STATUS "PCH skipping sources: ${_sources}") endif () set_source_files_properties(${_sources} PROPERTIES SKIP_PRECOMPILE_HEADERS ON) endfunction() endif (CMAKE_VERSION VERSION_LESS 3.16)