|
本文目录CMake简介CMake命令CMake常见指令常用环境变量Qt应用示例一个完整的Qt 5项目CMakeLists.txt参考CMake是一个跨平台、开源的构建工具,在C/C++项目中有广泛应用。本文首先介绍CMake及常用指令,并结合工作时需要用到的Qt 5,给出一个完整的CMake项目配置。+ [; \5 _$ Y8 d
CMake简介返回目录CMake如其名”Cross-platform Make”,是一个 跨平台、开源 的构建工具。与make不同,CMake并不直接构建软件,而是生成用于构建的Makefile、.sln等工程文件,相当于高阶构建工具。
/ T8 s% ]% V4 L1 n8 K3 z. L/ }与另一构建工具Automake相比,CMake使用上更方便,支持更多的编译套件(Ninja、VS等)。许多编辑器和IDE,如VS Code(宇宙第一编辑器/IDE)、Clion、Visual Studio等都内置了对CMake的支持。特别的,CMake已经是QT 6的默认构建工具,官方给出从qmake迁移的理由是CMake成熟稳定、用户基数大生态完善。因此,对于需要跨平台编译运行的C/C++项目,很推荐学习和使用CMake作为构建工具,能方便的转换成各种IDE项目,团队成员无需切换编辑器/IDE即可工作。
" T+ o7 |, _ q% A值得一提的是,CMake由Kitware公司开发和维护,VTK和ParaView等知名开源产品均出自该公司。从这方面看,CMake也算出身名门,因此能很快流行开来。
7 p% ]' w) q) C# I- w CMake命令返回目录CMake基于CMakeLists.txt文件来生成对应目标(generator)的构建文件,一个标准的CMake项目构建操作为(命令行方式):) g6 T& Y4 K( k5 ^% p: @
cd PROJECT_DIR, m% p" H! F/ q) n
cmake
0 E. T8 u8 m: T* x1 a# dmake TARGET或者使用用CMake GUI:
+ i; d9 M# F% E( E- G; t2 ?
) D, q! g3 @8 n v8 N6 I; E) U& Y0 ]
CMake-GUI操作示意图然后使用VS打开生成的.sln项目,即可编译、运行和调试项目。6 T7 K4 V1 Q( s5 W3 A
Linux/Unix/MacOS平台上,CMake默认生成标准的makefile;Windows平台上则会检测Visual Studio版本,生成对应的VS .sln项目工程文件(在MSYS/Cygwin/WSL环境下执行除外)。可以使用 -G 选项切换生成目标,例如生成Ninja构建文件:, ?& Q! E$ D. J4 B- m/ A9 x2 O7 U9 c
cmake . -G Ninja
+ s: @% h! X. D3 Z+ o {3 jninja TARGETCMake一个非常棒的特性是“外部构建”(out-of-source build),即支持在源码目录外构建。由于这个特性,以及CMake生成的makefile没有clean命令,一般来说都推荐在单独的build目录中构建:; p# ~% F/ g* f, v
mkdir -p build
8 x$ v* }# _! T0 Ncd $_ \3 P5 R1 P4 p2 P% x; J8 L
cmake .., r* t: ?: v- @
make TARGET -j4如果使用CMake GUI,Browse Build时请选择单独的构建目录。: V# V7 V3 m. }: i; I. F
命令行方式下编译Debug/Release版本、传递C++编译参数,请使用 -D 选项,例如:
9 y& r5 l' l% [3 ~6 rcmake .. -DCMAKE_BUILD_TYPE=Release
7 r8 @3 G) R1 o/ a5 @) wmake TARGET -j4一些内置的宏定义参数可参考下文的环境变量。) Z8 m d. o! |& V( P, U+ P" y
如果是生成VS项目,则只需在VS中选择构建版本、设置编译和链接参数即可。
4 h' t. I. ^3 |3 x. m+ Y CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件,因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。
8 P: T( l9 D4 a f7 bCMakeLists.txt 使用 # 作为注释,# 所在行后续字符均作为注释被忽略
' m5 m/ m4 | g, n. k+ A5 i2 ucmake_minimum_required一般这条指令出现在文件的最前面,用来指定项目支持的最低版本。对于Qt 5项目,建议为:cmake_minimum_required(VERSION 3.7)。
" {( u: D" u6 m2 p' D" d$ I [% Nproject指定项目名称及属性。C/C++项目的建议值为:project(项目名称 C CXX)。, \2 `, h: m; P }0 M+ X3 m u
set定义一些变量、宏的值。该指令一般会出现多次,例如设置C++语法标准:set(CMAKE_CXX_STANDARD 11)。相反的指令是unset。8 |+ e0 d' e ^$ j) y Y/ w2 U# i
if…else[if]…endif条件控制语句,注意指令后的括号不可省略:
% w- j1 E9 G. j0 F- \) `if (WIN32)
- e- M+ K% c% P+ |: uxxxx8 V' ~# w- n2 g& {% ^+ j9 _& f6 s
else() # 括号不可省略
j: J9 K0 b) ]% fxxxx/ g h% Q) P. W6 P$ s9 z: V
endif()
; J+ H/ J% a: j, ^5 z. |2 E2 _ A' t jfind_package查找指定模块,例如OpenMP。Qt 5项目一般需要:find_package(Qt5 COMPONENTS Widgets REQUIRED)。
* r: L2 C8 d0 h9 tinclude_directories添加头文件include路径,一个更推荐使用的指令是 target_include_directories,其不污染后续目标的include路径,且能精细控制是否暴露依赖的包含路径。但是 target_include_directories 需要CMake 3.13 版本才支持,在Visual Studio 2017中使用会有问题。
$ d1 M1 F! W6 X9 Z9 m% o5 E+ C7 P% T link_directories设置链接库的路径,更推荐的指令是 target_link_directories,理由见 include_directories。; U9 {: e2 z3 G9 U* ]) Y* S; |
aux_source_directory将指定目录下的源文件添加到变量中,例如:aux_source_directory(./src SRC)。注意该命令不会递归包含子目录源文件。
; M" C' k2 s2 l* v* A$ |filefile命令是一个功能丰富的目录和文件操作指令,例如递归找出目录下的所有源文件保存到SRC变量中:file(GLOB_RECURSE SRC "src/*.cpp" "src/*/*.cpp")。9 n& F4 _3 n8 B7 M+ M2 U/ a
相对于把每个需要编译的文件添加到CMakeLists.txt中,aux_source_directory 和 file 等指令可方便的引入多个文件,但其弊端之一是CMake不能感知文件变化。当新增文件、文件被删除、重命名时需刷新CMake缓存才能被应用到项目中。9 i, ?" V$ h# ^! h4 I
find_library查找指定库的路径并保存到变量中。
0 r0 l. [) {! Uadd_custom_command添加自定义命令,可用于构建前进行moc,构建后拷贝文件等用途。% |+ o; j! @, q: m' f; \
add_subdirectory添加一个需要构建的子目录,子目录下有CMakeLists.txt文件设定好构建规则。
5 m# w7 Q6 o5 U7 U: d! j) Xadd_executable构建可执行程序,一般项目的主CMakeLists.txt中会有这条指令。
% a& C! g" f5 f8 D- Iadd_library构建动态或静态库,一般存在于子目录或者库的CMakeLists.txt文件中。
% X* d9 v+ K9 O7 fmessage可在cmake构建时输出信息。2 ]2 f7 ~ h3 j* w5 Q( [0 S
CMakeLists.txt文件中指令不区分大小写,但一般来说同一个文件中指令应保持大小写风格一致。
9 c7 ~& S% F0 _' d8 R! m更多指令可参考 CMake官方文档。* I! q+ i1 @; r6 L9 ?
常用环境变量返回目录本小节介绍几个常用的环境变量(编译宏)。; c$ @6 Z+ p2 E2 s
CMAKE_BUILD_TYPE: 指定构建类型,常用值为 Debug、Release、RelWithDebInfo 和 MinSizeRel;CMAKE_C(XX)_FLAGS:传递给C/C++编译器的编译选项,例如输出所有警告: -DCMAKE_CXX_FLAGS="-Wall";– CMAKE_EXE/MODULE/_LINKER_FLAGS:传递给C/C++链接器的编译选项,例如指定链接数学库:-DCMAKE_LINKER_FLAGS="-lmath"。 Qt应用示例返回目录本节结合工作时需要用到的Qt 5,介绍Qt 5工程中CMake的使用方式。
* G1 F& ^+ z" l/ r; `新建Qt项目时,可以选择CMake作为构建工具:
; B7 g1 X) p7 q
2 u, g' ^. R8 `8 Z$ `0 R+ x/ w% {6 ^- }: _, [
Qt新建项目使用CMake生成项目后,项目文件夹将出现CMakeLists.txt和CMakeLists.txt.user两个文件,熟悉的.pro文件没有了(CMakeLists.txt.user充当了Qt Creator工程文件的角色,其他IDE用不到,可删除)。+ F! ^9 {, G# [2 o. t0 H" i
但需要注意的是,此时Qt Creator中编译项目是没问题的,但是在CLion/VS Code中打开,或者生成Visual Studio用的.sln文件会有问题,因为CMake无法检测到Qt是否安装及其安装路径。# g3 t' |5 S! ~3 e( @6 O
解决办法便是在 project 指令后增加如下指令告知Qt的安装位置:7 n0 K% Q! n' L: h+ G3 M$ q' D
# 具体路径请根据自身情况替换
9 V) j2 E5 N8 O, a1 ?. yset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")5 \5 X6 h8 B9 \: k8 e
set(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")
* K! t: N$ {' y5 N F* ~ X然后再次运行 cmake 指令或者使用CMake GUI重新运行,构建文件夹下便能正常生成.sln项目文件。
' m/ T. u2 @1 T9 v( EVS中编译好后,运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括:3 c% [2 B8 P! X0 }# I" `
1. 设置VS选项,将Qt的dll路径包含进去;: x) g$ h- m, B: `8 v# O
2. 将Qt相关dll拷贝到编译输出文件夹;5 t# w5 O, k( J0 c5 V9 Z2 @
3. 设置CMake,使其能自动复制所需要的dll。5 Q: ?; h4 l- X. Y" `' S
这里介绍第三种方式,原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为,在项目根目录的CMakeLists.txt最后添加部署dll的指令:
& F ~( v6 c; A" g* ^5 T$ Wset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")! |6 w) V* d$ o# b$ Q* i. j
function(windeployqt target)( Y. z+ g2 R& ^
# POST_BUILD step4 Y' P+ o6 x4 v1 o& }# B
# - after build, we have a bin/lib for analyzing qt dependencies
% w+ I) E+ O% Q5 R# - we run windeployqt on target and deploy Qt libs3 p) I( o% @# o
add_custom_command(TARGET ${target} POST_BUILD W9 t& ]% m% ?& m5 W s: q A
COMMAND "${QT_BIN_PATH}/windeployqt.exe"
1 m$ s6 z' @9 q( ~' A--verbose 1
3 [. b0 q" ]6 k- ^; V9 p#--release # uncomment this line if built with Release
3 F: W& |: j& y#--no-svg
1 Z# ?! Z1 w7 H7 O/ @% M#--no-angle
# G% B" u2 x, P0 _7 U; S# ~3 ^#--no-opengl( ?1 ~- }& P7 A2 S; G2 g
#--no-opengl-sw
. w& V* f) S) D J) Q' k& B#--no-compiler-runtime! P2 ]$ h& d* k5 ^3 L) c( V: Y+ [5 q
#--no-system-d3d-compiler$ t# U( u0 [: Q# A% R
\"$\"
8 q) P+ D& [: Z- oCOMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."8 R5 S% R+ I! i6 H6 V5 N, @
): v, L2 T2 |/ \+ |9 h" c7 e
endfunction()6 N7 I0 a. } m* g
if (WIN32)8 c0 Q& d% l/ k, \2 s
windeployqt(${PROJECT_NAME})
) J) j' i4 `/ g* aendif()最后,转换成VS项目时,默认是Console项目,运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32:+ L% O/ h. ~! r4 A# _% M0 X
add_executable(${PROJECT_NAME} WIN32 xxxx)* G( s5 O/ p( `" T: o* A
一个完整的Qt 5项目CMakeLists.txt返回目录以下是一个适用于Windows平台的Qt 5项目完整CMakeLists.txt,实际使用时请替换名字和Qt 5安装路径等:3 O, |) h" h- J# \' a
cmake_minimum_required(VERSION 3.7)7 z$ F2 \( [; `+ _( u% @2 P
# 请将myproject改成实际的应用名字
" z6 L3 Z6 C' sproject(myproject LANGUAGES CXX)/ F6 l* S% e' E# _
set(CMAKE_INCLUDE_CURRENT_DIR ON)0 T/ R! a) K- I# W& U* @
# 请更改为实际的Qt安装目录7 { k2 H, f+ E7 t( T, K. i
set(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
. ^- B1 z% {, i" sset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake"): }4 V9 U4 i/ @
set(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
! @# t/ `0 Y8 o( |& xset(CMAKE_AUTOUIC ON)" p7 r- b+ a! |' w+ ?
set(CMAKE_AUTOMOC ON)
4 J- s. K6 c2 D- B1 Fset(CMAKE_AUTORCC ON): W" Q2 Q( i, ^" p3 V
set(CMAKE_CXX_STANDARD 11)- P0 c# E4 M5 b; B8 i2 M
set(CMAKE_CXX_STANDARD_REQUIRED ON)
1 J z5 R( @+ l- b, rfind_package(Qt5 COMPONENTS Widgets REQUIRED)
, W8 D: P% ?$ a: v/ |# 默认Release构建* L5 W. @* b1 a( }9 i
if (NOT CMAKE_BUILD_TYPE)% o! D+ Y; @+ m" X3 l9 k+ g$ S
set( CMAKE_BUILD_TYPE "Release" )
. `) G% a5 Z, U2 T& Q* }) ?endif()
% v8 k5 C$ F% I) X; ^message("build type: ${CMAKE_BUILD_TYPE}")
- P/ b/ _% g3 T6 j2 q# 按照自己的项目结构添加文件
& `: k1 x6 E5 h0 Z' U' G# 也可使用file/aux_source_directory批量引入,注意不要引入自动生成的文件!+ m U( z X R. @' m/ I
add_executable(${PROJECT_NAME} WIN32
1 [0 A, S& K# O |, ~& ? main.cpp% G4 s+ v9 ]. _. b4 S$ G4 k
mainwindow.cpp
/ {9 N$ G' i7 @! Y( @9 J8 p0 P mainwindow.h
+ f0 q- b i, T# N/ J" G/ P). \. G# E5 w# C
target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
4 N" @3 T: F) {# a6 B9 |function(windeployqt target)
( N, Y; G9 Q* O( {- a# POST_BUILD step% [8 e) ~# e. X( a: R3 i9 X
add_custom_command(TARGET ${target} POST_BUILD
3 j4 _2 a0 r7 Q! @2 V# KCOMMAND "${QT_BIN_PATH}/windeployqt.exe"
* W7 |7 @& E0 `$ d# l--verbose 1
& E7 E* K7 o) E- Z#--release ( q* U* f7 J1 t8 M) J6 {
#--no-svg
) i* A4 o# F: f8 Y" m* h. y& ]#--no-angle+ R9 a- _9 x$ X$ f, ]
#--no-opengl
* b; v/ g2 p2 M#--no-opengl-sw5 H7 Z2 D; a1 a6 Q, T6 C
#--no-compiler-runtime
1 Y' p2 |! ~8 r#--no-system-d3d-compiler
5 ` Y: l4 [! v |\"$\"
/ i! f" u: E/ E( y8 x9 G$ j9 cCOMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."6 D3 k# Y$ O1 S |# }; E
)
1 z- U4 g: G. U. Nendfunction()3 b; a! | |1 J: }3 y2 x1 Y4 s
if (WIN32)0 d$ t: f0 K8 W$ q, H
windeployqt(${PROJECT_NAME})
6 r6 Q% X! {- e/ `4 Tendif() @9 M% [0 Q9 {
````通过上面的配置,我们的Qt项目既可在Qt Creator中正常编译运行,也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。* V0 U3 ~! h: h: `
参考返回目录1. CMake官网, M' K4 u" a8 Z: |9 i
2. CMake教程" |! d N. m3 J2 G6 w
3. CMake FAQ
) p2 P( ^* x2 b6 e4. CMake指定编译器" P% Q- u7 b4 G- M8 l6 x) l
AD:【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS,季付46.87$打赏赞(3) |
本帖子中包含更多资源
您需要 登录 才可以下载或查看,没有账号?立即注册
x
|