CMake4-指令1-3：add_subdirectory【用于将子目录添加到构建】

已于 2024-06-08 15:49:14 修改
阅读量480 收藏 1
点赞数 1
分类专栏： # C++/CMAKE 文章标签： c++ CMAKE
于 2022-11-19 14:16:18 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u013250861/article/details/127936417
版权 
add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

  • 添加一个子目录并构建该子目录。

  • 命令解析

    • source_dir
      必选参数。该参数指定一个子目录，子目录下应该包含CMakeLists.txt文件和代码文件。子目录可以是相对路径也可以是绝对路径，如果是相对路径，则是相对当前目录的一个相对路径。
    • binary_dir
      可选参数。该参数指定一个目录，用于存放输出文件。可以是相对路径也可以是绝对路径，如果是相对路径，则是相对当前输出目录的一个相对路径。如果该参数没有指定，则默认的输出目录使用source_dir。
    • EXCLUDE_FROM_ALL
      可选参数。当指定了该参数，则子目录下的目标不会被父目录下的目标文件包含进去，父目录的CMakeLists.txt不会构建子目录的目标文件，必须在子目录下显式去构建。例外情况：当父目录的目标依赖于子目录的目标，则子目录的目标仍然会被构建出来以满足依赖关系（例如使用了target_link_libraries）。

一、案例一

目录结构及说明如下：

├── CMakeLists.txt    #父目录的CMakeList.txt
├── main.cpp    #源文件，包含main函数
├── sub    #子目录
 └── CMakeLists.txt    #子目录的CMakeLists.txt
 └── test.h    #子目录头文件
 └── test.cpp    #子目录源文件
 

子目录sub 下的test.cpp定义了一个函数test()，将输入参数打印出来，相应的头文件test.h则对test()进行声明，CMakelists.txt则将sub下的源文件编译成库文件。

//  sub/test.cpp  
#include "test.h"
#include <iostream>

void test(std::string str)
{
    std::cout << str << std::endl;
}

//  sub/test.h
#include <string>

void test(std::string str);

# sub/CMakeLists.txt
cmake_minimum_required(VERSION 3.10.2)
project(sub)
add_library(sub test.cpp)

# 父目录下的CMakeLists.txt
cmake_minimum_required(VERSION 3.10.2)
project(test)

add_subdirectory(sub)

在父目录下调用cmake .构建之后，在sub目录下会出现libsub.a库，说明当不指定binary_dir，输出目标文件就会放到source_dir目录下。

# 父目录下的CMakeLists.txt
cmake_minimum_required(VERSION 3.10.2)
project(test)

add_subdirectory(sub output)

在父目录下调用cmake .构建之后，在output目录下会出现libsub.a库，sub目录下则没有libsub.a。说明当指定binary_dir，输出目标文件就会放到binary_dir目录下。

# 父目录下的CMakeLists.txt
cmake_minimum_required(VERSION 3.10.2)
project(test)

add_subdirectory(sub output EXCLUDE_FROM_ALL) 
add_executable(test main.cpp)

在父目录下调用cmake .构建之后，在output目录或sub目录下不会出现libsub.a库，说明当指定EXCLUDE_FROM_ALL选项，子目录的目标文件不会生成。

# 父目录下的CMakeLists.txt
cmake_minimum_required(VERSION 3.10.2)
project(test)

add_subdirectory(sub output EXCLUDE_FROM_ALL) 
add_executable(test main.cpp)
target_link_libraries(test sub)

在父目录下调用cmake .构建之后，在output目录会出现libsub.a库，说明即使指定EXCLUDE_FROM_ALL选项，当父目录目标文件对子目录目标文件存在依赖关系时，子目录的目标文件仍然会生成以满足依赖关系。

  • 场景1：父目录CMakeLists.txt的add_subdirectory 只指定了source_dir。
  • 场景2：父目录CMakeLists.txt的add_subdirectory 指定了source_dir和binary_dir。
  • 场景3：父目录CMakeLists.txt的add_subdirectory 指定了EXCLUDE_FROM_ALL选项。
  • 场景4：父目录CMakeLists.txt的add_subdirectory 指定了EXCLUDE_FROM_ALL选项，且父目录的目标文件依赖子目录的目标文件。

 
最后，以一个完整的例子来结束本文（sub目录下的CMakeList.txt、test.h、test.cpp等文件内容如上文所示，没有变化），父目录下的main.cpp和CMakeList.txt如下：

# 父目录下的CMakeLists.txt
cmake_minimum_required(VERSION 3.10.2)
project(test)

include_directories(sub)
add_subdirectory(sub output) 

add_executable(test main.cpp)
target_link_libraries(test sub)

# 父目录下的main.cpp
#include "test.h"
#include <iostream>

int main(int argc, char** argv)
{
    std::cout << "In main..." << std::endl;
    test("hello, world!");
    return 0;
}


# 输出
> cmake --build .
Scanning dependencies of target sub
[ 25%] Building CXX object output/CMakeFiles/sub.dir/test.cpp.o
[ 50%] Linking CXX static library libsub.a
[ 50%] Built target sub
Scanning dependencies of target test
[ 75%] Building CXX object CMakeFiles/test.dir/main.cpp.o
[100%] Linking CXX executable test
[100%] Built target test
>./test
In main...
hello, world!

二、案例二

#CMakeLists.txt test_xlog  xlog 109cmake_out
cmake_minimum_required(VERSION 3.20)
project(xlog)
include_directories("xlog")

#CMakeLists.txt路径
message("CMAKE_CURRENT_LIST_DIR = ${CMAKE_CURRENT_LIST_DIR}")


# ============================= linux静态.so库输出路径【默认路径在-B build目录下】 =============================
#linux .so输出路径
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_LIST_DIR}/lib")

# ============================= 执行程序输出路径 =============================
#执行程序、dll动态库、pdb调试文件
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_LIST_DIR}/bin")

# ============================= 归档输出路径 =============================
# 静态库 .lib 动态库.lib地址文件 linux静态库.a 静态库pdb调试文件
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_CURRENT_LIST_DIR}/lib")

set(BUILD_SHARED_LIBS ON) #动态库

# 添加子项目
add_subdirectory("xlog")
add_subdirectory("test_xlog")
(base) wyr@Beyond-PC:~/cpp_study/cmake_study/2-第2章CMake常用功能/32cmake add_subdirectory/110add_subdirectory$ ll
total 20
drwxr-xr-x 4 wyr wyr 4096 May 29 22:52 ./
drwxr-xr-x 3 wyr wyr 4096 May 29 22:52 ../
-rw-r--r-- 1 wyr wyr 1430 Jun  4 00:50 CMakeLists.txt
drwxr-xr-x 2 wyr wyr 4096 May 29 22:52 test_xlog/
drwxr-xr-x 2 wyr wyr 4096 May 29 22:52 xlog/
(base) wyr@Beyond-PC:~/cpp_study/cmake_study/2-第2章CMake常用功能/32cmake add_subdirectory/110add_subdirectory$ cmake -S . -B build
-- The C compiler identification is GNU 11.3.0
-- The CXX compiler identification is GNU 11.3.0
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
CMAKE_CURRENT_LIST_DIR = /home/wyr/cpp_study/cmake_study/2-第2章CMake常用功能/32cmake add_subdirectory/110add_subdirectory
MSVC = 
WIN32 = 
UNIX = 1
CMAKE_SYSTEM_NAME = Linux
-- Configuring done
-- Generating done
-- Build files have been written to: /home/wyr/cpp_study/cmake_study/2-第2章CMake常用功能/32cmake add_subdirectory/110add_subdirectory/build
(base) wyr@Beyond-PC:~/cpp_study/cmake_study/2-第2章CMake常用功能/32cmake add_subdirectory/110add_subdirectory$ cd build/
(base) wyr@Beyond-PC:~/cpp_study/cmake_study/2-第2章CMake常用功能/32cmake add_subdirectory/110add_subdirectory/build$ cmake --build .
CMAKE_CURRENT_LIST_DIR = /home/wyr/cpp_study/cmake_study/2-第2章CMake常用功能/32cmake add_subdirectory/110add_subdirectory
MSVC = 
WIN32 = 
UNIX = 1
CMAKE_SYSTEM_NAME = Linux
-- Configuring done
-- Generating done
-- Build files have been written to: /home/wyr/cpp_study/cmake_study/2-第2章CMake常用功能/32cmake add_subdirectory/110add_subdirectory/build
[ 25%] Building CXX object xlog/CMakeFiles/xlog.dir/xlog.cpp.o
[ 50%] Linking CXX shared library ../../lib/libxlog.so
[ 50%] Built target xlog
[ 75%] Building CXX object test_xlog/CMakeFiles/test_xlog.dir/test_xlog.cpp.o
[100%] Linking CXX executable ../../bin/test_xlog
[100%] Built target test_xlog
(base) wyr@Beyond-PC:~/cpp_study/cmake_study/2-第2章CMake常用功能/32cmake add_subdirectory/110add_subdirectory/build$

Cmake命令之add_subdirectory介绍 - 简书

cmake | add_subdirectory的使用_cmake subdirectory-CSDN博客

u013250861
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
CMake入门教程【核心篇】添加子目录(add_subdirectory)
小鱼酱的博客
01-02 1690
CMake添加子目录add_subdirectory
CMake入门二——子目录的嵌套
weixin_44688770的博客
02-02 3125
CMake入门
cmake add_subdirectory 详解
qq_37805392的博客
06-27 439
在 CMake 中，add_subdirectory 命令用于向当前项目添加一个子目录，并且使得 CMake 在构建过程中进入该子目录继续处理其中的 CMakeLists.txt 文件。这个命令通常用于管理项目中的多个模块或子项目。
cmake：add_subdirectory
OceanStar的博客
07-02 6009
add_subdirectory 向构建添加一个子目录。 add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL]) 向构建添加子目录。 source_dir指定源CMakeLists.txt和代码文件所在的目录。如果它是一个相对路径，它将相对于当前目录进行计算(典型用法)，但它也可能是一个绝对路径。 binary_dir指定放置输出文件的目录。如果它是一个相对路径，它将相对于当前输出目录进行计算，但它也可能是一个绝对路径。如果没有指定bina
cmake错误集锦：add_subdirectory()
KingOfMyHeart的博客
03-16 4586
在组织公司工程目录结构时，报了一个关于add_subdirectory()的错误： add_subdirectory not give a binary directory but give source directory 看名字我们就知道，该指令是需要包含当前目录下的子目录的，但是发现，当前CMakeLists.txt中却用add_subdirectory()包含了当前路径的上层某些目录A，到时报错。 解决： 当然是使目录A的上级CMakeLists.txt中包含编译目录A了。因为cmake都是从顶级
CMake常用命令（四）add_subdirectory命令 添加子目录
qq_26849933的博客
10-01 2788
添加一个子目录并构建该子目录，告诉CMAKE我还有其它子目录的CMakeList.txt需要编译。
CMake4-指令1-1：add_executable【基于特定的源文件（入口源文件），创建可执行文件】
u013250861的博客
06-08 338
该命令将添加一个名为的可执行目标，由命令调用中列出的源文件构建。对应于逻辑目标名称，在项目中必须是全局唯一的。构建的可执行文件的实际文件名基于原生平台的约定构建（例如.exe或仅仅是$默认情况下，可执行文件将在构建树目录中创建，该目录对应于调用命令的源树目录。请参阅目标属性的文档以更改此位置。请参阅目标属性的文档以更改最终文件名的部分。有关定义构建系统属性的更多信息，请参阅手册。
cmake:用add_subdirectory()添加外部项目文件夹
热门推荐
10km的专栏
07-12 5万+
一般情况下，我们的项目各个子项目都在一个总的项目根目录下，但有的时候，我们需要使用外部的文件夹，怎么办呢？ add_subdirectory命令，可以将指定的文件夹加到build任务列表中。下面是将与当前项目平级的一个目录下的子目录用add_subdirectory命令加进来的CMakelists.txt脚本片段 ：#定义CASSDK位置 if(NOT CASSDK_DIR) set( C
cmake：add_subdirectory() 注意事项
pytorch内部机制解读
07-21 2422
有这样一种情况。自己写了一个库，需要写测试程序。类似如下结构： hello-world/ ├── CMakeLists.txt ├── main.c ├── test │ ├── CMakeLists.txt │ └── main.c ├── hello │ ├── CMakeLists.txt │ ├── hello.c │ └── hello.h └── world ├── CMakeLists.txt ├── world.c └── world.h``` h
CMake学习（3）—— 使用add_subdirectory()添加外部项目文件夹
hezhanran的博客
04-01 5584
        一般情况下，我们的项目各个子项目都在一个总的项目根目录下，但有的时候，我们需要使用外部的文件夹，怎么办呢？例如，在目录cxx/utility/example内的CMakeLists.txt要引用上层目录cxx/utility的CMakeLists.txt：         通常，如果在cxx/utility/example内的CMak
cmake-3.20.4-linux-x86_64.tar.gz
01-31
9. **CMake组件和目标**：通过`add_subdirectory()`可以添加子目录的CMakeLists.txt，`add_component()`和`add_executable()`创建组件和可执行目标，`add_dependencies()`定义依赖关系。 10. **测试与覆盖率**：...
cmake-3.27.8-linux-x86_64.tar.gz
01-31
2. **源代码目录结构**：CMake允许项目有复杂的源代码结构，它可以通过`add_subdirectory()`命令来管理子目录中的CMakeLists.txt文件。 3. **目标（Target）**：在CMake中，一个目标可以是库（library）或可执行...
cmake-3.16.6-Linux-x86_64.tar.gz
04-27
例如，`find_package()`函数可以帮助查找已安装的库，而`add_subdirectory()`可以将子目录添加为单独的构建单元。 总结来说，CMake是一个强大的构建工具，提供了灵活的配置机制和跨平台支持。它简化了大型项目或...
cmake-3.9.1-linux-x86_64.tar.gz
08-17
3. **创建链接**：接下来，创建符号链接以将CMake命令添加到系统的PATH环境变量中： ```bash sudo ln -s /usr/local/cmake-3.9.1-Linux-x86_64/bin/cmake /usr/local/bin/cmake ``` 4. **验证安装**：安装完成后...
CMake添加引用多个子目录多个CMakeLists同时编译
09-10
在CMake构建系统中，管理和编译多个源代码子目录是一项常见的需求。"CMake添加引用多个子目录多个CMakeLists同时编译"的主题旨在教你如何有效地组织项目结构，并使用CMake来处理复杂的多目录工程。下面将详细介绍...
C语言 之 理解指针（1）
fallzzzzz的博客
07-20 1299
就是先获取该数组的首元素的地址，从前面我们知道，指针的类型的作用是指针+1 所跳过的字节数，int为整形，大小为4个字节，所以p+1就跳过4个字节，p+2就跳过8个字节，计算机的CPU（中央处理器）在处理数据的时候，需要的数据是在内存中读取的，处理后数据也会放回内存中，如果想对这些空间进行高效的管理，就可以。并且我们知道，数组的元素存放是随着下标增长，内存地址变大的。上面的代码创建了一个整型变量n，因为一个整形的大小是4个字节，所以内存中申请了4个字节，⽤于存放整数10，其中每个字节都有地址。
VS2019编译和使用gtest测试（C++）
最新发布
m0_65635427的博客
07-24 315
下载下来解压到文件夹，再在文件夹里面新建一个build文件夹，如下：再安装cmake，可以先检查一下是否安装了cmake，打开命令窗口，输入cmake -version：然后双击就对了，我这里已经安装好了，无法提供截图，注意一点就是在让选择是否建立系统环境变量（path）的时候，记得勾上第二个建立系统环境变量！下载好之后，记得检验一下是否安装成功，如果在普通用户下显示没有，建议用管理员身份打开命令窗口，再次尝试。之后命令窗口进入创建的build文件夹路径里面执行cmake ../
内网对抗-隧道技术篇&防火墙组策略&HTTP反向&SSH转发&出网穿透&CrossC2&解决方案
siu~
07-24 861
1、C2/C2上线-CrossC2插件-多系统平台支持 2、隧道技术篇-应用层-SSH协议-判断&封装&建立&穿透 3、隧道技术篇-应用层-HTTP协议-判断&封装&建立&穿透
你的回答报错CMake Error at CMakeLists.txt:14 (add_subdirectory): add_subdirectory called with incorrect number of arguments
06-09
正确的方法是，在上层CMakeLists.txt中定义`${CMAKE_INSTALL_PREFIX}`变量，然后在子目录的CMakeLists.txt中使用`set`命令将`${CMAKE_INSTALL_PREFIX}`变量的值传递给子目录中的目标。 例如，在上层CMakeLists.txt...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值