时间戳

首页 > 解决方案 > 我将如何使用 CMake 包含 asio 库？

cmake - 我将如何使用 CMake 包含 asio 库？

问题描述

我正在尝试为一个类开发一个项目，并且我想使用 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。教授有一个用 flags 编译它的 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 头文件链接到带有所需标志的 Server.cpp 文件？

标签： cmakeboost-asioasio

解决方案

首先，正如Tzyvarev 在评论中指出的那样，您必须将target_include_directories()命令拆分为两个单独的命令。asio然后，这会将andchat_message的包含目录传播到您的Server目标，这会将正确的包含标志添加到编译器标志。

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

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

target_compile_definitions(asio PUBLIC ASIO_STANDALONE)

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

在您的 CMakeLists.txt 中，您已经设置了CPP_STANDARD和CPP_STANDARD_REQUIRED变量。你所追求的分别是CMAKE_CXX_STANDARD和CMAKE_CXX_STANDARD_REQUIRED。

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

添加错误、优化和调试符号标志有不同的方法，您使用哪一种取决于您的用例。以下不是详尽的列表。

  • 如果您希望构建库的每个人都拥有这些，而不考虑构建配置（调试/发布/等），您可以在 CMakeLists.txt 中设置CMAKE_CXX_FLAGS变量
  • 如果您希望每个人都有标志，但仅限于某些构建类型，请设置CMAKE_CXX_FLAGS_<CONFIG>变量，<CONFIG>选择的构建类型在哪里（DEBUG/RELEASE/MINSIZEREL/RELWITHDEBINFO 默认可用）
  • 如果您不想将标志强加于每个人，在调用 CMake 之前，您可以设置CXXFLAGS环境变量。CMAKE_CXX_FLAGS但请注意，根据文档，如果在您的 CMake 脚本中设置，这将无效。
  • 如果要向单个目标添加标志，可以在其上调用target_compile_options，并设置适当的可见性选项以启用/禁用对消费者的传播。

但是，一般来说，您在使用这些时确实需要考虑可移植性。例如，GCC 可能支持在 Clang 中可能不同的某个标志。

编辑以解决此评论

由于仅头文件的 ASIO 库不喜欢使用上面提到的编译器定义进行编译，因此有两种方法可以解决它：

删除 ASIO_STANDALONE 编译器标志

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

保留标志，并使用 CMake 接口库

add_library()可以允许您添加一个实际上不会产生任何编译对象/库/可执行文件的目标，而只是一个逻辑 CMake 目标，它可以像任何其他目标一样拥有属性 - 包括目录、链接库等。所以作为最低限度你可以这样做：

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)

然后，当您将另一个目标与它链接时

target_link_libraries(any_lib PRIVATE asio)

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

您选择的解决方案将由您的用例决定，但如果您必须像您的教授那样做，那么请走 INTERFACE 库路线。

推荐阅读