如何将自动工具配置为仅在安装依赖项时才构建可选组件？

Question

我有一个使用 autotools 作为构建系统的 C++ 项目。

我的程序涉及一个抽象接口，其中有多个实现，每个实现都在单独的源文件中。这些实现取决于可能安装也可能不安装的库，具体取决于用户偏好和平台。

我想配置自动工具来跳过构建缺乏底层依赖项的实现。我想以用户和包维护者通常期望的任何方式来这样做。

举个例子，假设我的程序输出音频，它可以使用OSS、ALSA或JACK来实现。oss_output.cc这些分别在、alsa_output.cc和中实现jack_output.cc。

目前我的Makefile.am包含（以及其他一些内容）：

myprog_SOURCES = \
    src/oss_output.cc \
    src/alsa_output.cc \
    src/jack_output.cc

myprog_LDFLAGS = [...some other stuff...] -ljack

不幸的是，尝试在未安装 JACK 的系统上构建此程序会失败，因为链接器找不到 libjack 和/或编译器因缺少 JACK 的头文件而失败。如果未安装 JACK，我宁愿src/jack_output.cc从中删除myprog_SOURCES，然后-ljack从 中删除myprog_LDFLAGS。ALSA 和 OSS 也类似。

在这些依赖项（OSS、ALSA 和 JACK）中，其中一些库使用pkg-config. 有些没有，但我仍然可以通过头文件和库的存在来检测它们的存在。

如何使用自动工具来实现这一点，并注意遵循最佳实践和惯例？

Answer 1

如何使用自动工具来实现这一点，并注意遵循最佳实践和惯例？

有两块：

1. 检测需要/支持哪些子系统，以及
2. 将构建限制为仅选定的子系统。

确定要支持的子系统

第一部分是 Autoconf 的面包和黄油。通常，人们会通过或检查每个子系统的库是否存在，以确定它是否可用，并通过或检查主头文件。AC_CHECK_LIB()AC_SEARCH_LIBS()AC_CHECK_HEADER()AC_CHECK_HEADERS()

如果还建立一种机制来选择不为某些可用的子系统提供构建支持，将会很方便。这将采取设置--without或--disable论证的形式（选择哪一个通常是不明确的）。这不是强制性的，但我认为这是一种很好的形式。但请注意，它确实需要一些小心和注意，以避免在链接中包含所有找到的库。

凯迪拉克版本还将为用户提供支持，指定在哪里找到所需的库和标头，以防它们不在默认搜索路径中。我经常在维护良好的项目中看到这种事情，但它使复杂性上升了一个层次，我不认为它以任何方式是强制性的。

实现细节可能会有很大差异，但通常情况下，对于每个子系统来说，最终结果是：

• 一个 shell 变量，指示是否在构建中包含子系统（例如build_oss，可能），以及
• （可选）输出变量（通过创建AC_SUBST()）传递预处理器/编译器/和/或链接器标志，用于针对适当的后端库进行构建。例如，OSS 部分的部分或全部OSS_CPPFLAGS, OSS_CXXFLAGS, 。OSS_LIBS

将构建限制为选定的子系统

Automake 和 Autoconf 在这方面协同工作。关键工具是Automake 条件。Automake 提供了一个 Autoconf 宏，AM_CONDITIONAL用于定义这些宏并分配它们的值，并且它支持基于它们的文件中的if//构造。（请注意，尽管它们具有相似的语法，但它们完全独立于 GNU 条件。）thenelseMakefile.ammake

我链接的 Automake 手册的部分引用了其他几个讨论如何在各种情况下使用条件的部分，但并不完全清楚其中哪些适用于您。然而，我最好的猜测是，您真正需要的只是条件源，所以这就是我将重点关注的内容。

Autoconf 部分将继续我已经讨论过的部分。它可能很简单

AM_CONDITIONAL([oss], [test "$build_oss" = "1"])
AM_CONDITIONAL([alsa], [test "$build_alsa" = "1"])
AM_CONDITIONAL([jack], [test "$build_jack" = "1"])

Automake 手册给出了其他示例。

从Makefile.am侧面来说，这可能与以下内容相匹配：

myprog_SOURCES = \
  src/main.cc \
  src/another.cc \
  ...

if oss
  myprog_SOURCES += src/oss_output.cc
endif
if alsa
  myprog_SOURCES += src/alsa_output.cc
endif
if jack
  myprog_SOURCES += src/jack_output.cc
endif

您还需要注意应用每个子系统的标志和库。if您可以采用与源相同的方法（甚至使用相同的块），这就好了，或者您可以configure首先通过它如何（是否）为每个子系统定义任何标志来进行控制。

您会注意到我掩盖了许多细节。这是对我必须视为高级别问题的相当高级别的答案。如果我以其他方式回答这个问题，那么这个问题对于这个场地来说就太宽泛了。