[scripts-audit] nmake buildsystem (#20987)

* [scripts-audit] vcpkg_install_nmake

* [scripts-audit] vcpkg_build_nmake

hoping not to make too many changes, just minor simplifications

* is this the issue with gdal?

* back-compat hack woot

* remove port-specific workaround

* dg0yt CR
This commit is contained in:
nicole mazzuca 2021-11-05 16:55:01 -07:00 committed by GitHub
parent 8300767077
commit efdf9346ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 122 additions and 140 deletions

View File

@ -34,9 +34,6 @@ Specifies the sub directory containing the `makefile.vc`/`makefile.mak`/`makefil
Specifies the name of msvc makefile name. Specifies the name of msvc makefile name.
Default is `makefile.vc` Default is `makefile.vc`
### NO_DEBUG
This port doesn't support debug mode.
### ENABLE_INSTALL ### ENABLE_INSTALL
Install binaries after build. Install binaries after build.
@ -62,9 +59,6 @@ Additional options passed to generate during the Debug generation. These are in
The target passed to the nmake build command (`nmake/nmake install`). If not specified, no target will The target passed to the nmake build command (`nmake/nmake install`). If not specified, no target will
be passed. be passed.
### ADD_BIN_TO_PATH
Adds the appropriate Release and Debug `bin\` directories to the path during the build such that executables can run against the in-tree DLLs.
## Notes: ## Notes:
You can use the alias [`vcpkg_install_nmake()`](vcpkg_install_nmake.md) function if your makefile supports the You can use the alias [`vcpkg_install_nmake()`](vcpkg_install_nmake.md) function if your makefile supports the
"install" target "install" target

View File

@ -33,9 +33,6 @@ Specifies the sub directory containing the `makefile.vc`/`makefile.mak`/`makefil
Specifies the name of msvc makefile name. Specifies the name of msvc makefile name.
Default is `makefile.vc` Default is `makefile.vc`
### NO_DEBUG
This port doesn't support debug mode.
### ENABLE_INSTALL ### ENABLE_INSTALL
Install binaries after build. Install binaries after build.
@ -61,9 +58,6 @@ Additional options passed to generate during the Debug generation. These are in
The target passed to the nmake build command (`nmake/nmake install`). If not specified, no target will The target passed to the nmake build command (`nmake/nmake install`). If not specified, no target will
be passed. be passed.
### ADD_BIN_TO_PATH
Adds the appropriate Release and Debug `bin\` directories to the path during the build such that executables can run against the in-tree DLLs.
## Notes: ## Notes:
You can use the alias [`vcpkg_install_nmake()`](vcpkg_install_nmake.md) function if your makefile supports the You can use the alias [`vcpkg_install_nmake()`](vcpkg_install_nmake.md) function if your makefile supports the
"install" target "install" target
@ -75,33 +69,38 @@ You can use the alias [`vcpkg_install_nmake()`](vcpkg_install_nmake.md) function
#]===] #]===]
function(vcpkg_build_nmake) function(vcpkg_build_nmake)
# parse parameters such that semicolons in options arguments to COMMAND don't get erased cmake_parse_arguments(PARSE_ARGV 0 arg
cmake_parse_arguments(PARSE_ARGV 0 _bn
"ADD_BIN_TO_PATH;ENABLE_INSTALL;NO_DEBUG" "ADD_BIN_TO_PATH;ENABLE_INSTALL;NO_DEBUG"
"SOURCE_PATH;PROJECT_SUBPATH;PROJECT_NAME;LOGFILE_ROOT" "SOURCE_PATH;PROJECT_SUBPATH;PROJECT_NAME;LOGFILE_ROOT"
"OPTIONS;OPTIONS_RELEASE;OPTIONS_DEBUG;PRERUN_SHELL;PRERUN_SHELL_DEBUG;PRERUN_SHELL_RELEASE;TARGET" "OPTIONS;OPTIONS_RELEASE;OPTIONS_DEBUG;PRERUN_SHELL;PRERUN_SHELL_DEBUG;PRERUN_SHELL_RELEASE;TARGET"
) )
if(DEFINED arg_UNPARSED_ARGUMENTS)
if (NOT CMAKE_HOST_WIN32) message(WARNING "${CMAKE_CURRENT_FUNCTION} was passed extra arguments: ${arg_UNPARSED_ARGUMENTS}")
message(FATAL_ERROR "vcpkg_build_nmake only support windows.") endif()
if(NOT DEFINED arg_SOURCE_PATH)
message(FATAL_ERROR "SOURCE_PATH must be specified")
endif() endif()
if (_bn_OPTIONS_DEBUG STREQUAL _bn_OPTIONS_RELEASE) if(arg_NO_DEBUG)
message(FATAL_ERROR "Detected debug configuration is equal to release configuration, please use NO_DEBUG for vcpkg_build_nmake/vcpkg_install_nmake") message(WARNING "NO_DEBUG argument to ${CMAKE_CURRENT_FUNCTION} is deprecated")
endif()
if(arg_ADD_BIN_TO_PATH)
message(WARNING "ADD_BIN_TO_PATH argument to ${CMAKE_CURRENT_FUNCTION} is deprecated - it never did anything")
endif() endif()
if(NOT _bn_LOGFILE_ROOT) if(NOT VCPKG_HOST_IS_WINDOWS)
set(_bn_LOGFILE_ROOT "build") message(FATAL_ERROR "${CMAKE_CURRENT_FUNCTION} only support windows.")
endif() endif()
if (NOT _bn_PROJECT_NAME) if(NOT DEFINED arg_LOGFILE_ROOT)
set(MAKEFILE_NAME makefile.vc) set(arg_LOGFILE_ROOT "build")
else() endif()
set(MAKEFILE_NAME ${_bn_PROJECT_NAME}) if(NOT DEFINED arg_PROJECT_NAME)
set(arg_PROJECT_NAME makefile.vc)
endif()
if(NOT DEFINED arg_TARGET)
vcpkg_list(SET arg_TARGET all)
endif() endif()
set(MAKE )
set(MAKE_OPTS_BASE )
find_program(NMAKE nmake REQUIRED) find_program(NMAKE nmake REQUIRED)
get_filename_component(NMAKE_EXE_PATH ${NMAKE} DIRECTORY) get_filename_component(NMAKE_EXE_PATH ${NMAKE} DIRECTORY)
@ -114,119 +113,84 @@ function(vcpkg_build_nmake)
set(ENV{PATH} "$ENV{PATH};${NMAKE_EXE_PATH}") set(ENV{PATH} "$ENV{PATH};${NMAKE_EXE_PATH}")
set(ENV{INCLUDE} "${CURRENT_INSTALLED_DIR}/include;$ENV{INCLUDE}") set(ENV{INCLUDE} "${CURRENT_INSTALLED_DIR}/include;$ENV{INCLUDE}")
# Set make command and install command # Set make command and install command
set(MAKE ${NMAKE} /NOLOGO /G /U) vcpkg_list(SET make_command ${NMAKE} /NOLOGO /G /U)
set(MAKE_OPTS_BASE -f ${MAKEFILE_NAME}) vcpkg_list(SET make_opts_base -f "${arg_PROJECT_NAME}" ${arg_TARGET})
if (_bn_ENABLE_INSTALL) if(arg_ENABLE_INSTALL)
set(INSTALL_COMMAND install) vcpkg_list(APPEND make_opts_base install)
endif()
if (_bn_TARGET)
set(MAKE_OPTS_BASE ${MAKE_OPTS_BASE} ${_bn_TARGET} ${INSTALL_COMMAND})
else()
set(MAKE_OPTS_BASE ${MAKE_OPTS_BASE} all ${INSTALL_COMMAND})
endif() endif()
# Add subpath to work directory # Add subpath to work directory
if (_bn_PROJECT_SUBPATH) if(DEFINED arg_PROJECT_SUBPATH)
set(_bn_PROJECT_SUBPATH /${_bn_PROJECT_SUBPATH}) set(project_subpath "/${arg_PROJECT_SUBPATH}")
else() else()
set(_bn_PROJECT_SUBPATH ) set(project_subpath "")
endif() endif()
foreach(BUILDTYPE "debug" "release") vcpkg_backup_env_variables(VARS CL)
if(NOT DEFINED VCPKG_BUILD_TYPE OR VCPKG_BUILD_TYPE STREQUAL BUILDTYPE) foreach(build_type IN ITEMS debug release)
if(BUILDTYPE STREQUAL "debug") if(NOT DEFINED VCPKG_BUILD_TYPE OR VCPKG_BUILD_TYPE STREQUAL build_type)
# Skip debug generate if(build_type STREQUAL "debug")
if (_bn_NO_DEBUG)
continue()
endif()
# Generate obj dir suffix # Generate obj dir suffix
set(SHORT_BUILDTYPE "-dbg") set(short_build_type "-dbg")
set(CONFIG "Debug")
# Add install command and arguments # Add install command and arguments
set(MAKE_OPTS ${MAKE_OPTS_BASE}) set(make_opts "${make_opts_base}")
if (_bn_ENABLE_INSTALL) if (arg_ENABLE_INSTALL)
set(INSTALL_OPTS INSTALLDIR=${CURRENT_PACKAGES_DIR}/debug) vcpkg_list(APPEND make_opts "INSTALLDIR=${CURRENT_PACKAGES_DIR}/debug")
set(MAKE_OPTS ${MAKE_OPTS} ${INSTALL_OPTS})
endif() endif()
set(MAKE_OPTS ${MAKE_OPTS} ${_bn_OPTIONS} ${_bn_OPTIONS_DEBUG}) vcpkg_list(APPEND make_opts ${arg_OPTIONS} ${arg_OPTIONS_DEBUG})
set(ENV{CL} "${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_DEBUG}")
unset(ENV{CL}) set(prerun_variable_name arg_PRERUN_SHELL_DEBUG)
set(TMP_CL_FLAGS "${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_DEBUG}")
string(REPLACE "/" "-" TMP_CL_FLAGS "${TMP_CL_FLAGS}")
set(ENV{CL} "$ENV{CL} ${TMP_CL_FLAGS}")
else() else()
# In NO_DEBUG mode, we only use ${TARGET_TRIPLET} directory. set(short_build_type "-rel")
if (_bn_NO_DEBUG)
set(SHORT_BUILDTYPE "")
else()
set(SHORT_BUILDTYPE "-rel")
endif()
set(CONFIG "Release")
# Add install command and arguments # Add install command and arguments
set(MAKE_OPTS ${MAKE_OPTS_BASE}) set(make_opts "${make_opts_base}")
if (_bn_ENABLE_INSTALL) if (arg_ENABLE_INSTALL)
set(INSTALL_OPTS INSTALLDIR=${CURRENT_PACKAGES_DIR}) vcpkg_list(APPEND make_opts "INSTALLDIR=${CURRENT_PACKAGES_DIR}")
set(MAKE_OPTS ${MAKE_OPTS} ${INSTALL_OPTS})
endif() endif()
set(MAKE_OPTS ${MAKE_OPTS} ${_bn_OPTIONS} ${_bn_OPTIONS_RELEASE}) vcpkg_list(APPEND make_opts ${arg_OPTIONS} ${arg_OPTIONS_RELEASE})
unset(ENV{CL}) set(ENV{CL} "${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_RELEASE}")
set(TMP_CL_FLAGS "${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_RELEASE}") set(prerun_variable_name arg_PRERUN_SHELL_RELEASE)
string(REPLACE "/" "-" TMP_CL_FLAGS "${TMP_CL_FLAGS}")
set(ENV{CL} "$ENV{CL} ${TMP_CL_FLAGS}")
endif() endif()
set(CURRENT_TRIPLET_NAME ${TARGET_TRIPLET}${SHORT_BUILDTYPE}) set(triplet_and_build_type "${TARGET_TRIPLET}${short_build_type}")
set(OBJ_DIR ${CURRENT_BUILDTREES_DIR}/${CURRENT_TRIPLET_NAME}) set(object_dir "${CURRENT_BUILDTREES_DIR}/${triplet_and_build_type}")
file(REMOVE_RECURSE ${OBJ_DIR}) file(REMOVE_RECURSE "${object_dir}")
file(MAKE_DIRECTORY ${OBJ_DIR}) file(COPY "${arg_SOURCE_PATH}/" DESTINATION "${object_dir}")
file(GLOB_RECURSE SOURCE_FILES ${_bn_SOURCE_PATH}/*)
foreach(ONE_SOUCRCE_FILE ${SOURCE_FILES})
get_filename_component(DST_DIR ${ONE_SOUCRCE_FILE} PATH)
string(REPLACE "${_bn_SOURCE_PATH}" "${OBJ_DIR}" DST_DIR "${DST_DIR}")
file(COPY ${ONE_SOUCRCE_FILE} DESTINATION ${DST_DIR})
endforeach()
if (_bn_PRERUN_SHELL) if(DEFINED arg_PRERUN_SHELL)
message(STATUS "Prerunning ${CURRENT_TRIPLET_NAME}") message(STATUS "Prerunning ${triplet_and_build_type}")
vcpkg_execute_required_process( vcpkg_execute_required_process(
COMMAND ${_bn_PRERUN_SHELL} COMMAND ${arg_PRERUN_SHELL}
WORKING_DIRECTORY ${OBJ_DIR}${_bn_PROJECT_SUBPATH} WORKING_DIRECTORY "${object_dir}${project_subpath}"
LOGNAME "$prerun-${CURRENT_TRIPLET_NAME}" LOGNAME "prerun-${triplet_and_build_type}"
) )
endif() endif()
if (BUILDTYPE STREQUAL "debug" AND _bn_PRERUN_SHELL_DEBUG) if(DEFINED "${prerun_variable_name}")
message(STATUS "Prerunning ${CURRENT_TRIPLET_NAME}") message(STATUS "Prerunning ${triplet_and_build_type}")
vcpkg_execute_required_process( vcpkg_execute_required_process(
COMMAND ${_bn_PRERUN_SHELL_DEBUG} COMMAND ${${prerun_variable_name}}
WORKING_DIRECTORY ${OBJ_DIR}${_bn_PROJECT_SUBPATH} WORKING_DIRECTORY "${object_dir}${project_subpath}"
LOGNAME "prerun-${CURRENT_TRIPLET_NAME}-dbg" LOGNAME "prerun-specific-${triplet_and_build_type}"
)
endif()
if (BUILDTYPE STREQUAL "release" AND _bn_PRERUN_SHELL_RELEASE)
message(STATUS "Prerunning ${CURRENT_TRIPLET_NAME}")
vcpkg_execute_required_process(
COMMAND ${_bn_PRERUN_SHELL_RELEASE}
WORKING_DIRECTORY ${OBJ_DIR}${_bn_PROJECT_SUBPATH}
LOGNAME "prerun-${CURRENT_TRIPLET_NAME}-rel"
) )
endif() endif()
if (NOT _bn_ENABLE_INSTALL) if (NOT arg_ENABLE_INSTALL)
message(STATUS "Building ${CURRENT_TRIPLET_NAME}") message(STATUS "Building ${triplet_and_build_type}")
else() else()
message(STATUS "Building and installing ${CURRENT_TRIPLET_NAME}") message(STATUS "Building and installing ${triplet_and_build_type}")
endif() endif()
vcpkg_execute_build_process( vcpkg_execute_build_process(
COMMAND ${MAKE} ${MAKE_OPTS} COMMAND ${make_command} ${make_opts}
WORKING_DIRECTORY ${OBJ_DIR}${_bn_PROJECT_SUBPATH} WORKING_DIRECTORY "${object_dir}${project_subpath}"
LOGNAME "${_bn_LOGFILE_ROOT}-${CURRENT_TRIPLET_NAME}" LOGNAME "${arg_LOGFILE_ROOT}-${triplet_and_build_type}"
) )
if(_bn_ADD_BIN_TO_PATH) vcpkg_restore_env_variables(VARS CL)
set(ENV{PATH} "${_BACKUP_ENV_PATH}")
endif()
endif() endif()
endforeach() endforeach()
endfunction() endfunction()

View File

@ -65,32 +65,56 @@ This command transparently forwards to [`vcpkg_build_nmake()`](vcpkg_build_nmake
#]===] #]===]
function(vcpkg_install_nmake) function(vcpkg_install_nmake)
# parse parameters such that semicolons in options arguments to COMMAND don't get erased vcpkg_list(SET multi_value_args
cmake_parse_arguments(PARSE_ARGV 0 _in TARGET
OPTIONS OPTIONS_DEBUG OPTIONS_RELEASE
PRERUN_SHELL PRERUN_SHELL_DEBUG PRERUN_SHELL_RELEASE)
cmake_parse_arguments(PARSE_ARGV 0 arg
"NO_DEBUG" "NO_DEBUG"
"SOURCE_PATH;PROJECT_SUBPATH;PROJECT_NAME" "SOURCE_PATH;PROJECT_SUBPATH;PROJECT_NAME"
"OPTIONS;OPTIONS_RELEASE;OPTIONS_DEBUG;PRERUN_SHELL;PRERUN_SHELL_DEBUG;PRERUN_SHELL_RELEASE;TARGET" "${multi_value_args}"
) )
if(DEFINED arg_UNPARSED_ARGUMENTS)
if (NOT CMAKE_HOST_WIN32) message(WARNING "${CMAKE_CURRENT_FUNCTION} was passed extra arguments: ${arg_UNPARSED_ARGUMENTS}")
message(FATAL_ERROR "vcpkg_install_nmake only support windows.") endif()
if(NOT DEFINED arg_SOURCE_PATH)
message(FATAL_ERROR "SOURCE_PATH must be specified")
endif() endif()
if (_in_NO_DEBUG) if(NOT VCPKG_HOST_IS_WINDOWS)
set(NO_DEBUG NO_DEBUG) message(FATAL_ERROR "${CMAKE_CURRENT_FUNCTION} only support windows.")
endif() endif()
if (NOT _in_TARGET) # backwards-compatibility hack
set(INSTALL_TARGET "all") # gdal passes `arg_OPTIONS_DEBUG` (and RELEASE) as a single argument,
else() # so we need to split them again
set(INSTALL_TARGET "${_in_TARGET}") set(arg_OPTIONS_DEBUG ${arg_OPTIONS_DEBUG})
set(arg_OPTIONS_RELEASE ${arg_OPTIONS_RELEASE})
vcpkg_list(SET extra_args)
# switch args
if(arg_NO_DEBUG)
vcpkg_list(APPEND extra_args NO_DEBUG)
endif() endif()
vcpkg_build_nmake(LOGFILE_ROOT ENABLE_INSTALL # single args
${NO_DEBUG} foreach(arg IN ITEMS PROJECT_SUBPATH PROJECT_NAME)
TARGET "${INSTALL_TARGET}" if(DEFINED "arg_${arg}")
SOURCE_PATH ${_in_SOURCE_PATH} PROJECT_SUBPATH ${_in_PROJECT_SUBPATH} PROJECT_NAME ${_in_PROJECT_NAME} vcpkg_list(APPEND extra_args ${arg} "${arg_${arg}}")
PRERUN_SHELL ${_in_PRERUN_SHELL} PRERUN_SHELL_DEBUG ${_in_PRERUN_SHELL_DEBUG} PRERUN_SHELL_RELEASE ${_in_PRERUN_SHELL_RELEASE} endif()
OPTIONS ${_in_OPTIONS} OPTIONS_RELEASE ${_in_OPTIONS_RELEASE} OPTIONS_DEBUG ${_in_OPTIONS_DEBUG} endforeach()
)
# multi-value args
foreach(arg IN LISTS multi_value_args)
if(DEFINED "arg_${arg}")
vcpkg_list(APPEND extra_args ${arg} ${arg_${arg}})
endif()
endforeach()
vcpkg_build_nmake(
SOURCE_PATH "${arg_SOURCE_PATH}"
ENABLE_INSTALL
LOGFILE_ROOT install
${extra_args})
endfunction() endfunction()