Cmake命令之include_directories介绍

  • 命令格式

    include_directories ([AFTER|BEFORE] [SYSTEM] dir1 [dir2 ...])
    将指定目录添加到编译器的头文件搜索路径之下,指定的目录被解释成当前源码路径的相对路径。

  • 命令解析

      默认情况下,include_directories命令会将目录添加到列表最后,可以通过命令设置CMAKE_INCLUDE_DIRECTORIES_BEFORE变量为ON来改变它默认行为,将目录添加到列表前面。也可以在每次调用include_directories命令时使用AFTERBEFORE选项来指定是添加到列表的前面或者后面。如果使用SYSTEM选项,会把指定目录当成系统的搜索目录。该命令作用范围只在当前的CMakeLists.txt。
    一、include_directories命令的基本行为:

    #CMakeLists.txt
    cmake_minimum_required(VERSION 3.18.2)
    project(include_directories_test)
    
    include_directories(sub) 
    include_directories(sub2) #默认将sub2添加到列表最后
    include_directories(BEFORE sub3) #可以临时改变行为,添加到列表最前面
    
    get_property(dirs DIRECTORY ${CMAKE_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
    message(">>> include_dirs=${dirs}") #打印一下目录情况
    
    set(CMAKE_INCLUDE_DIRECTORIES_BEFORE ON) #改变默认行为,默认添加到列表前面
    include_directories(sub4)
    include_directories(AFTER sub5) #可以临时改变行为,添加到列表的最后
    get_property(dirs DIRECTORY ${CMAKE_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
    message(">>> SET DEFAULT TO BEFORE, include_dirs=${dirs}")
    
    #输出
    >>> include_dirs=/XXX/XXX/sub3;/XXX/XXX/sub;/XXX/XXX/sub2
    >>> SET DEFAULT TO BEFORE, include_dirs=/XXX/XXX/sub4;/XXX/XXX/sub3;/XXX/XXX/sub;/XXX/XXX/sub2;/XXX/XXX/sub5
    

    二、下面结合实际的头文件包含来说明其用法,创建的文件和目录结构及说明如下:

    ├── CMakeLists.txt    #最外层的CMakeList.txt
    ├── main.cpp    #源文件,包含被测试的头文件
    ├── sub    #子目录
     └── test.h    #测试头文件,是个空文件,被外层的main,cpp包含

    • 场景1:不使用include_directories包含子目录sub,直接在main.cpp里面包含"test.h"
    # CMakeList.txt
    cmake_minimum_required(VERSION 3.18.2)
    project(include_directories_test)
    add_executable(test main.cpp)
    
    //main.cpp
    #include "test.h"
    #include <stdio.h>
    int main(int argc, char **argv)
    {
        printf("hello, world!\n");
        return 0;
    }
    

    执行cmake --build .,会提示找不到头文件的错误:

    fatal error: 'test.h' file not found 
    #include "test.h"
    
    • 场景2:使用include_directories包含子目录sub,并在main.cpp里面包含"test.h"
    # CMakeList.txt
    cmake_minimum_required(VERSION 3.18.2)
    project(include_directories_test)
    include_directories(sub) #与上个场景不同的地方在于此处
    add_executable(test main.cpp)
    
    //main.cpp
    #include "test.h"
    #include <stdio.h>
    int main(int argc, char **argv)
    {
        printf("hello, world!\n");
        return 0;
    }
    

    执行cmake --build .,会生成可执行文件test,使用./test执行后会输出打印hello, world!。当然,不使用include_directories(sub),在main.cpp中直接使用#include "sub/test.h"也是可以的。


附录:参考资料

  1. https://cmake.org/cmake/help/latest/command/include_directories.html#command:include_directories
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,657评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,662评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,143评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,732评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,837评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,036评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,126评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,868评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,315评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,641评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,773评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,859评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,584评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,676评论 2 351