用 cmake 构建Qt工程(对比qmake进行学习)

cmake vs qmake

• qmake 是为 Qt 量身打造的，使用起来非常方便
• cmake 使用上不如qmake简单直接，但复杂换来的是强大的功能

  • 内置的 out-of source 构建。（目前QtCreator为qmake也默认启用了该功能。参考：浅谈 qmake 之 shadow build）

  • 为各种平台和场景提供条件编译

  • 可处理多个可执行文件情况，和很好配合 QtTest 工作

如何选择?

Using CMake to Build Qt Projects 一文中说：

• 对简单的Qt工程，采用 qmake
• 对复杂度超过 qmake 处理能力的，采用 cmake

尽管如此，如果简单Qt的工程都不知道怎么用 cmake 构建，复杂的工程，就更不知道如何使用 cmake 了。还是从简单的学起吧

简单的 Qt 程序

#include <QtCore/QCoreApplication>
#include <QtCore/QDebug>
int main(int argc, char** argv)
{
    QCoreApplication app(argc, argv);
    qDebug()<<"hello qt!";
    app.exec();
}

如果不使用构建工具，直接调用编译器来编译的话，只需要类似这样的一条命令：

g++ main.cpp -Ie:\Qt\4.7.0\include -o main -Le:\Qt\4.7.0\lib -lQtCore4

指定头文件目录，以及需要链接的库

qmake

qmake 需要一个 .pro 文件:

CONFIG += qt
QT -= gui
SOURCES += main.cpp

• 因为我们需要 Qt的库和头文件，所以需要 CONFIG += qt 。

  • 这是默认项，可直接去掉该行
• 启用qt后，可以通过 QT -= gui 来进一步细调我们需要的模块
  • 默认是 core gui。我们不需要gui模块，故去掉。

cmake

cmake 需要一个 CMakeLists.txt 文件：

PROJECT(example)
FIND_PACKAGE(Qt4 REQUIRED)
SET(QT_DONT_USE_QTGUI TRUE)
INCLUDE(${QT_USE_FILE})
ADD_EXECUTABLE(example main.cpp)
TARGET_LINK_LIBRARIES(example ${QT_LIBRARIES})

• FIND_PACKAGE 来启用 Qt4
• 默认使用了core 和 gui，故手动禁用 QTGUI

  • 这两行可以直接使用 FIND_PACKAGE(Qt4 COMPONENTS QtCore REQUIRED)，未指定的模块将被禁用

• 包含一个CMake为Qt提供的配置文件，${QT_USE_FILE}变量是一个文件名
• 添加可执行程序目标
• 链接到 Qt 的库

复杂一点

考虑一个常规Qt程序：

• main.cpp
• mainwindows.ui
• mainwindows.h
• mainwindows.cpp

如果手动编译的话：

• mainwindow.ui 需要使用 uic 预处理

uic mainwindow.ui -o ui_mainwindow.h

• mainwindow.h 需要 moc 预处理

moc mainwindow.h -o moc_mainwindow.cpp

• 调用编译器进行编译

g++ main.cpp mainwindow.cpp  moc_mainwindow.cpp -Ie:\Qt\4.7.0\include -o main  -Le:\Qt\4.7.0\lib -lQtCore4 -lQtGui4

qmake

使用 qmake 的的话，一个简单的 pro 文件

TARGET = example
TEMPLATE = app
SOURCES += main.cpp mainwindow.cpp
HEADERS  += mainwindow.h
FORMS    += mainwindow.ui

HEADERS 中的文件是否需要 moc 进行预处理，qmake 运行时会根据其是否含有Q_OBJECT自动判断。

这也是为什么 很多人添加Q_OBJECT宏后不重新运行qmake会出错误的原因。

cmake

看看相应的 cmake 的 CMakeLists.txt 文件

PROJECT(example)
CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
FIND_PACKAGE(Qt4 REQUIRED)
INCLUDE(${QT_USE_FILE})
INCLUDE_DIRECTORIES(${CMAKE_CURRENT_BINARY_DIR})
QT4_WRAP_CPP(example_MOCS mainwindow.h)
QT4_WRAP_UI(example_UIS mainwindow.ui)
ADD_EXECUTABLE(example main.cpp mainwindow.cpp ${example_MOCS})
TARGET_LINK_LIBRARIES(example ${QT_LIBRARIES})

• 需要 moc 的文件，用 QT4_WRAP_CPP 处理
  • 生成的文件放入变量 example_MOCS 中，最后一块链接到可执行程序
• 需要 uic 的文件，用 QT4_WRAP_UI 处理

Windows

因为windows下链接时分为 console 和 windows 两个子系统，所以windows下有些问题需要特殊处理。

用 qmake 时：

• 默认是 windows 子系统
• 可以通过 CONFIG += console 使用 console 子系统

用 cmake 是：

• 默认是 console 子系统
• 使用 windows 子系统需要

SET(QT_USE_QTMAIN TRUE)
ADD_EXECUTABLE(example WIN32 main.cpp mainwindow.cpp ${example_MOCS})

前者启用 qtmain.lib 库来提供windows下的 WinMain 入口函数。后者链接 windows 子系统

再复杂一点

• main.cpp
• mainwindows.ui
• mainwindows.h
• mainwindows.cpp
• main.qrc
• main.rc

前面已经用到了Qt的 moc 和 uic，这次增加了资源系统 需要用 rcc

rcc main.qrc -o qrc_main.cpp

同时，使用了windows下的资源文件 .rc (比如给程序添加图标)

• MVSC 中使用 rc.exe 对 .rc 文件进行处理
• MinGW 中使用 windres.exe 处理 .rc 文件

qmake

TARGET = example
TEMPLATE = lib
HEADERS = mainwindow.h widget.h
SOURCES = main.cpp widget.cpp  mainwindow.cpp
RESOURCES = main.qrc
RC_FILE = main.rc

cmake

PROJECT(example)
CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
FIND_PACKAGE(Qt4 REQUIRED)
SET(QT_USE_QTMAIN TRUE)
INCLUDE(${QT_USE_FILE})
INCLUDE_DIRECTORIES(${CMAKE_CURRENT_BINARY_DIR})

if(MINGW)
  set(CMAKE_RC_COMPILER_INIT windres)
  ENABLE_LANGUAGE(RC)
  SET(CMAKE_RC_COMPILE_OBJECT
    "<CMAKE_RC_COMPILER> <FLAGS> -O coff <DEFINES> -i <SOURCE> -o <OBJECT>")
endif(MINGW)

SET(example_SRCS main.cpp mainwindow.cpp widget.cpp res/main.rc)
SET(example_MOC_SRCS mainwindow.h widget.h)
QT4_WRAP_CPP(example_MOCS ${example_MOC_SRCS})
QT4_ADD_RESOURCES(example_RCC_SRCS main.qrc)
SET(example_SRCS ${example_SRCS} ${example_MOCS} ${example_RCC_SRCS})

ADD_EXECUTABLE(example WIN32 main.cpp mainwindow.cpp ${example_SRCS})
TARGET_LINK_LIBRARIES(example ${QT_LIBRARIES})

• 对Qt的资源文件，使用 QT4_ADD_RESOURCES 来调用rcc进行预处理
• 对 Windows 资源文件，直接和源文件一样，添加到列表中即可。只是：
  • MinGW 下仅仅这么做还不行，上面的 MinGW 块用来修复这个问题

Debug 与 Release

qmake

使用 qmake 时，可以在 pro 文件内分别为两种模式设置不同的选项。

使用时，可以直接 make release 或 make debug 来编译不同的版本

cmake

不同于 qmake，由于 cmake 采用 out-of-source 方式。故：

• 建立debug release两目录，分别在其中执行cmake -DCMAKE_BUILD_TYPE=Debug（或Release）
• 需要编译不同版本时进入不同目录执行make

对生成 msvc 工程的情况, CMAKE_BUILD_TYPE 不起作用。生成工程后使用IDE自带的模式选择。

参考

• http://developer.qt.nokia.com/quarterly/view/using_cmake_to_build_qt_projects

• http://www.cmake.org/cmake/help/cmake-2-8-docs.html

• http://www.qtcentre.org/wiki/index.php?title=Compiling_Qt4_apps_with_CMake

• http://stackoverflow.com/questions/3526794/how-do-i-build-a-win32-app-with-a-resource-file-using-cmake-and-mingw

• http://stackoverflow.com/questions/1372105/cmake-variable-or-property-to-discern-betwen-debug-and-release-builds