[cmake]cmake编译目录包含命令include_directories简介

于 2024-03-27 06:39:41 发布
阅读量1k 收藏 22
点赞数 25
分类专栏： cmake 文章标签： windows c++ linux
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/FL1768317420/article/details/137063546
版权

  • include_directories

    命令格式：

    include_directories([AFTER|BEFORE] [SYSTEM] dir1 [dir2 ...])

    该命令主要是将目录添加到编译器的头文件的搜索目录之下，具体介绍见这里。执行该命令后，会将指定的目录添加到当前CMakeLists.txt文件的INCLUDE_DIRECTORIES目录属性和INCLUDE_DIRECTORIES目标文件属性中。接下来看一个实例，看include_directories添加目录之后，INCLUDE_DIRECTORIES属性内容的变化。目录结构如下，后续没有特殊说明，执行命令的目录为include_directories：

    include_directories/
├── CMakeLists.txt
├── main.cpp
├── testdir1
│   ├── CMakeLists.txt
│   ├── test1.cpp
│   └── test1.h
│   └── testdir1_subdir
└── testdir2
    ├── CMakeLists.txt
    ├── test2.cpp
    └── test2.hs

    include_directories/CMakeLists.txt内容如下：

    cmake_minimum_required(VERSION 3.22)
project(dir_test)

include_directories(testdir1)
message("--$ include_directories: testdir1")


# 获取当前文件的INCLUDE_DIRECTORIES目录属性
get_property(dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("--$ in directory: ${CMAKE_CURRENT_SOURCE_DIR}, include dir list: ${dirs}")

# 编译testdir1下的库
add_subdirectory(testdir1)
message("--$ after compile lib test1")
get_property(dirs TARGET test1 PROPERTY INCLUDE_DIRECTORIES)
message("--$ lib test1 include dir list: ${dirs}")
get_property(dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("--$ current file include dir list: ${dirs}")


# 编译testdir2下的库
add_subdirectory(testdir2)
message("--$ after compile lib test2")
get_property(dirs TARGET test1 PROPERTY INCLUDE_DIRECTORIES)
message("--$ lib test1 include dir list: ${dirs}")
get_property(dirs TARGET test2 PROPERTY INCLUDE_DIRECTORIES)
message("--$ lib test2 include dir list: ${dirs}")
get_property(dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("--$ current file include dir list: ${dirs}")


add_executable(main main.cpp)
message("--$ after add exe main")
get_property(dirs TARGET test1 PROPERTY INCLUDE_DIRECTORIES)
message("--$ lib test1 include dir list: ${dirs}")
get_property(dirs TARGET test2 PROPERTY INCLUDE_DIRECTORIES)
message("--$ lib test2 include dir list: ${dirs}")
get_property(dirs TARGET main PROPERTY INCLUDE_DIRECTORIES)
message("--$ executable main include dir list: ${dirs}")
get_property(dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("--$ current file include dir list: ${dirs}")
message("---")


target_link_libraries(main test1)
message("--$ after add lib test1")
get_property(dirs TARGET test1 PROPERTY INCLUDE_DIRECTORIES)
message("--$ lib test1 include dir list: ${dirs}")
get_property(dirs TARGET test2 PROPERTY INCLUDE_DIRECTORIES)
message("--$ lib test2 include dir list: ${dirs}")
get_property(dirs TARGET main PROPERTY INCLUDE_DIRECTORIES)
message("--$ executable main include dir list: ${dirs}")
get_property(dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("--$ current file include dir list: ${dirs}")
message("---")


target_link_libraries(main test2)
message("--$ after add lib test2")
get_property(dirs TARGET test1 PROPERTY INCLUDE_DIRECTORIES)
message("--$ lib test1 include dir list: ${dirs}")
get_property(dirs TARGET test2 PROPERTY INCLUDE_DIRECTORIES)
message("--$ lib test2 include dir list: ${dirs}")
get_property(dirs TARGET main PROPERTY INCLUDE_DIRECTORIES)
message("--$ executable main include dir list: ${dirs}")
get_property(dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("--$ current file include dir list: ${dirs}")
message("---")


include_directories(testdir2)
message("--$ include_directories: testdir2")
get_property(dirs TARGET test1 PROPERTY INCLUDE_DIRECTORIES)
message("--$ lib test1 include dir list: ${dirs}")
get_property(dirs TARGET test2 PROPERTY INCLUDE_DIRECTORIES)
message("--$ lib test2 include dir list: ${dirs}")
get_property(dirs TARGET main PROPERTY INCLUDE_DIRECTORIES)
message("--$ executable main include dir list: ${dirs}")
get_property(dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("--$ current file include dir list: ${dirs}")
message("---")

    include_directories/main.cpp内容：

    #include "test1.h"
#include "test2.h"

int main(int argc, char** argv)
{
    test1_print();
    test2_print();
}

    include_directories/testdir1/CMakeLists.txt内容如下：

    message("---")
message("---Enter directory: ${CMAKE_CURRENT_SOURCE_DIR}")

include_directories(testdir1_subdir)

# 获取当前文件的INCLUDE_DIRECTORIES目录属性
get_property(dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("   --$ include dir list: ${dirs}")

add_library(test1 test1.cpp)
message("   --$ after add lib test1")
get_property(dirs TARGET test1 PROPERTY INCLUDE_DIRECTORIES)
message("   --$ lib test1 include dir list: ${dirs}")
get_property(dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("   --$ current file include dir list: ${dirs}")

message("---Exist directory: ${CMAKE_CURRENT_SOURCE_DIR}")
message("---")

    include_directories/testdir1/test1.cpp和include_directories/testdir1/test1.h文件内容如下：

    // test1.h
#ifndef __TEST1_T__
#define __TEST1_T__

void test1_print();

#endif

// test1.cpp
#include "test1.h"
#include <iostream>

void test1_print()
{
    std::cout << "From test1: hello!" << std::endl;
}

    include_directories/testdir2/CMakeLists.txt内容如下：

    message("---")
message("---Enter directory: ${CMAKE_CURRENT_SOURCE_DIR}")

# 获取当前文件的INCLUDE_DIRECTORIES目录属性
get_property(dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("   --$ include dir list: ${dirs}")

add_library(test2 test2.cpp)
message("   --$ after add lib test2")
get_property(dirs TARGET test2 PROPERTY INCLUDE_DIRECTORIES)
message("   --$ lib test2 include dir list: ${dirs}")
get_property(dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("   --$ current file include dir list: ${dirs}")

message("---Exist directory: ${CMAKE_CURRENT_SOURCE_DIR}")
message("---")

    include_directories/testdir2/test2.cpp和include_directories/testdir2/test2.h文件内容如下：

    // test2.h
#ifndef __TEST2_T__
#define __TEST2_T__

void test2_print();

#endif

// test2.cpp
#include "test2.h"
#include <iostream>

void test2_print()
{
    std::cout << "From test2: hello!" << std::endl;
}

    运行cmake .、make以及./main等命令，关键输出如下：

    $cmake .
……
--$ include_directories: testdir1
--$ in directory: /XXX/include_directories, include dir list: /XXX/include_directories/testdir1
---
---Enter directory: /XXX/include_directories/testdir1
   --$ include dir list: /XXX/include_directories/testdir1;/XXX/include_directories/testdir1/testdir1_subdir
   --$ after add lib test1
   --$ lib test1 include dir list: /XXX/include_directories/testdir1;/XXX/include_directories/testdir1/testdir1_subdir
   --$ current file include dir list: /XXX/include_directories/testdir1;/XXX/include_directories/testdir1/testdir1_subdir
---Exist directory: /XXX/include_directories/testdir1
---
--$ after compile lib test1
--$ lib test1 include dir list: /XXX/include_directories/testdir1;/XXX/include_directories/testdir1/testdir1_subdir
--$ current file include dir list: /XXX/include_directories/testdir1
---
---Enter directory: /XXX/include_directories/testdir2
   --$ include dir list: /XXX/include_directories/testdir1
   --$ after add lib test2
   --$ lib test2 include dir list: /XXX/include_directories/testdir1
   --$ current file include dir list: /XXX/include_directories/testdir1
---Exist directory: /XXX/include_directories/testdir2
---
--$ after compile lib test2
--$ lib test1 include dir list: /XXX/include_directories/testdir1;/XXX/include_directories/testdir1/testdir1_subdir
--$ lib test2 include dir list: /XXX/include_directories/testdir1
--$ current file include dir list: /XXX/include_directories/testdir1
--$ after add exe main
--$ lib test1 include dir list: /XXX/include_directories/testdir1;/XXX/include_directories/testdir1/testdir1_subdir
--$ lib test2 include dir list: /XXX/include_directories/testdir1
--$ executable main include dir list: /XXX/include_directories/testdir1
--$ current file include dir list: /XXX/include_directories/testdir1
---
--$ after add lib test1
--$ lib test1 include dir list: /XXX/include_directories/testdir1;/XXX/include_directories/testdir1/testdir1_subdir
--$ lib test2 include dir list: /XXX/include_directories/testdir1
--$ executable main include dir list: /XXX/include_directories/testdir1
--$ current file include dir list: /XXX/include_directories/testdir1
---
--$ after add lib test2
--$ lib test1 include dir list: /XXX/include_directories/testdir1;/XXX/include_directories/testdir1/testdir1_subdir
--$ lib test2 include dir list: /XXX/include_directories/testdir1
--$ executable main include dir list: /XXX/include_directories/testdir1
--$ current file include dir list: /XXX/include_directories/testdir1
---
--$ include_directories: testdir2
--$ lib test1 include dir list: /XXX/include_directories/testdir1;/XXX/include_directories/testdir1/testdir1_subdir
--$ lib test2 include dir list: /XXX/include_directories/testdir1
--$ executable main include dir list: /XXX/include_directories/testdir1;/XXX/include_directories/testdir2
--$ current file include dir list: /XXX/include_directories/testdir1;/XXX/include_directories/testdir2
---
-- Configuring done
-- Generating done
-- Build files have been written to: /XXX/include_directories

$ make
Consolidate compiler generated dependencies of target test2
[ 16%] Building CXX object testdir2/CMakeFiles/test2.dir/test2.cpp.o
[ 33%] Linking CXX static library libtest2.a
[ 33%] Built target test2
Consolidate compiler generated dependencies of target test1
[ 66%] Built target test1
Consolidate compiler generated dependencies of target main
[ 83%] Building CXX object CMakeFiles/main.dir/main.cpp.o
[100%] Linking CXX executable main
[100%] Built target main

$ ./main 
From test1: hello!
From test2: hello!

    以上结果表明了几点：

    1、include_directories添加的目录，会自动添加到当前所在的CMakeLists.txt文件的INCLUDE_DIRECTORIES目录属性，以及在当前CMakeLists.txt文件中定义的目标（通过add_executable/add_library等添加的目标）属性INCLUDE_DIRECTORIES中。

    2、include_directories添加的目录，会传递到当前所在CMakeLists.txt文件中通过add_subdirectory增加的下层CMakeLists.txt中（add_subdirectory语句之后调用的include_directories添加的目录无法传递）。

    3、下层CMakeLists.txt文件中调用的include_directories添加的目录，不会传递到调用它的上层CMakeLists.txt文件。

    4、上层CMakeLists.txt中的include_directories与add_subdirectory相对位置对子CMakeLists.txt中能看到的目录有影响。

    对我们的例子来说：

    1、可执行文件main能看到目录：testdir1、testdir2

    2、库文件test1能看到目录：testdir1、testdir1_subdir，无法看到testdir2，是因为调用add_subdirectory添加子目录testdir1时，还未通过include_directories包含testdir2

    3、库文件test2能看到目录：testdir1，没错！这意味对于本文的例子来说，test2.cpp可以直接包含test1.h文件并调用test1_print()接口

FL1768317420
关注
  • 25
    点赞
  • 踩
  • 22
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Cmake中include(ExternalProject)的用法
07-03
写CmakeLists.txt时，有时需要include(ExternalProject)，但是Cmake官网教程对此部分没有详细叙述。本人经过辛苦查找，终于找到关于ExternalProject的教程，分享给大家。
CMake添加引用多个子目录多个CMakeLists同时编译
09-10
CMake添加引用多个子目录多个CMakeLists同时编译
CMake中include_directories的使用
网络资源是无限的
11-26 1万+
CMake中include_directories的使用
CMake中include指令介绍
热门推荐
liitdar的博客
07-21 6万+
本文主要介绍 CMake 中 include 指令的相关知识。引用 CMake 官网中对于 include 指令的介绍，如下：include 指令的用法如下：详细描述如下：从上述内容可知，include 指令用来载入并运行来自于文件或模块的 CMake 代码。在这里针对一些具体的问题场景，介绍 include 指令的具体用法。有时遇到这样一种需求，在使用同一个外层 CMakeLists.txt 的前提下，每个源码子目录中要求使用的 C++ 标准版本不同，有的源码要求使用 C++98 标准编译、有的源码要求使
CMAKE : INCLUDE命令
RobotLife的博客
12-30 6575
指令：include 作用：从文件或模块加载并运行CMake代码。 形式： include(&lt;file|module&gt; [OPTIONAL] [RESULT_VARIABLE ] [NO_POLICY_SCOPE]) 说明： 变量读写范围为调用此指令的调用者的范围，因此，具有动态范围即取决于调用者； 如果“OPTIONAL”被指定，则指定的文件不存在时，不会产生任何错误； 如果“RE...
CMakeLists之include_directories
小吴同学的小屋
08-15 4805
CMakeLists之include_directories 最近在写CMakeLists的时候遇到了一些问题，在这里记录一下我解决的方案 下面是一个简单的demo 项目的结构如图左边所示。test.h在python文件夹下的include文件夹里面，test.cpp在python文件夹下面的src里面，CMakeLists如下所示 cmake_minimum_required(VERSION 3.4.1) project(demo) include_directories( ${CMAKE_CU
OpenCV 编译流程.rar_cmake_opencv_编译
09-20
opencv编译流程，讲述了如何用cmake编译opencv。
cmake_test cmake_test cmake_test
04-18
cmake_test
cmake编译opencv_contrib缺失文件.zip
02-28
我是用vs19+opencv4.5.1配置contrib4.5.1的拓展包，但是这些东西通用，按着编译日志改MD5值就可以，里面文件包括： ffmpeg_version.cmake、vgg_generated_***.i（48、64、80、120）、boostdesc_lbgm.i、boostdesc_...
CMake交叉编译配置
11-05
Cmake交叉编译环境配置文档 1、设置交叉编译之前，必须在CMake...2、在通知CMake要交叉编译以后，还要告诉CMake到哪个路径下去找库文件，因为在交叉编译的时候CMake是不会自动去系统默认的目录找库文件和头文件的：...
Linux--Cmakelists.txt中关于include_directories，link_directories，link_libraries和target_link_libraries解析
alan711的博客
01-09 1万+
总结一下include_directories，link_directories，link_libraries和target_link_libraries(此处大小写字母皆可)的作用。 1.INCLUDE_DIRECTORIES（添加头文件目录） 它相当于g++选项中的-I参数的作用，也相当于环境变量中增加路径到CPLUS_INCLUDE_PATH变量的作用（这里特指c++。c和Java中用法类似...
Cmake命令之include_directories介绍
sinat_31608641的博客
12-01 2万+
一、介绍 命令格式 include_directories ([AFTER|BEFORE] [SYSTEM] dir1 [dir2 ...]) 将指定目录添加到编译器的头文件搜索路径之下，指定的目录被解释成当前源码路径的相对路径。 命令解析   默认情况下，include_directories命令会将目录添加到列表最后，可以通过命令设置CMAKE_INCLUDE_DIRECTORIES_BEFORE变量为ON来改变它默认行为，将目录添加到列表前面。也可以在每次调用incl
CMake系列讲解（入门篇）1.6 基础命令CMake-include_directories()
在下马农的碎碎念
09-05 1113
本文介绍了如何使用CMake中的include_directories命令来优化项目结构和提高编译过程的效率。首先，我们明确了include_directories命令的作用和用法，它能够指定需要包含的头文件目录，使得编译器可以正确地找到所需的头文件。然后，我们详细解释了如何在CMakeLists.txt文件中使用include_directories命令，包括指定单个目录、多个目录和相对路径的方法。接着，我们介绍了include_directories命令的几个优势，如简化代码、提高可维护性和可移植性等。
【CMake】cmake中的include指令（.cmake文件/MACRO宏/function函数）
Yngz_Miao的博客
10-24 4万+
说到cmake，可能最先想到的就是CmakeLists.txt文件，但是在很多情况下，也会看到.cmake文件。也许，你会诧异，.cmake文件是干什么的，甚至会想.cmake文件是不是cmake的正统文件，而CmakeLists.txt并不是。 但其实，CmakeLists.txt才是cmake的正统文件，而.cmake文件是一个模块文件，可以被include到CMakeLists.txt中。 ...
cmake(三十五)Cmake之include指令
wzj_110的博客
05-11 7263
一 CMakeLists.txt和cmake脚本的联系和区别 ① cmake脚本 (1) cmake文件里面通常是'什么信息(information)' -- '.cmake文件'里包含了一些"公共(复用)"的'cmake命令'和一些'宏|函数' -- 当CMakeLists.txt'包含该.cmake文件'时,当'编译'运行时,该.cmake里的一些命令就会在该'包含处'得到加载'执行',在'后续'能够'调用该.cmake里'的一些宏和函数 -- .cmake文件是一个'模块...
CMake中include的使用
网络资源是无限的
10-30 4226
CMake中include的使用
【cmake学习】cmake 引入第三方库（头文件目录、库目录、库文件）
challenglistic的博客
02-17 4万+
【cmake学习】cmake 引入第三方库（头文件目录、库目录、库文件）
CMakeLists配置(常用的）
axx的博客
05-16 2207
一：
cmake target_link_libraries target_include_directories用法
最新发布
09-08
对于 CMake 中的 target_link_libraries 和 target_include_directories，它们分别用于指定目标的依赖库和包含目录。 target_link_libraries 用于将依赖库与目标进行关联。它的语法如下： ``` target_link_libraries(target_name library_name1 library_name2 ...) ``` 其中，target_name 是你要关联的目标名称，library_name1、library_name2 等是你要链接的库的名称。这些库可以是预编译的静态库（.a 文件）或共享库（.so 文件），也可以是系统提供的库名称（例如 pthread、m 等）。 例如，如果你有一个名为 myapp 的可执行文件目标，并且需要链接 libfoo.so 和 libbar.a 两个库，你可以这样写： ``` target_link_libraries(myapp foo bar) ``` target_include_directories 用于指定目标的包含目录，以便编译器能够找到头文件。它的语法如下： ``` target_include_directories(target_name PRIVATE include_dir1 include_dir2 ...) ``` 其中，target_name 是你要指定包含目录的目标名称，include_dir1、include_dir2 等是你要添加的包含目录路径。 例如，如果你有一个名为 myapp 的目标，并且需要添加 include 目录作为包含目录，你可以这样写： ``` target_include_directories(myapp PRIVATE include) ``` 这样，编译器在编译 myapp 目标时就能够找到 include 目录下的头文件了。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

FL1768317420

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值