c++ - CMake 为 VS 项目生成循环依赖，但不生成文件。如何避免？

Question

这个示例是从我正在进行的一个实际项目中提炼出来的；某种 MWE(好吧，不工作会更合适)。

考虑以下项目结构:

.
├── CMakeLists.txt
├── build
├── include
│   └── hello.hpp
└── src
    └── hello.cpp

build 目录用于执行构建并将包含构建工件和中间文件。剩余文件的内容将在本题底部给出。

想法是 install() 构建的库及其 header (以及实际项目中的一些其他内容)。

add_custom_command(
    TARGET ${PRJNAME}
    POST_BUILD
        COMMAND ${CMAKE_COMMAND} --build . --target install
    WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
    VERBATIM
)

... 与 install() 一起用于完成此操作并为生成器 Unix Makefiles 和 NMake Makefiles 执行此操作，但是为 Visual Studio 16 2019(也为 Visual Studio 14 2015 创建了一个循环依赖，但我没有进一步测试)。

现在我的第一 react 是，这是生成器之间的不一致，但另一方面，除了 make 文件之外的任何项目生成一直是 - IMO - CMake 一直以来的弱点之一。

目前我的解决方法是简单地使用 NMake Makefiles，但这种方法的缺点是我必须先“检测”Visual Studio 并使用 vcvarsall.bat、vcvars32.bat 和 friend 们。但与循环依赖相比，这是一个小麻烦。

我如何使用 Visual Studio 项目生成器之一来实现我想要的并避免循环依赖？

在 Windows 上，我使用的是 CMake 3.15.1(撰写本文时为最新版本)。

注意:我意识到我可以使用一些东西来达到 ${CMAKE_COMMAND} --build 的效果。 --target install 通过创建带有一些 file() 命令的自定义命令/目标。但这不会保留它DRY现在，会吗？

---

CMakeLists.txt

set(CMAKE_RULE_MESSAGES OFF)
set(CMAKE_VERBOSE_MAKEFILE ON)

cmake_minimum_required(VERSION 3.12 FATAL_ERROR)
set(PRJNAME FOOBAR)

project (${PRJNAME})

set(SOURCE_DIR "src")
set(HEADER_DIR "include")
set(TARGET_DIR "${CMAKE_CURRENT_BINARY_DIR}/install-target")
set(PUBLIC_HEADER "${HEADER_DIR}/hello.hpp")
set(PROJ_SOURCES "${SOURCE_DIR}/hello.cpp")

add_library(${PRJNAME} SHARED ${PROJ_SOURCES})

list(TRANSFORM PUBLIC_HEADER PREPEND "${CMAKE_CURRENT_BINARY_DIR}/" OUTPUT_VARIABLE PUBLIC_HEADER_PP)
set_target_properties(
    ${PRJNAME}
    PROPERTIES
        CXX_STANDARD 11
        CXX_EXTENSIONS OFF
        CXX_STANDARD_REQUIRED ON
        PUBLIC_HEADER "${PUBLIC_HEADER_PP}"
        POSITION_INDEPENDENT_CODE 1
)

set(CMAKE_INSTALL_PREFIX ${TARGET_DIR})
set(CMAKE_INSTALL_LIBDIR lib)
set(CMAKE_INSTALL_INCLUDEDIR ${HEADER_DIR})

install(
    TARGETS ${PRJNAME}
    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
    RUNTIME DESTINATION ${CMAKE_INSTALL_LIBDIR}
    PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
)

file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/${HEADER_DIR}")
configure_file("${PUBLIC_HEADER}" "${CMAKE_CURRENT_BINARY_DIR}/${HEADER_DIR}/" COPYONLY)
include_directories("${CMAKE_CURRENT_BINARY_DIR}/${HEADER_DIR}")

add_custom_command(
    TARGET ${PRJNAME}
    POST_BUILD
        COMMAND ${CMAKE_COMMAND} --build . --target install
    WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
    VERBATIM
)

set(PKGNAME "foobar-package.zip")

add_custom_command(
    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${PKGNAME}
        COMMAND ${CMAKE_COMMAND} -E tar cv "${CMAKE_CURRENT_BINARY_DIR}/${PKGNAME}" -- .
    WORKING_DIRECTORY "${TARGET_DIR}"
    VERBATIM
)

set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES ${CMAKE_CURRENT_BINARY_DIR}/${PKGNAME})

add_custom_target(
    lib
    DEPENDS ${PRJNAME}
)

src/hello.cpp

#ifdef _WIN32
#define WIN32_LEAN_AND_MEAN
#include <Windows.h>

BOOL APIENTRY DllMain(HMODULE, DWORD, LPVOID) { return TRUE; }
#endif
#include "hello.hpp"

int hello() { return 42; }

include/hello.cpp

#pragma once

#ifdef _WIN32
#   ifdef FOOBAR_EXPORTS
#       define FOOBAR_API  __declspec(dllexport)
#   else
#       define FOOBAR_API  __declspec(dllimport)
#   endif
#else
#   define FOOBAR_API
#endif

FOOBAR_API int hello();

Answer 1

在我看来，您的用例超出了 CMake 的设计范围。您正在尝试构建 INSTALL 目标，而该目标又会构建 FOOBAR 目标，后者又会调用 INSTALL 命令。

如果我们在这里通过拆分成两个不同的目标来打破链条:FOOBAR 和 FOOBAR_INSTALL 就像这样

add_custom_target(${PRJNAME}_INSTALL ALL
    ${CMAKE_COMMAND} --build . --target install
    WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
    VERBATIM
)

我们仍然会通过 ALL_BUILD 目标获得循环引用。因此，如果我们删除 ALL 参数，引用将被破坏，但不会从默认构建命令调用目标，这并不比调用 make 和 更好进行安装。

打破依赖关系的正确位置是在 INSTALL 和其他目标之间。您可以直接调用生成的 cmake_install.cmake 脚本，而不是构建 INSTALL 目标:

add_custom_command(
    TARGET ${PRJNAME}
    POST_BUILD
        COMMAND ${CMAKE_COMMAND} -D CMAKE_INSTALL_CONFIG_NAME=$<CONFIG> -P cmake_install.cmake
    WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
    VERBATIM
)