CMake命令之target_include_directories简介

  • target_include_directories

    命令格式

    target_include_directories(<target> [SYSTEM] [AFTER|BEFORE]
    <INTERFACE|PUBLIC|PRIVATE> [items1...]
    [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])

    该命令给指定的目标文件添加头文件搜索目录,所以<target>必须用add_executable()或add_library()等命令先创建出来,和include_directories的主要差别是:

    • include_directories会对当前CMakeLists.txt文件的目标文件生效,并会通过add_subdirectory调用传递到子目录;target_include_directories则针对指定的目标文件生效。

    • target_include_directories对于指定目标添加的目录,有三种范围可选,PUBLIC、PRIVATE和INTERFACE。INTERFACE和PUBLIC会添加到<target>的INTERFACE_INCLUDE_DIRECTORIES属性,PUBLIC和PRIVATE会添加到<target>的INCLUDE_DIRECTORIES属性中。

参数选项

  • AFTER或BEFORE

    指定添加的目录是追加到头文件搜索目录列表,还是在头文件搜索目录列表的最前面插入。

  • SYSTEM

    该选项表明被添加的目录是系统目录,系统目录的搜索顺序在普通的头文件搜索目录之后,并且会添加到目标的INTERFACE_SYSTEM_INCLUDE_DIRECTORIES属性中。

  • INTERFACE或PUBLIC或PRIVATE

    指定添加到目标的范围属性,INTERFACE和PUBLIC会添加到<target>的INTERFACE_INCLUDE_DIRECTORIES属性,PUBLIC和PRIVATE会添加到<target>的INCLUDE_DIRECTORIES属性中。

示例说明

  • 为可执行文件添加头文件搜索目录

    目录结构

    target_include_directories/
    ├── CMakeLists.txt
    └── main.cpp
    

    CMakeLists.txt文件内容:

    cmake_minimum_required(VERSION 3.22)
    project(target_include_test)
    
    add_executable(main main.cpp)
    target_include_directories(main 
                                PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
    
    get_property(dirs_interface TARGET main PROPERTY INTERFACE_INCLUDE_DIRECTORIES)
    get_property(dirs_normal TARGET main PROPERTY INCLUDE_DIRECTORIES)
    message("# In parent scope, target main: interface[${dirs_interface}], normal[${dirs_normal}]")
    

    main.cpp文件内容:

    #include <iostream>
    
    int main(int argc, char** argv)
    {
        std::cout << "In main..." << std::endl;
        return 0;
    }
    

    在target_include_directories目录下,运行cmake .以及make VERBOSE=1,关键输出:

    $ cmake .
    ……
    # In parent scope, target main: interface[], normal[/XXX/target_include_directories]
    
    $ make VERBOSE=1
    ……
    /usr/bin/c++    -MD -MT CMakeFiles/main.dir/main.cpp.o -MF CMakeFiles/main.dir/main.cpp.o.d -o CMakeFiles/main.dir/main.cpp.o -c /XXX/target_include_directories/main.cpp
    
    $ ./main 
    In main...
    
  • 头文件目录的传递性

    目录结构:

    其中test编译为库文件,提供了一个test_print()的函数。

    target_include_directories/
    ├── CMakeLists.txt
    ├── main.cpp
    └── test
        ├── CMakeLists.txt
        ├── test.cpp
        └── test.h
    
    1)可执行文件main不添加test目录,库文件编译时添加INTERFACE范围的test目录

    target_include_directories/CMakeLists.txt文件内容:

    cmake_minimum_required(VERSION 3.22)
    project(target_include_test)
    
    add_subdirectory(test)
    
    add_executable(main main.cpp)
    
    get_property(dirs_interface TARGET main PROPERTY INTERFACE_INCLUDE_DIRECTORIES)
    get_property(dirs_normal TARGET main PROPERTY INCLUDE_DIRECTORIES)
    message("# In parent scope, target main property: interface[${dirs_interface}], normal[${dirs_normal}]")
    
    target_link_libraries(main test)
    get_property(dirs_interface TARGET main PROPERTY INTERFACE_INCLUDE_DIRECTORIES)
    get_property(dirs_normal TARGET main PROPERTY INCLUDE_DIRECTORIES)
    message("# In parent scope, after add test lib, target main property: interface[${dirs_interface}], normal[${dirs_normal}]")
    

    target_include_directories/main.cpp文件内容:

    #include "test.h"
    #include <iostream>
    
    int main(int argc, char** argv)
    {
        std::cout << "In main..." << std::endl;
        test_print();
        return 0;
    }
    

    target_include_directories/test/CMakeLists.txt文件内容:

    add_library(test test.cpp)
    target_include_directories(test INTERFACE ${CMAKE_CURRENT_SOURCE_DIR})
    
    get_property(dirs_interface TARGET test PROPERTY INTERFACE_INCLUDE_DIRECTORIES)
    get_property(dirs_normal TARGET test PROPERTY INCLUDE_DIRECTORIES)
    message("-- # In child scope, target test property: interface[${dirs_interface}], normal[${dirs_normal}]")
    

    target_include_directories/test/test.h文件内容:

    #ifndef __TEST_TT__
    #define __TEST_TT__
    void test_print();
    #endif
    

    target_include_directories/test/test.cpp文件内容:

    #include "test.h"
    #include <iostream>
    
    void test_print()
    {
        std::cout << "In test: say hello!" << std::endl;
    }
    

    在target_include_directories目录下,运行cmake .以及make VERBOSE=1,关键输出:

    $ cmake .
    ……
    -- # In child scope, target test property: interface[/home/shengyi/code/gitee_repo/projects/cmake/target_include_directories/test], normal[]
    # In parent scope, target main property: interface[], normal[]
    # In parent scope, after add test lib, target main property: interface[], normal[]
    
    $ make VERBOSE=1
    ……
    [ 75%] Building CXX object CMakeFiles/main.dir/main.cpp.o
    /usr/bin/c++  -I/XXX/target_include_directories/test  -MD -MT CMakeFiles/main.dir/main.cpp.o -MF CMakeFiles/main.dir/main.cpp.o.d -o CMakeFiles/main.dir/main.cpp.o -c /home/shengyi/code/gitee_repo/projects/cmake/target_include_directories/main.cpp
    [100%] Linking CXX executable main
    
    $ ./main 
    In main...
    In test: say hello!
    

    可见通过PUBLIC或INTERFACE添加到库文件test的目录,也可以传递到可执行文件main(PRIVATE无法传递,可以尝试修改一下)。

    2)可执行文件main中直接添加test目录,库文件编译时不添加test目录

    与上面的对比,只修改了两个CMakeLists.txt文件,去除了target_include_directories/test/CMakeLists.txt中的target_include_directories语句,在target_include_directories/CMakeLists.txt中通过target_include_directories将test目录增加到目标文件main中。

    target_include_directories/CMakeLists.txt文件内容:

    cmake_minimum_required(VERSION 3.22)
    project(target_include_test)
    
    add_subdirectory(test)
    
    add_executable(main main.cpp)
    target_include_directories(main PRIVATE test)
    get_property(dirs_interface TARGET main PROPERTY INTERFACE_INCLUDE_DIRECTORIES)
    get_property(dirs_normal TARGET main PROPERTY INCLUDE_DIRECTORIES)
    message("# In parent scope, target main property: interface[${dirs_interface}], normal[${dirs_normal}]")
    
    target_link_libraries(main test)
    get_property(dirs_interface TARGET main PROPERTY INTERFACE_INCLUDE_DIRECTORIES)
    get_property(dirs_normal TARGET main PROPERTY INCLUDE_DIRECTORIES)
    message("# In parent scope, after add test lib, target main property: interface[${dirs_interface}], normal[${dirs_normal}]")
    

    target_include_directories/CMakeLists.txt文件内容:

    add_library(test test.cpp)
    
    get_property(dirs_interface TARGET test PROPERTY INTERFACE_INCLUDE_DIRECTORIES)
    get_property(dirs_normal TARGET test PROPERTY INCLUDE_DIRECTORIES)
    message("-- # In child scope, target test property: interface[${dirs_interface}], normal[${dirs_normal}]")
    

    在target_include_directories目录下,运行cmake .以及make VERBOSE=1,关键输出:

    $ cmake .
    ……
    -- # In child scope, target test property: interface[], normal[]
    # In parent scope, target main property: interface[], normal[/XXX/target_include_directories/test]
    # In parent scope, after add test lib, target main property: interface[], normal[/XXX/target_include_directories/test]
    
    $ make VERBOSE=1
    ……
    [ 75%] Building CXX object CMakeFiles/main.dir/main.cpp.o
    /usr/bin/c++  -I/XXX/target_include_directories/test  -MD -MT CMakeFiles/main.dir/main.cpp.o -MF CMakeFiles/main.dir/main.cpp.o.d -o CMakeFiles/main.dir/main.cpp.o -c /home/shengyi/code/gitee_repo/projects/cmake/target_include_directories/main.cpp
    [100%] Linking CXX executable main
    
    $ ./main 
    In main...
    In test: say hello!
    
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,542评论 6 504
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,822评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,912评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,449评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,500评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,370评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,193评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,074评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,505评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,722评论 3 335
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,841评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,569评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,168评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,783评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,918评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,962评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,781评论 2 354

推荐阅读更多精彩内容