扫一扫,微信登陆

 青浦修电脑 青浦笔记本维修 青浦手机维修 青浦电器维修

搜索
查看: 648|回复: 0

CMake简明实用教程 - 青浦海洋数码电脑城

[复制链接]

1万

主题

1万

帖子

5万

积分

论坛元老

Rank: 8Rank: 8

积分
56206
发表于 2022-9-11 20:40:15 | 显示全部楼层 |阅读模式
本文目录
  • CMake简介
  • CMake命令
  • CMake常见指令
  • 常用环境变量
  • Qt应用示例
  • 一个完整的Qt 5项目CMakeLists.txt
  • 参考CMake是一个跨平台、开源的构建工具,在C/C++项目中有广泛应用。本文首先介绍CMake及常用指令,并结合工作时需要用到的Qt 5,给出一个完整的CMake项目配置。9 S5 d! o; T  ^0 h4 c2 J
    CMake简介返回目录CMake如其名”Cross-platform Make”,是一个 跨平台、开源 的构建工具。与make不同,CMake并不直接构建软件,而是生成用于构建的Makefile、.sln等工程文件,相当于高阶构建工具。
    - j: k( ?( [9 S2 k; F/ o- E与另一构建工具Automake相比,CMake使用上更方便,支持更多的编译套件(Ninja、VS等)。许多编辑器和IDE,如VS Code(宇宙第一编辑器/IDE)、Clion、Visual Studio等都内置了对CMake的支持。特别的,CMake已经是QT 6的默认构建工具,官方给出从qmake迁移的理由是CMake成熟稳定、用户基数大生态完善。因此,对于需要跨平台编译运行的C/C++项目,很推荐学习和使用CMake作为构建工具,能方便的转换成各种IDE项目,团队成员无需切换编辑器/IDE即可工作。
    / b7 h' X- D1 M6 z& r$ O值得一提的是,CMake由Kitware公司开发和维护,VTK和ParaView等知名开源产品均出自该公司。从这方面看,CMake也算出身名门,因此能很快流行开来。: z1 h+ c2 q. y5 O- o8 }; h  H) g
    CMake命令返回目录CMake基于CMakeLists.txt文件来生成对应目标(generator)的构建文件,一个标准的CMake项目构建操作为(命令行方式):3 b0 ]% }" c6 F& n5 ^
    cd PROJECT_DIR
    ; y7 j. G; l! Ecmake
    . s6 i1 Y$ R5 d1 }make TARGET或者使用用CMake GUI:8 }, n- }4 E5 M8 Y. N

    : o; n5 Y$ o) i: [" g4 p
    , c) N- \+ k( ]# L0 ~5 B$ [CMake-GUI操作示意图然后使用VS打开生成的.sln项目,即可编译、运行和调试项目。- ^* A, Z" v# F3 Z  r7 N' x
    Linux/Unix/MacOS平台上,CMake默认生成标准的makefile;Windows平台上则会检测Visual Studio版本,生成对应的VS .sln项目工程文件(在MSYS/Cygwin/WSL环境下执行除外)。可以使用 -G 选项切换生成目标,例如生成Ninja构建文件:7 h8 q! b: C- X% k5 f
    cmake . -G Ninja4 a1 u3 H* G$ p
    ninja TARGETCMake一个非常棒的特性是“外部构建”(out-of-source build),即支持在源码目录外构建。由于这个特性,以及CMake生成的makefile没有clean命令,一般来说都推荐在单独的build目录中构建:6 h8 }; O3 N; R8 h
    mkdir -p build3 P7 z- h1 A( F" `5 D; Y1 A
    cd $_( w3 o% F" @* I0 U
    cmake ..
    - P( X# Y! z5 _) P; h) jmake TARGET -j4如果使用CMake GUI,Browse Build时请选择单独的构建目录。) [' ~9 s2 \7 l6 m8 ]1 x
    命令行方式下编译Debug/Release版本、传递C++编译参数,请使用 -D 选项,例如:( d. w$ a/ _2 A* }  |
    cmake .. -DCMAKE_BUILD_TYPE=Release1 [3 C* Y- W5 U$ d1 k3 t& B
    make TARGET -j4一些内置的宏定义参数可参考下文的环境变量。
    " g! v5 G1 q# O" _% [如果是生成VS项目,则只需在VS中选择构建版本、设置编译和链接参数即可。2 E2 R9 q. T- L, v# M
    CMake常见指令返回目录CMake基于CMakeLists.txt文件生成项目构建文件,因此编写CMakeLists.txt文件是CMake项目的核心。本小节介绍一些用在CMakeLists.txt文件中的常用指令。- O5 o; o1 u# w% d* ^
    CMakeLists.txt 使用  # 作为注释,# 所在行后续字符均作为注释被忽略  Y% I* e1 U7 |
  • cmake_minimum_required一般这条指令出现在文件的最前面,用来指定项目支持的最低版本。对于Qt 5项目,建议为:cmake_minimum_required(VERSION 3.7)。
    & C7 F- n5 i; x" j! }, @5 y
  • project指定项目名称及属性。C/C++项目的建议值为:project(项目名称 C CXX)。
    + Q; u! |% H3 s$ {
  • set定义一些变量、宏的值。该指令一般会出现多次,例如设置C++语法标准:set(CMAKE_CXX_STANDARD 11)。相反的指令是unset。* V: ~) l- v$ v' @% r' W1 i5 V
  • if…else[if]…endif条件控制语句,注意指令后的括号不可省略:+ c& S& L( m0 ?) X' \4 s5 v
    if (WIN32)
    & W5 L0 n: ^3 H+ j1 h! d! I% d+ ~) b0 wxxxx
    6 p3 {2 ^3 C: P1 S6 Melse() # 括号不可省略! I6 O7 e, U" F5 Y2 m- Q- b. f* F
    xxxx7 k2 ?9 D( {6 p* b
    endif()5 f! t- q& z" z9 e1 _
  • find_package查找指定模块,例如OpenMP。Qt 5项目一般需要:find_package(Qt5 COMPONENTS Widgets REQUIRED)。* Z# ^4 ]6 C& c% k/ A" T
  • include_directories添加头文件include路径,一个更推荐使用的指令是 target_include_directories,其不污染后续目标的include路径,且能精细控制是否暴露依赖的包含路径。但是 target_include_directories 需要CMake 3.13 版本才支持,在Visual Studio 2017中使用会有问题。3 J* Q: l4 E) X( @/ f! G
  • link_directories设置链接库的路径,更推荐的指令是 target_link_directories,理由见 include_directories。
    ' f1 I8 W" }* \9 U" J0 F; m$ d
  • aux_source_directory将指定目录下的源文件添加到变量中,例如:aux_source_directory(./src SRC)。注意该命令不会递归包含子目录源文件。
    $ S; M2 J4 R8 `
  • filefile命令是一个功能丰富的目录和文件操作指令,例如递归找出目录下的所有源文件保存到SRC变量中:file(GLOB_RECURSE SRC "src/*.cpp" "src/*/*.cpp")。
    5 {- Q- n4 Z7 R6 y. E! ^相对于把每个需要编译的文件添加到CMakeLists.txt中,aux_source_directory 和 file 等指令可方便的引入多个文件,但其弊端之一是CMake不能感知文件变化。当新增文件、文件被删除、重命名时需刷新CMake缓存才能被应用到项目中。5 N! u0 [* s6 v; X$ Y* [8 y
  • find_library查找指定库的路径并保存到变量中。
    & \. X2 G6 E; Q" f  P# M9 K
  • add_custom_command添加自定义命令,可用于构建前进行moc,构建后拷贝文件等用途。( w8 J# i% S5 Y1 h
  • add_subdirectory添加一个需要构建的子目录,子目录下有CMakeLists.txt文件设定好构建规则。2 N. T* e- j- z1 x/ u5 _4 }" r
  • add_executable构建可执行程序,一般项目的主CMakeLists.txt中会有这条指令。& i; q& g* k/ d5 l
  • add_library构建动态或静态库,一般存在于子目录或者库的CMakeLists.txt文件中。* J: K1 @0 Q8 C3 Q. S" B' y! e
  • message可在cmake构建时输出信息。$ w% R1 S% h: a6 {( @: Q$ p3 c9 d
    CMakeLists.txt文件中指令不区分大小写,但一般来说同一个文件中指令应保持大小写风格一致。, ~+ _$ ~9 u# s/ D
    更多指令可参考 CMake官方文档。8 ^& A8 W/ t1 r7 _. G. t
    常用环境变量返回目录本小节介绍几个常用的环境变量(编译宏)。
    " g. i3 e8 y! o
  • 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的使用方式。6 C" q2 L1 D1 d5 S- {6 @
    新建Qt项目时,可以选择CMake作为构建工具:
    1 _$ f3 t3 i5 b1 Q  Z7 M4 n% I' H
    1 r. x8 |; a, d2 p7 L: Y
    $ }0 F' p8 F* w5 A8 XQt新建项目使用CMake生成项目后,项目文件夹将出现CMakeLists.txt和CMakeLists.txt.user两个文件,熟悉的.pro文件没有了(CMakeLists.txt.user充当了Qt Creator工程文件的角色,其他IDE用不到,可删除)。9 ?, R+ A% w3 w) ~* V6 ]* R
    但需要注意的是,此时Qt Creator中编译项目是没问题的,但是在CLion/VS Code中打开,或者生成Visual Studio用的.sln文件会有问题,因为CMake无法检测到Qt是否安装及其安装路径。3 w, K3 d3 o8 G* w! \9 y% W- \% Y
    解决办法便是在 project 指令后增加如下指令告知Qt的安装位置:
    & y( {% y0 i7 H* U# 具体路径请根据自身情况替换/ w" G7 E& P/ z% _
    set(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
    1 S% k( a/ G: @. Pset(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake"): N; w$ d6 L' Y( ?5 h
    然后再次运行 cmake 指令或者使用CMake GUI重新运行,构建文件夹下便能正常生成.sln项目文件。
    . [( |9 g# x/ \: j' [8 tVS中编译好后,运行时会提示无法找到Qt相关的dll导致程序不能正常运行。解决办法包括:
    & K( A) v! u4 \) ~" b0 U: i/ t1. 设置VS选项,将Qt的dll路径包含进去;
    0 J! V( s: {7 q; Y! y3 a 2. 将Qt相关dll拷贝到编译输出文件夹;
    ) H$ I4 q0 e6 A' G! [1 Q, \+ O* G 3. 设置CMake,使其能自动复制所需要的dll。
    1 D9 x) y  K4 O/ x& s1 u$ V5 F这里介绍第三种方式,原理是借助Qt自带的windeployqt.exe程序自动部署程序所需dll到目标文件夹。具体操作为,在项目根目录的CMakeLists.txt最后添加部署dll的指令:
    : q2 m" k! @; @6 F8 O# k* y0 Sset(QT_BIN_PATH "${QT_MSVC_PATH}/bin")( S8 z8 k8 K5 \/ b$ H  F5 U8 _5 z* O4 M
    function(windeployqt target)
    * y4 p) B0 @; O# POST_BUILD step- y4 x! O- w  `' ]' p4 B* y7 e
    # - after build, we have a bin/lib for analyzing qt dependencies8 b/ M) X. a2 w0 E/ H4 j
    # - we run windeployqt on target and deploy Qt libs* W2 X) u! W. q; y: {' Q7 }
    add_custom_command(TARGET ${target} POST_BUILD6 a! O; b% D3 T8 D: M# D  n
    COMMAND "${QT_BIN_PATH}/windeployqt.exe"( B& ~1 N9 s6 p) j3 B* O
    --verbose 1: ~+ X/ {1 P, @4 w; Y! `2 i
    #--release # uncomment this line if built with Release- v( Y5 x* C9 i! j
    #--no-svg
    7 }4 p+ _9 R. {) X8 t#--no-angle- v, t; N2 g0 t4 ?0 t5 n
    #--no-opengl- M4 @( `6 d. s, ~: c$ \2 f
    #--no-opengl-sw) n2 T6 Q' h6 H$ n2 l
    #--no-compiler-runtime
      z6 D3 h5 r5 }6 |" a#--no-system-d3d-compiler
    * o( O0 ~; ]3 R: j5 I9 e\"$\"
    5 n/ M: p$ l1 G& V# [9 r$ YCOMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ..."! L5 F, ~0 `9 \* N, k
    )
    : x5 t" z$ r4 t% Eendfunction()
    3 ^) I5 _& k* y% A/ K8 aif (WIN32)
    5 K7 p% c7 Q1 d  windeployqt(${PROJECT_NAME})
    1 ?  D4 P' ]% @( D: n0 l$ bendif()最后,转换成VS项目时,默认是Console项目,运行时会有cmd窗口。一个解决办法是在生成可执行文件时设置目标为 WIN32:( r2 j3 ^. W# v* T9 [" J
    add_executable(${PROJECT_NAME} WIN32 xxxx)
    6 h$ W+ v& Y' x+ x. t) K0 M 一个完整的Qt 5项目CMakeLists.txt返回目录以下是一个适用于Windows平台的Qt 5项目完整CMakeLists.txt,实际使用时请替换名字和Qt 5安装路径等:
    6 h+ l5 |9 e: M) [  S+ ncmake_minimum_required(VERSION 3.7)
    # ^1 G! w, D% n) }. j# 请将myproject改成实际的应用名字
    ) ^5 Z9 r- j# a# o1 M# \project(myproject LANGUAGES CXX)
    / c1 O+ X0 F$ fset(CMAKE_INCLUDE_CURRENT_DIR ON), G: F; Q+ G5 O4 z
    # 请更改为实际的Qt安装目录
    ! c5 c' f( x+ r  a% jset(QT_MSVC_PATH "C:\\Qt\\Qt5.12.8\\5.12.8\\msvc2017_64")
    & }  {  z6 @5 \0 ^# Q2 z! o$ ~1 \set(CMAKE_PREFIX_PATH "${QT_MSVC_PATH}/lib/cmake")* d0 [. P9 o+ y0 |2 _6 L
    set(QT_BIN_PATH "${QT_MSVC_PATH}/bin")
    : d  O4 _4 q1 @# o& r- d' b2 |1 dset(CMAKE_AUTOUIC ON)
    9 ]+ Z# n* D; f: u4 g# Tset(CMAKE_AUTOMOC ON)
    1 m) Z( v7 B: c6 j7 hset(CMAKE_AUTORCC ON)
    ! F! I0 Q1 s0 x- @" L5 T: ^+ a& k0 ^8 |set(CMAKE_CXX_STANDARD 11), v' Q" j$ l* C9 l& {( J" J/ S) ]- [
    set(CMAKE_CXX_STANDARD_REQUIRED ON)5 h) S* s+ e# m. \; I2 k
    find_package(Qt5 COMPONENTS Widgets REQUIRED)
    9 Z0 w0 s2 _7 u3 [# 默认Release构建5 f' t) K2 Y, `0 i
    if (NOT CMAKE_BUILD_TYPE)
    + b! j2 d3 z& T" `    set( CMAKE_BUILD_TYPE "Release" )
    2 j4 ?$ G- m% B: x- vendif()
    ! p0 J8 X# L5 n  w' x1 ?, v7 A/ Y2 E9 l& Umessage("build type: ${CMAKE_BUILD_TYPE}")
    5 B2 e5 ?3 @7 F( X! n0 f3 ~0 u" {# 按照自己的项目结构添加文件
      J9 Q% H# i! L7 w# 也可使用file/aux_source_directory批量引入,注意不要引入自动生成的文件!, D8 u' K: R1 n# A, K- o1 `
    add_executable(${PROJECT_NAME} WIN32
    6 m3 e1 a6 h: p/ e  main.cpp3 I6 I! z/ ], y; T
      mainwindow.cpp, u, P/ y" \0 P% D
      mainwindow.h
    4 J9 b' o, p; ^0 Y$ H$ t% S  G" Y)
    ; ]& Z) Y) e7 l9 n: R: ytarget_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
    . j! k+ C3 d8 y0 bfunction(windeployqt target)
    1 ~0 W3 G+ q1 n% Y6 V  |9 \# POST_BUILD step+ ?: q# y+ p" \6 D1 @
    add_custom_command(TARGET ${target} POST_BUILD
    + |6 F0 U8 i# ]! u$ K  F6 i' GCOMMAND "${QT_BIN_PATH}/windeployqt.exe"; k+ N: p; L* h* W9 o  q
    --verbose 18 h& b! D* N* s# I# Q9 y
    #--release $ A# l: z2 ]$ J* z" b8 U6 d1 K$ k: E
    #--no-svg
    3 r% i& C. b* V6 T, @4 |/ q, O7 u: a#--no-angle  l* V! u/ c8 ?! g
    #--no-opengl
    * ~/ n0 @8 Y- B: ^& l#--no-opengl-sw
    % ^4 l" R2 x9 w3 S) B#--no-compiler-runtime$ C5 d8 X8 N9 h8 X
    #--no-system-d3d-compiler
    " W9 j% ^! W. x, c# O; w\"$\"( J  X4 h1 y1 F
    COMMENT "Deploying Qt libraries using windeployqt for compilation target '${target}' ...") }, d9 q' ~- D+ x- _$ C2 l' L* s9 C
    )' m/ U9 ^5 u7 I# G  K( ?3 n
    endfunction()( k( G0 J, ]/ J/ u) w( Y3 E2 [
    if (WIN32)7 L' G6 C, q( f0 Q7 v& E
      windeployqt(${PROJECT_NAME})
    " M1 l. P1 V* Z& Bendif()( g3 L# o" s4 S# U7 w9 r
    ````通过上面的配置,我们的Qt项目既可在Qt Creator中正常编译运行,也可在CLion/Visual Studio中正常编译运行而 无需安装Qt插件。
    ) a: s7 |8 B* P* g1 T+ A) a: Y 参考返回目录1. CMake官网5 f+ K5 w( G3 y, m0 w+ ~% ]2 g* M
    2. CMake教程
    6 c$ z3 G5 D; ~* c. p+ ?2 ]6 ]3. CMake FAQ( d5 }% W  ]' o/ P
    4. CMake指定编译器
    5 t- p! D, j, }3 N6 o% aAD:【国外VPS推荐】 搬瓦工三网回程CN2 GIA VPS,季付46.87$打赏赞(3)
  • 本帖子中包含更多资源

    您需要 登录 才可以下载或查看,没有账号?立即注册

    x
    回复

    使用道具 举报

    您需要登录后才可以回帖 登录 | 立即注册

    本版积分规则

    Copyright © 2001-2013 Comsenz Inc.Powered by Discuz!X3.4( 沪ICP备18024137号 )
    快速回复 返回顶部 返回列表