build: IWYU support added

This commit is contained in:
Mateusz Pusz
2021-03-30 13:15:47 +02:00
parent 5251a8a241
commit 01935996e6
8 changed files with 194 additions and 15 deletions

View File

@@ -0,0 +1,142 @@
# The MIT License (MIT)
#
# Copyright (c) 2017 Mateusz Pusz
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to 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.
cmake_minimum_required(VERSION 3.7)
if(NOT CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
# run IWYU only for clang compiler
# other compilers will generate i.e. unknown compilation flags warnings
return()
endif()
set(IWYU_VERBOSITY_LEVEL 3 CACHE STRING "IWYU verbosity level (the higher the level, the more output)")
macro(_find_iwyu)
find_program(_iwyu_path NAMES "include-what-you-use")
if(NOT _iwyu_path)
message(WARNING "'include-what-you-use' executable not found!")
return()
endif()
endmacro()
macro(_iwyu_args_append arg)
list(APPEND _iwyu_args "-Xiwyu" "${arg}")
endmacro()
macro(_iwyu_args_append_if_present option arg)
if(_set_iwyu_${option})
_iwyu_args_append("${arg}")
endif()
endmacro()
macro(_process_iwyu_arguments offset)
set(_options NO_DEFAULT_MAPPINGS PCH_IN_CODE TRANSITIVE_INCLUDES_ONLY NO_COMMENTS NO_FORWARD_DECLARATIONS CXX17_NAMESPACES QUOTED_INCLUDES_FIRST)
set(_one_value_args MAPPING_FILE MAX_LINE_LENGTH)
set(_multi_value_args KEEP)
cmake_parse_arguments(PARSE_ARGV ${offset} _set_iwyu "${_options}" "${_one_value_args}" "${_multi_value_args}")
# validate and process arguments
if(${prefix}_UNPARSED_ARGUMENTS)
message(FATAL_ERROR "Invalid arguments '${${prefix}_UNPARSED_ARGUMENTS}'")
endif()
if(_set_iwyu_KEEP)
foreach(_pattern ${_set_iwyu_KEEP})
_iwyu_args_append("--keep=${_pattern}")
endforeach()
endif()
if(_set_iwyu_MAPPING_FILE)
if(NOT EXISTS ${_set_iwyu_MAPPING_FILE})
message(FATAL_ERROR "IWYU: Mapping file '${_set_iwyu_MAPPING_FILE}' does not exist")
endif()
_iwyu_args_append("--mapping_file=${_set_iwyu_MAPPING_FILE}")
endif()
if(_set_iwyu_MAX_LINE_LENGTH)
if(NOT _set_iwyu_MAX_LINE_LENGTH GREATER 0)
message(FATAL_ERROR "IWYU: Invalid MAX_LINE_LENGTH value = '${_set_iwyu_MAX_LINE_LENGTH}")
endif()
_iwyu_args_append("--max_line_length=${_set_iwyu_MAX_LINE_LENGTH}")
endif()
_iwyu_args_append_if_present(NO_DEFAULT_MAPPINGS "--no_default_mappings")
_iwyu_args_append_if_present(PCH_IN_CODE "--pch_in_code")
_iwyu_args_append_if_present(TRANSITIVE_INCLUDES_ONLY "--transitive_includes_only")
_iwyu_args_append_if_present(NO_COMMENTS "--no_comments")
_iwyu_args_append_if_present(NO_FORWARD_DECLARATIONS "--no_fwd_decls")
_iwyu_args_append_if_present(CXX17_NAMESPACES "--cxx17ns")
_iwyu_args_append_if_present(QUOTED_INCLUDES_FIRST "--quoted_includes_first")
_iwyu_args_append("--verbose=${IWYU_VERBOSITY_LEVEL}")
endmacro()
#
# set_target_iwyu(TargetName
# [KEEP pattern...]
# [MAPPING_FILE file]
# [NO_DEFAULT_MAPPINGS]
# [PCH_IN_CODE]
# [TRANSITIVE_INCLUDES_ONLY]
# [MAX_LINE_LENGTH length]
# [NO_COMMENTS]
# [NO_FORWARD_DECLARATIONS]
# [CXX17_NAMESPACES]
# [QUOTED_INCLUDES_FIRST])
#
function(set_target_iwyu target)
_find_iwyu()
_process_iwyu_arguments(1)
message(STATUS "Setting include-what-you-use for '${target}'")
message(STATUS " Path: ${_iwyu_path}")
message(STATUS " Arguments: ${_iwyu_args}")
message(STATUS "Setting include-what-you-use for '${target}' - done")
set_target_properties(${target} PROPERTIES
CXX_INCLUDE_WHAT_YOU_USE "${_iwyu_path};${_iwyu_args}"
)
endfunction()
#
# set_target_iwyu([KEEP patterns...]
# [MAPPING_FILE file]
# [NO_DEFAULT_MAPPINGS]
# [PCH_IN_CODE]
# [TRANSITIVE_INCLUDES_ONLY]
# [MAX_LINE_LENGTH length]
# [NO_COMMENTS]
# [NO_FORWARD_DECLARATIONS]
# [CXX17_NAMESPACES]
# [QUOTED_INCLUDES_FIRST])
#
function(set_iwyu)
_find_iwyu()
_process_iwyu_arguments(0)
message(STATUS "Setting include-what-you-use")
message(STATUS " Path: ${_iwyu_path}")
message(STATUS " Arguments: ${_iwyu_args}")
message(STATUS "Setting include-what-you-use - done")
set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE "${_iwyu_path};${_iwyu_args}" PARENT_SCOPE)
endfunction()