前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >CMake用法,这篇文章讲全了

CMake用法,这篇文章讲全了

作者头像
程序员的园
发布2024-07-18 13:38:24
1590
发布2024-07-18 13:38:24
举报
文章被收录于专栏:程序员的园——原创文章

CMake是一个开源的、跨平台的自动化构建系统,用于管理软件构建过程。它通过编写配置文件(CMakeLists.txt),自动生成适合不同编译器和操作系统的构建脚本或项目文件。CMake以其强大的跨平台能力成为众多开发者构建项目的首选工具。无论是简单的单文件项目,还是复杂的多文件、多文件夹乃至集成第三方库的大型工程,CMake都能游刃有余。本文将结合实例详细介绍cmake的常见用法,包括单文件、多文件、多文件夹以及引用第三方库等。

单文件

假设工程中只有main.cpp一个文件,文件夹的布局如下:

代码语言:javascript
复制
.
├── CMakeLists.txt
└── main.cpp

那么该如何使用书写其CMakeLists文件呢,如下为一个简单的CMakeLists.txt示例:

代码语言:javascript
复制
cmake_minimum_required(VERSION 3.10) # 指定CMake最低版本
project(SingleFileExample)         # 定义项目名称


add_executable(SingleFileExample main.cpp) # 添加可执行目标

如上创建一个名为SingleFileExample的可执行程序,源代码为main.cpp。

多文件

随着项目复杂度增加,单一源文件显然不再适用。在main.cpp文件夹中使用func文件提供的add方法,文件夹布局如下:

代码语言:javascript
复制
├── CMakeLists.txt
├── func.h
├── func.cpp
└── main.cpp

其CMakeLists.txt配置如下:

代码语言:javascript
复制
cmake_minimum_required(VERSION 3.10)  # 设置cmake的最低版本要求为3.10
project(MultiFileExample)  # 设置项目名称


# 在当前目录中查找源文件,并将它们添加到SOURCES变量中
aux_source_directory(. SOURCES)  


# 添加可执行文件,并将源文件添加到可执行文件中
add_executable(MultiFileExample ${SOURCES})

多文件夹

对于更复杂的项目结构,如source文件夹存放库的代码,Test文件夹生成测试库的代码,文件夹布局如下:

代码语言:javascript
复制
.
├── CMakeLists.txt
├── source
│   ├── CMakeLists.txt
│   ├── include
│   │   └── func.h
│   └── src
│       └── func.cpp
└── test
    ├── CMakeLists.txt
    └── main.cpp

其CMakeLists.txt配置如下:

代码语言:javascript
复制
###### 顶级CMakeLists.txt
cmake_minimum_required(VERSION 3.10)  # 设置cmake的最低版本要求为3.10
project(MultiFolderExample)  # 设置项目名称


#CMAKE_SOURCE_DIR变量代表当前CMakeLists.txt所在的路径
include_directories(${CMAKE_SOURCE_DIR}/source/include)


add_subdirectory(source)  # 添加source子目录
add_subdirectory(test)  # 添加test子目录


######  source/CMakeLists.txt
cmake_minimum_required(VERSION 3.10)  # 设置cmake的最低版本要求为3.10
project(funclib)  # 设置项目名称


# 递归查找source子目录下的所有.cpp文件,
# 并将它们添加到SOURCES变量中
file(GLOB_RECURSE SRC "src/*.cpp")  


#PROJECT_NAME代表当前项目的名称
add_library(${PROJECT_NAME} STATIC ${SRC})  # 添加静态库目标


######  test/CMakeLists.txt
cmake_minimum_required(VERSION 3.10)  # 设置cmake的最低版本要求为3.10
project(funcTest)  # 设置项目名称
add_executable(${PROJECT_NAME} main.cpp)


target_link_libraries(${PROJECT_NAME} funclib)  # 添加静态库目标

如上示例模拟了库文件和测试程序的构建,其中source文件夹存放库的代码,Test文件夹生成测试库的代码。

引用第三方库(静态库)

在实际开发中,往往需要依赖外部库。以静态库为例,考虑引入其他同事提供的库func.lib,其配套的头文件为func.h,同时,生成的动态库名称为BirdEngine。

项目的文件夹布局如下:

代码语言:javascript
复制
.
├── CMakeLists.txt
├── third_party
│   ├── include
│   │   └── func.h
│   └── lib
│       └── funclib.lib
└── src
    └── BirdEngine.cpp
    └── BirdEngine.h

其CMakeLists.txt配置如下:

代码语言:javascript
复制
cmake_minimum_required(VERSION 3.10)  # 设置cmake的最低版本要求为3.10
project(BirdEngine)  # 设置项目名称


# 添加第三方库的头文件路径
include_directories(${CMAKE_SOURCE_DIR}/third_party/include)


# 添加第三方库的库文件路径
link_directories(${CMAKE_SOURCE_DIR}/third_party/lib)


file(GLOB_RECURSE SOURCES "src/*.cpp")  # 递归查找source子目录下的所有.cpp文件,并将它们添加到SOURCES变量中


add_library(${PROJECT_NAME} SHARED ${SOURCES})  # 添加可执行文件,并将源文件添加到可执行文件中


# 链接第三方库
target_link_libraries(${PROJECT_NAME} funclib)

如上示例,首先通过include_directories添加第三方库的头文件路径,然后通过link_directories添加第三方库的库文件路径,最后通过target_link_libraries链接第三方库。

引用第三方库(动态库+静态库)

针对于同时依赖静态库和动态库的场景,需要在链接阶段找到lib库,同时需要在运行阶段找到dll库。假设某项目需要库BirdEngine,其静态库为BirdEngine.lib,动态库为BirdEngine.dll,其文件夹布局如下:

代码语言:javascript
复制
.
├── CMakeLists.txt
├── third_party
│   ├── include
│   │   └── BirdEngine.h
│   ├── lib
│   │   ├── BirdEngine.lib
│   └── bin
│       └── BirdEngine.dll
└── src
    └── main.cpp

其CMakeLists.txt配置如下:

代码语言:javascript
复制
cmake_minimum_required(VERSION 3.10)
project(BirdEngineTest)


# 添加第三方库的头文件路径
include_directories(${CMAKE_SOURCE_DIR}/third_party/include)


# 添加第三方库的库文件路径
link_directories(${CMAKE_SOURCE_DIR}/third_party/lib)


# 递归查找source子目录下的所有.cpp文件,并将它们添加到SOURCES变量中
file(GLOB_RECURSE SOURCES "src/*.cpp")  


add_executable(${PROJECT_NAME} ${SOURCES})


target_link_libraries(${PROJECT_NAME} BirdEngine)


# 复制动态库到输出目录
file(COPY ${CMAKE_SOURCE_DIR}/third_party/bin/BirdEngine.dll 
        DESTINATION ${CMAKE_CURRENT_BINARY_DIR})

如上示例,首先通过include_directories添加第三方库的头文件路径,然后通过link_directories添加第三方库的库文件路径,最后通过target_link_libraries链接第三方库。同时,通过file命令复制动态库到输出目录。

总结

本文结合实际场景讲解CMakeLists.txt文件的组织,包括单文件、多文件、多文件夹项目构建,以及如何灵活地集成和管理第三方库。无论是初学者还是经验丰富的开发者,CMake都是提升构建效率、简化跨平台开发的得力助手,仅以与诸君一同探索。

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2024-06-06,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 程序员的园 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档