我将如何使用 CMake 包含 asio 库?

How would I include asio library using CMake?

我正在尝试为 class 开发一个项目,我想使用 CMake 来构建该项目。我当前的项目看起来像

|-bin
|-CMakeLists.txt
|-include
 |-asio-1.12.2
 |-chat_message.hpp
 |-chat_message.cpp
 |-CMakeLists.txt
|-src
 |-Server.cpp

尽管我的 Server.cpp 需要 asio.hpp /include/asio-1.12.2/include。 教授有一个用标志编译它的makefile -DASIO_STANDALONE -Wall -O0 -g -std=c++11 -I./include -I./include/asio-1.12.2/include。我的 CMakeLists 文件如下所示: ./CMakeLists.txt

CMAKE_MINIMUM_REQUIRED(VERSION 3.12)
PROJECT(Server VERSION 0.0.1)
SET(CPP_STANDARD 11)
SET(CPP_STANDARD_REQUIRED True)
ADD_SUBDIRECTORY(include)
ADD_EXECUTABLE(Server src/Server.cpp)
TARGET_LINK_LIBRARIES(
   Server PRIVATE
   chat_message
   asio
)

./include/CMakeLists.txt

ADD_LIBRARY(
   chat_message
   chat_message.cpp
   chat_message.hpp
)
ADD_LIBRARY(
   asio
   asio-1.12.2/include/asio.cpp
   asio-1.12.2/include/asio.hpp
)
TARGET_INCLUDE_DIRECTORIES(
   chat_message PUBLIC "${CMAKE_SOURCE_DIR}/include"
   asio PUBLIC "${CMAKE_SOURCE_DIR}/include/asio-1.12.2/include"
)

我如何将 asio 头文件 link 转换为带有所需标志的 Server.cpp 文件?

首先,和一样,必须将target_include_directories()命令拆分成两个独立的命令。然后,这会将 asiochat_message 的包含目录传播到您的 Server 目标,这会将正确的包含标志添加到编译器标志。

注意: 如果您将来决定更改项目结构,我建议您从 CMAKE_SOURCE_DIR to CMAKE_CURRENT_SOURCE_DIR 切换并相应地更改您的路径以使您的生活稍微轻松一些,因为您通常会将 CMakeLists.txt 文件保存在与其创建的目标源相同的目录中。

可以通过 target_compile_definitions() 调用添加 -DASIO_STANDALONE 选项:

target_compile_definitions(asio PUBLIC ASIO_STANDALONE)

请注意,您不需要 -D - CMake 将为您生成正确的编译器标志。此外,由于这是 asio 目标的要求,它的所有消费者都需要它,因此应该将它添加到目标中,而不是它的消费者——然后它会根据需要传播到依赖项。

在您的 CMakeLists.txt 中,您设置了 CPP_STANDARDCPP_STANDARD_REQUIRED 变量。你要找的分别是 CMAKE_CXX_STANDARDCMAKE_CXX_STANDARD_REQUIRED

这将为整个项目中的所有目标设置标志。

添加错误、优化和调试符号标志的方法有多种,您使用哪种方法取决于您的用例。以下并非详尽列表。

  • 如果您希望构建库的每个人都拥有这些,而不考虑构建配置 (debug/release/etc),请在 CMakeLists.txt
  • 中设置 CMAKE_CXX_FLAGS 变量
  • 如果您希望每个人都拥有标志,但仅在某些构建类型中,请设置 CMAKE_CXX_FLAGS_<CONFIG> 变量,其中 <CONFIG> 是所选的构建类型(DEBUG/RELEASE/MINSIZEREL/RELWITHDEBINFO 可通过默认)
  • 如果您不想将标志强加给每个人,在调用 CMake 之前,您可以设置 CXXFLAGS 环境变量。但请注意,根据文档,如果在您的 CMake 脚本中设置了 CMAKE_CXX_FLAGS,这将无效。
  • 如果要向单个目标添加标志,可以对其调用 target_compile_options,并将适当的可见性选项设置为 enable/disable 向消费者传播。

但是一般来说,您在使用它们时确实需要考虑可移植性。例如,GCC 可能支持某个标志,而在 Clang 中可能会有所不同。

编辑地址 评论

由于header-only ASIO库不喜欢用上面提到的编译器定义编译,有两种方法可以解决它:

删除 ASIO_STANDALONE 编译器标志

从您的角度来看,这将是最简单的事情,但作为连锁反应,它需要您在系统上安装 Boost,因为没有上面的标志会导致预处理器通过一些 Boost 包括。可能还有其他影响,但这是我在继续下面的解决方案之前遇到的第一个。

保留flag,使用CMake接口库

add_library() 可以让你添加一个目标,它实际上不会产生任何编译的 objects/libraries/executables,而只是一个逻辑 CMake 目标,它可以像任何其他目标一样拥有属性 - 包括目录,link 库等。因此,您至少可以这样做:

add_library(asio INTERFACE)
target_compile_options(asio INTERFACE ASIO_STANDALONE)
target_include_directories(asio INTERFACE <dir where asio.hpp lives>)
target_link_libraries(asio INTERFACE <threads>)  # Using ASIO requires you link your final executable/library with your system's threading library (e.g. pthread on linux)

然后当你link另一个目标时

target_link_libraries(any_lib PRIVATE asio)

any_lib 将继承使用 ASIO 构建所需的所有属性。

您选择的解决方案将取决于您的用例,但如果您必须按照与您的教授相同的方式来做,那么请选择 INTERFACE 库路线。