CMake编写总结
- 不定期更新
CMake介绍
- 以下来自百度百科
CMake是一个跨平台的安装(编译)工具,可以用简单的语句来描述所有平台的安装(编译过程)。他能够输出各种各样的makefile或者project文件,能测试编译器所支持的C++特性,类似UNIX下的automake。只是 CMake 的组态档取名为 CMakeLists.txt。CMake 并不直接建构出最终的软件,而是产生标准的建构档(如 Unix 的 Makefile 或 Windows Visual C++ 的 projects/workspaces),然后再依一般的建构方式使用。这使得熟悉某个集成开发环境(IDE)的开发者可以用标准的方式建构他的软件,这种可以使用各平台的原生建构系统的能力是 CMake 和 SCons 等其他类似系统的区别之处。
CMake和make
- 以下来自百度百科
“CMake”这个名字是“cross platform make”的缩写。虽然名字中含有“make”,但是CMake和Unix上常见的“make”系统是分开的,而且更为高阶。
make
和CMake
之间的关系是CMake
通过命令可以生成make
执行的Makefile
文件,所以说CMake
是make
的升级版的生成工具
CMake文档
点击此处到达CMake
的在线文档页面。
各种CMake编写
- 以下收录的是本人自己的各种项目的
CMakeLists.txt
文件,以做参考
CMakeLists.txt一般使用格式
1#set minimum compile version
2CMake_minimum_required(VERSION 3.14)
3
4#set project name
5project(CMaketest)
6
7#set target app name
8set(TARGET_NAME test)
9
10
11...
12
13
14#genarate a app
15add_executable(${TARGET_NAME} 源文件 头文件)
简单C++项目编写CMakeLists.txt
- 简单项目是指只有一个文件夹,并且所有项目文件都放在其中的项目,由于文件结构简单,直接使用一下内容即可将项目进行编译。
1ProjectName #项目目录
2├── CMakeLists.txt #项目根目录CMakeLists.txt配置文件
3├── main.cpp #程序入口
4├── ... #其他项目文件
5└── test.cpp #其他项目文件
- 在当前项目文件夹新建
CMakeLists.txt
文件,并输入以下内容
1#set minimum compile version
2CMake_minimum_required(VERSION 3.14)
3
4#set project name
5project(CMaketest)
6
7#set target app name
8set(TARGET_NAME test)
9
10#use c++ 17 stander
11set(CMake_CXX_STANDERD 17)
12
13
14#set all resources files
15file(GLOB SOURCES "*.cpp")
16file(GLOB HEADERS "*.h")
17
18
19#genarate a app
20add_executable(${TARGET_NAME} ${SOURCES} ${HEADERS})
- **注意:**简单项目不推荐使用
GLOB_RECURSE
,因为他会遍历所有找到的文件夹以及他的子文件夹,容易造成把build
目录扫描导致main
函数重复定义的情况
完成后用CMake编译生成makefile,即可使用make命令进行项目的编译了
复杂(多文件夹)C++项目写CMakeLists.txt
复杂项目示例
- 一般有较多文件的项目都是使用多文件夹进行管理项目源文件的,使用多个不同级目录下保存源文件的管理方式使用CMake生成makefile可以使用以下管理方式
1ProjectName #项目目录
2├── CMakeLists.txt #项目根目录CMakeLists.txt配置文件
3└── src #源码目录
4 ├──utilities #次级原码目录
5 | ├── CMakeLists.txt #次级源码目录CMakeLists.txt配置文件
6 | ├── util.h #其他次级源码
7 | ├── util.cpp #其他次级源码
8 | ├── ... #其他次级源码
9 | └── log.cpp #其他次级源码
10 | ... #其他次级原码目录
11 ├── CMakeLists.txt #源码目录CMakeLists.txt配置文件
12 ├── main.cpp #程序入口
13 ├── ... #其他项目文件
14 └── test.cpp #其他项目文件
复杂项目的CMakeLists.txt
CMakeLists.txt #项目根目录CMakeLists.txt配置文件
1#set minimum compile version
2CMake_minimum_required(VERSION 3.14)
3
4#set project name
5project(CMaketest)
6
7#add the src subdirectory
8add_subdirectory(src)
CMakeLists.txt #源码目录CMakeLists.txt配置文件
1#set minimum CMake compile version
2CMake_minimum_required(VERSION 3.14)
3
4#set target app name
5set(TARGET_NAME testCMake)
6
7#use c++ 17 stander
8set(CMake_CXX_STANDERD 17)
9
10# add a source file subdirectory
11add_subdirectory(utilities)
12
13#set all resources files
14file(GLOB_RECURSE SOURCES "*.cpp")
15file(GLOB_RECURSE HEADERS "*.h")
16
17
18#genarate a app
19add_executable(${TARGET_NAME} ${SOURCES} ${HEADERS})
CMakeLists.txt #次级源码目录CMakeLists.txt配置文件
- 其他次级原码目录CMakeLists.txt配置文件一样
- 可以不配置,因为使用了源码目录的
CMakeLists.txt
使用了GLOB_RECURSE
,正常情况会自动遍历到此文件夹下
1#set minimum compile version
2CMake_minimum_required(VERSION 3.14)
3
4#set all resources files
5file(GLOB_RECURSE SOURCES "*.cpp")
6file(GLOB_RECURSE HEADERS "*.h")
- 这样就可以对多个文件夹管理的项目使用CMake生成makefile了
qt项目编写CMake
- qt项目需要添加相应的库,只需要将一些配置项添加在源码目录CMakeLists.txt配置文件即可
1#set minimum CMake compile version
2CMake_minimum_required(VERSION 3.14)
3
4#set target app name
5set(TARGET_NAME testCMake)
6
7#use c++ 17 stander
8set(CMake_CXX_STANDERD 17)
9set(CMake_CXX_STANDARD_REQUIRED ON)
10
11#include this priject on
12set(CMake_INCLUDE_CURRENT_DIR ON)
13
14#auto genarate ui.h file
15set(CMake_AUTOUIC ON)
16
17#auto genarete moc file
18set(CMake_AUTOMOC ON)
19
20#auto genarate .qrc file on
21set(CMake_AUTORCC ON)
22
23# set QT type
24set(QT Core Gui Widgets Network DBus Sql)
25
26#add package lib
27find_package(Qt5 REQUIRED ${QT})
28
29# add a source file subdirectory
30#add_subdirectory(utilities)
31
32#set all resources files
33file(GLOB_RECURSE SOURCES "*.cpp")
34file(GLOB_RECURSE HEADERS "*.h")
35file(GLOB_RECURSE FORMS "*.ui")
36file(GLOB_RECURSE RESOURCES "*.qrc")
37
38
39#genarate a app
40add_executable(${TARGET_NAME} ${SOURCES} ${HEADERS} ${FORMS} ${RESOURCES})
41
42#add QT5 dependes
43target_link_libraries(${TARGET_NAME} PRIVATE Qt5::Widgets)
使用
在当前文件夹下使用一下命令可以生成Makefile
:
1cmake
- 但是,如此生成的话会产生很多中间文件,从而导致了当前文件夹的文件过多,再次编辑文件的时候会很难找到确切的文件的状况,这就是污染项目结构
- 所以,为了不污染项目环境,推荐使用以下命令来生成
Makefile
1mkdir build
2cd build
3cmake ..
评论