库标头和#define

Library headers and #define

本文关键字：#define      更新时间：2023-10-16

我不知道该为这个搜索什么。如果这很简单，请原谅。但让我概述一下这个场景，看看答案是什么。

假设我有一个库，它定义了这样一个结构：

struct Example {
int a;
#if B_ENABLED
int b;
#endif
};

此标头将作为库整体安装的一部分进行安装。我的问题是，如果我的库定义B_ENABLED，它将具有包含这两个变量的结构但是如果我的应用程序没有对此进行定义。然后它将把头解释为定义一个只有一个成员的结构。

处理这一问题的最佳方法是否只是生成某种"选项"标头，其中包括库构建中指定的所有#定义？

我的库是用CMAKE构建的。因此，CMAKE的解决方案是额外信贷=D。

解决方案#1(配置+安装)

在头文件(即foo.hpp)中包含config.hpp文件：

#ifndef FOO_HPP_
#define FOO_HPP_
#include "config.hpp" // FOO_DEBUG
class Foo {
public:
int result() const;
private:
int a_;
#ifdef FOO_DEBUG
int b_;
#endif // FOO_DEBUG
};
#endif // FOO_HPP_

config.hpp是configure_file命令的输出：

configure_file(config.hpp.in "${PROJECT_BINARY_DIR}/config/config.hpp")
include_directories("${PROJECT_BINARY_DIR}/config")
install(FILES Foo.hpp "${PROJECT_BINARY_DIR}/config/config.hpp" DESTINATION include)

输入文件config.hpp.in使用特殊的cmakedefine指令：

#ifndef CONFIG_HPP_
#define CONFIG_HPP_
#cmakedefine FOO_DEBUG
#endif // CONFIG_HPP_

请注意，当您在其他项目中使用已安装的库时：

  • 您仍然需要为库指定include目录
  • 如果你的库有依赖项，你需要手动链接它们
  • 不能有2个配置文件(调试/发布)

解决方案#2(推荐导出/导入目标)

install(EXPORT…)命令可以保存有关使用库的所有信息(又名使用要求：包括定义、链接库、配置等)：

add_library(Foo Foo.cpp Foo.hpp)
# Target which used Foo will be compiled with this definitions
target_compile_definitions(Foo PUBLIC $<$<CONFIG:Release>:FOO_DEBUG=0>)
target_compile_definitions(Foo PUBLIC $<$<CONFIG:Debug>:FOO_DEBUG=1>)
# This directory will be used as include
target_include_directories(Foo INTERFACE "${CMAKE_INSTALL_PREFIX}/include")
# This library will be linked
target_link_libraries(Foo PUBLIC pthread)
# Regular install
install(FILES Foo.hpp DESTINATION include)
# Install with export set
install(TARGETS Foo DESTINATION lib EXPORT FooTargets)
install(EXPORT FooTargets DESTINATION lib/cmake/Foo)

安装这样的项目会产生文件(CMAKE_DEBUG_POSTFIX就是d)：

include/Foo.hpp
lib/libFoo.a
lib/libFood.a
lib/cmake/Foo/FooTargets-debug.cmake
lib/cmake/Foo/FooTargets-release.cmake
lib/cmake/Foo/FooTargets.cmake

包括FooTargets.cmake文件以将已安装的库导入到项目中。例如，使用find_package命令(需要配置，请参阅config_package_config_file)：

add_executable(prog main.cpp)
find_package(Foo REQUIRED) # import Foo
target_link_libraries(prog Foo)

注意：

自动添加到编译器选项的include/Foo.hpp路径
  • dependent库pthread自动添加到prog链接器选项
  • 定义FOO_DEBUG=0添加到Release构建类型
  • 定义FOO_DEBUG=1添加到调试生成类型

    • 基本原理

    So excuse me if this is simple

    它不是(：

    问题的根源是ODR(C++标准2011，3.2[basic.def.ord]，第3页)：

    Every program shall contain exactly one definition of every non-inline function
or variable that is odr-used in that program; no diagnostic required. The
definition can appear explicitly in the program, it can be found in the
standard or a user-defined library

    IMHO良好的通用解决方案仍然不存在。将CMake与导入的配置一起使用可以提供部分帮助，但在某些情况下，仍然会出现链接器错误(例如，如果使用使用默认链接到libstdcxx的gcc编译的库，并尝试使用链接到libcxx的clang编译器将其链接到项目)。其中一些问题(并非全部)可以使用工具链文件解决。请参见示例。

    相关

    • CMake教程
    • 导出/导入目标
    • Qt和Boost的现代CMake
    相关文章：