[vcpkg_fail_port_install] add a warning about extra args when ALWAYS is passed (#20314)

* [vcpkg_fail_port_install] add a warning about extra args when ALWAYS is passed

* Address the review suggestions

Co-authored-by: PhoebeHui <20694052+PhoebeHui@users.noreply.github.com>
This commit is contained in:
nicole mazzuca 2021-12-28 14:43:05 -08:00 committed by GitHub
parent 511eee8ec6
commit bfbdf28bf4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -40,23 +40,42 @@ Library linkage for which the build should fail early.
#]===]
function(vcpkg_fail_port_install)
cmake_parse_arguments(PARSE_ARGV 0 "arg" "ALWAYS" "MESSAGE" "ON_TARGET;ON_ARCH;ON_CRT_LINKAGE;ON_LIBRARY_LINKAGE")
set(multi_args "ON_TARGET;ON_ARCH;ON_CRT_LINKAGE;ON_LIBRARY_LINKAGE")
cmake_parse_arguments(PARSE_ARGV 0 "arg" "ALWAYS" "MESSAGE" "${multi_args}")
if(DEFINED arg_UNPARSED_ARGUMENTS)
message(FATAL_ERROR "vcpkg_fail_port_install was passed extra arguments: ${arg_UNPARSED_ARGUMENTS}")
endif()
if(arg_ALWAYS)
vcpkg_list(SET extra_args)
foreach(arg IN LISTS multi_args)
if(DEFINED "arg_${arg}")
vcpkg_list(APPEND extra_args "${arg}" "${arg_${arg}}")
endif()
endforeach()
if(NOT "${extra_args}" STREQUAL "")
message(WARNING "vcpkg_fail_port_install set to fail both unconditionally and conditionally on ${extra_args}. This is likely to be an error.")
endif()
if(NOT DEFINED arg_MESSAGE)
message(FATAL_ERROR "vcpkg_fail_port_install(ALWAYS) was called without a specific MESSAGE.")
endif()
message(FATAL_ERROR "${arg_MESSAGE}")
endif()
if(DEFINED arg_MESSAGE)
string(APPEND arg_MESSAGE "\n")
else()
set(arg_MESSAGE "")
endif()
set(fail_port)
set(fail_port OFF)
# Target fail check
if(DEFINED arg_ON_TARGET)
foreach(target IN LISTS arg_ON_TARGET)
string(TOUPPER "${target}" target_upper)
if(VCPKG_TARGET_IS_${target_upper})
set(fail_port TRUE)
set(fail_port ON)
string(APPEND arg_MESSAGE "Target '${target}' not supported by ${PORT}!\n")
endif()
endforeach()
@ -66,7 +85,7 @@ function(vcpkg_fail_port_install)
if(DEFINED arg_ON_ARCH)
foreach(arch IN LISTS arg_ON_ARCH)
if(VCPKG_TARGET_ARCHITECTURE STREQUAL arch)
set(fail_port TRUE)
set(fail_port ON)
string(APPEND arg_MESSAGE "Architecture '${arch}' not supported by ${PORT}!\n")
endif()
endforeach()
@ -76,7 +95,7 @@ function(vcpkg_fail_port_install)
if(DEFINED arg_ON_CRT_LINKAGE)
foreach(crt_linkage IN LISTS arg_ON_CRT_LINKAGE)
if(VCPKG_CRT_LINKAGE STREQUAL crt_linkage)
set(fail_port TRUE)
set(fail_port ON)
string(APPEND arg_MESSAGE "CRT linkage '${VCPKG_CRT_LINKAGE}' not supported by ${PORT}!\n")
endif()
endforeach()
@ -86,13 +105,13 @@ function(vcpkg_fail_port_install)
if(DEFINED arg_ON_LIBRARY_LINKAGE)
foreach(library_linkage IN LISTS arg_ON_LIBRARY_LINKAGE)
if(VCPKG_LIBRARY_LINKAGE STREQUAL library_linkage)
set(fail_port TRUE)
set(fail_port ON)
string(APPEND arg_MESSAGE "Library linkage '${VCPKG_LIBRARY_LINKAGE}' not supported by ${PORT}!\n")
endif()
endforeach()
endif()
if(fail_port OR arg_ALWAYS)
message(FATAL_ERROR ${arg_MESSAGE})
if(fail_port)
message(FATAL_ERROR "${arg_MESSAGE}")
endif()
endfunction()