简单理解Qt项目的CMakeLists.txt

本文简单研究了Qt生成的默认的CMakeLists.txt。理解之后便可以较为合理地设计自己的Qt程序。

Qt的典型CMakeLists.txt的逐段解析如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# CMake的最低版本号为3.5
cmake_minimum_required(VERSION 3.5)

# project名称是"untitled"，版本号是0.1，编译语言是C++
project(untitled VERSION 0.1 LANGUAGES CXX)

# 将当前目录添加到include之内
set(CMAKE_INCLUDE_CURRENT_DIR ON)

# 自动编译.ui文件，只有添加了Qt组件才能起作用
set(CMAKE_AUTOUIC ON)、
# 自动进行MOC，只有添加了Qt组件才能起作用
set(CMAKE_AUTOMOC ON)
# 自动解析RCC资源文件，只有添加了Qt组件才能起作用
set(CMAKE_AUTORCC ON)

# 使用C++17标准
set(CMAKE_CXX_STANDARD 17)
# 确保预先提供C++版本是必要的，否则编译时可能忽略前文对C++17的要求
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# 导入QT Widgets包，找Qt6或者Qt5的包均可
find_package(QT NAMES Qt6 Qt5 REQUIRED COMPONENTS Widgets)
# 根据找到的Qt版本，再次导入Widgets
find_package(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS Widgets)

# 设置需要编译的源文件，.ui文件使用AUTOUIC处理。
set(PROJECT_SOURCES
        main.cpp
        mainwindow.cpp
        mainwindow.h
        mainwindow.ui
)

# 针对Qt6和Qt5的不同处理
if(${QT_VERSION_MAJOR} GREATER_EQUAL 6)
    # 如果是Qt6，会引入更多的特性，正文中有所解释
    qt_add_executable(untitled
        MANUAL_FINALIZATION
        ${PROJECT_SOURCES}
    )
# Define target properties for Android with Qt 6 as:
#    set_property(TARGET untitled APPEND PROPERTY QT_ANDROID_PACKAGE_SOURCE_DIR
#                 ${CMAKE_CURRENT_SOURCE_DIR}/android)
# For more information, see https://doc.qt.io/qt-6/qt-add-executable.html#target-creation
else()
    # 如果是Qt5，则按照一般处理
    if(ANDROID)
        add_library(untitled SHARED
            ${PROJECT_SOURCES}
        )
# Define properties for Android with Qt 5 after find_package() calls as:
#    set(ANDROID_PACKAGE_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/android")
    else()
        add_executable(untitled
            ${PROJECT_SOURCES}
        )
    endif()
endif()

# 链接Widgets到输出文件上
# 默认动态链接，如果需要静态链接，需要指定链接库的后缀.lib
target_link_libraries(untitled PRIVATE Qt${QT_VERSION_MAJOR}::Widgets)

# 设置目标的一些属性
set_target_properties(untitled PROPERTIES
    MACOSX_BUNDLE_GUI_IDENTIFIER my.example.com
    MACOSX_BUNDLE_BUNDLE_VERSION ${PROJECT_VERSION}
    MACOSX_BUNDLE_SHORT_VERSION_STRING ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}
    MACOSX_BUNDLE TRUE
    WIN32_EXECUTABLE TRUE
)

# Qt6 的特性
if(QT_VERSION_MAJOR EQUAL 6)
    qt_finalize_executable(untitled)
endif()

Qt6带来的变化

文中体现出来的变化主要在于qt_add_executable和qt_finalize_target.

qt_add_executable的工作是为目标平台构建一个适当的目标、将目标链接到Qt::Core库和处理CMake目标构建完成后的结束动作(finalization)。

qt_finalize_target是和上一个指令配合使用的，如果定义了MANUAL_FINALIZATION，需要在合适的地方手动进行结束动作。

其中为了多平台，qt_add_executable主要的区别在于：

  • Android平台上，只创建MODULE库，忽略任何 WIN32 或 MACOSX_BUNDLE选项，接受Android的特性选项。
  • 其他平台上，创建一个可执行目标。

qt_finalize_target的主要区别在于：

  • Android，创建一个部署环境，创建APK打包。
  • WASM，创建${target}.html,qtloader.js,qtlogo.svg文件。
  • iOS，补全没有设置的属性，比如XCODE_ATTRIBUTE_DEVELOPMENT_TEAM，MACOSX_BUNDLE_GUI_IDENTIFIER之类的。

当然这里的简单介绍跟没说一样。自己进行相应的程序构建之后才能理解为什么需要新的特性。

几个值得一看的文档如下。

qt_add_executable

qt_finalize_target

qt_add_executable

其他

关于三个AUTO工具其实也有很多学问，可以参考文章如下。

AUTOUIC - CMake 3.24.0 Documentation

AUTOMOC - CMake 3.24.0 Documentation

AUTORCC - CMake 3.24.0 Documentation

计算机知识 Qt
编程

本博客所有文章除特别声明外，均采用 CC BY-SA 4.0 协议 ，转载请注明出处！