CMake学习（3）—— 使用add_subdirectory()添加外部项目文件夹

原创已于 2024-03-10 18:32:15 修改 · 6.8k 阅读

5 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#cmake

于 2022-04-01 14:27:48 首次发布

CMake 专栏收录该内容

4 篇文章

订阅专栏

当CMake项目需要引用外部文件夹时，直接使用`add_subdirectory`会报错。解决方法是在调用时添加`binary_dir`参数，指定源目录在输出目录中的位置。例如，将`add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}

一般情况下，我们的项目各个子项目都在一个总的项目根目录下，但有的时候，我们需要使用外部的文件夹，怎么办呢？例如，在目录cxx/utility/example内的CMakeLists.txt要引用上层目录cxx/utility的CMakeLists.txt：
在这里插入图片描述
通常，如果在cxx/utility/example内的CMakeLists.txt直接使用。

add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/..)

执行cmake -B build，则会报错：

CMake Error at CMakeLists.txt:14 (add_subdirectory):
  add_subdirectory not given a binary directory but the given source
  directory "D:/workspace/sdk/base/cxx/utility" is not a subdirectory of
  "D:/workspace/sdk/base/cxx/utility/example".  When specifying an
  out-of-tree source a binary directory must be explicitly specified.

报错原因：因为要添加的这个文件夹不是当前项目的子目录。最后一句指明了方向：要指定一个外部的文件夹必须显式指定。但怎么显式指定？查看官方文档。
在这里插入图片描述原来add_subdirectory还有一个 binary_dir参数，这个参数用来指定source_dir在输出文件夹中的位置，如果没有指定的时候，就用source_dir的值。如果要添加外部文件夹则binary_dir就必须指定。cxx/utility/example内的CMakeLists.txt修改为：

add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/.. 3rdparty/base/utility)

执行cmake -B build后可以在输出目录发现多出了子目录3rdparty/base/utility，这个就是第二个参数binary_dir所指定的：
在这里插入图片描述