当前位置: 首页 > news >正文

target_include_directories是如何组织头文件的?

target_include_directories(mylib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}) 这条 CMake 命令用于指定编译目标(在此例中为 mylib 静态库)的头文件搜索路径。具体来说,这条命令的作用包括以下几个方面:

1. 添加包含目录

  • mylib:这是目标名称,即你要为其设置包含目录的静态库。
  • PUBLIC:这是访问说明符,表示包含目录的作用范围。
  • ${CMAKE_CURRENT_SOURCE_DIR}:这是当前 CMakeLists.txt 文件所在的源代码目录路径,通常包含库的头文件。

2. 访问说明符的含义

CMake 提供了三种访问说明符:PRIVATEPUBLICINTERFACE,它们决定了包含目录对不同目标的影响范围。

  • PRIVATE

    • 只对当前目标(mylib)有效。
    • 链接到 mylib 的其他目标不会继承这些包含目录。
  • PUBLIC

    • 对当前目标和所有链接到该目标的其他目标都有效。
    • 这意味着使用 mylib 的可执行文件或其他库也会自动包含这些目录,以便找到必要的头文件。
  • INTERFACE

    • 只对链接到该目标的其他目标有效,当前目标自身不使用这些包含目录。

在你的命令中使用 PUBLIC,意味着不仅 mylib 本身在编译时会使用 ${CMAKE_CURRENT_SOURCE_DIR} 作为头文件搜索路径,而且所有链接到 mylib 的目标(如可执行文件 app)也会自动使用这个包含目录。这对于库的使用者来说非常方便,因为他们不需要手动指定库的头文件路径。

3. 实际效果

假设你的项目结构如下:

project/
├── lib/
│   ├── mylib.cpp
│   └── mylib.h
├── app/
│   ├── main.cpp
└── CMakeLists.txt
  • lib/CMakeLists.txt 中的命令:

    add_library(mylib STATIC mylib.cpp)
    target_include_directories(mylib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
    
  • app/CMakeLists.txt 中的命令:

    add_executable(app main.cpp)
    target_link_libraries(app PRIVATE mylib)
    

在这种设置下:

  1. 编译 mylib

    • 编译器会在 ${CMAKE_CURRENT_SOURCE_DIR}(即 lib/ 目录)中查找头文件,例如 mylib.h
  2. 编译 app

    • 因为 app 链接了 mylibmylib 的包含目录是 PUBLIC,所以 app 的编译器也会自动将 lib/ 目录添加到头文件搜索路径中。
    • 这样,app/main.cpp 中包含 #include "mylib.h" 时,编译器能够正确找到 mylib.h

4. 为什么使用 CMAKE_CURRENT_SOURCE_DIR

  • CMAKE_CURRENT_SOURCE_DIR
    • 这个变量指向当前 CMakeLists.txt 文件所在的源代码目录。
    • lib/CMakeLists.txt 中,它指向 project/lib/,确保包含目录指向包含 mylib.h 的正确路径。

使用 CMAKE_CURRENT_SOURCE_DIR 而不是相对路径或其他路径变量,可以提高 CMakeLists.txt 的可维护性和可移植性,避免在项目结构变化时出现路径错误。

5. 总结

target_include_directories(mylib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}) 的主要作用是:

  • mylib 指定头文件搜索路径:确保在编译 mylib 时能够找到必要的头文件。
  • 为依赖 mylib 的目标自动添加头文件路径:使用 PUBLIC 关键字,使得所有链接 mylib 的目标(如可执行文件或其他库)也能自动包含这些目录,简化依赖管理。

这种方式符合现代 CMake 的最佳实践,通过清晰地指定目标的接口属性(如包含目录),使项目结构更加模块化和易于维护。


http://www.mrgr.cn/news/54104.html

相关文章:

  • Android开发相关的重要网站
  • 《数字图像处理基础》学习02-BMP位图文件
  • 浅析DDR
  • 【C++】类的默认成员函数:深入剖析与应用(上)
  • 编码方式知识整理【ASCII、Unicode和UTF-8】
  • 【C语言】文件操作(1)(文件打开关闭和顺序读写函数的万字笔记)
  • 父子元素中只有子元素设置margin-bottom的问题
  • 基于SpringBoot健康生活助手微信小程序【附源码】
  • 建议收藏!质量管理用ChatGPT,提升效率有手就能做!
  • Vue2 前端表格必选项,禁止更改的实现
  • 2024年微信小程序毕业设计如何选题,200 道新颖微信小程序题目推荐,持续更新
  • 即时通讯:单聊消息逻辑
  • 离线安装Kerbreos到Centos7
  • C# 字符串常用方法
  • 基于windows10的WSL详细安装与使用教程
  • Java项目实战II基于Spring Boot的毕业就业信息管理系统设计与实现(源码+数据库+文档)
  • C#中 is 和 as 运算符使用与区别
  • HTTP cookie 与 session
  • asyn queueRequest使用实例
  • ssm配置模式