qt系列之一qmake_makefile.txt

该资料是介绍Qt技术的一些心得体会

前言：

    很早之前就在看Qt的相关书籍，忙于考研，便断断续续。现在又接着学习下去。学习Qt源于在北京大学读博的一个师兄指点。今天看Qt的help文件，里面提到了qmake和makefile，但是寥寥几字，让人不知所云。想到很早之前就遇见过makefile，那时候更是一头雾水，今晚又看到了，

    便想弄个明白。通过查相关的网页（http://www.qiliang.net/qt/index.html）和另外一些高手的blog，我有个初步的理解，在此便整理并发表。

一、qmake的介绍
     qmake是Trolltech公司创建的用来为不同的平台和编译器书写Makefile的工具。 

     手写Makefile是比较困难并且容易出错的，尤其是需要给不同的平台和编译器组合写几个Makefile。使用qmake，开发者创建一个简单的“项目”文件并且运行qmake生成适当的Makefile。qmake会注意所有的编译器和平台的依赖性，可以把开发者解放出来只关心他们的代码。Trolltech公司使用qmake作为Qt库和Qt所提供的工具的主要连编工具。 qmake也注意了Qt的特殊需求，可以自动的包含moc和uic的连编规则。
     虽说qmake是Trolltech公司为Qt程序生成Makefile的工具，但是它的应用远远比这个广：它可以为不同平台、不同编译器写Makefile文件，也不仅限于Qt程序。
二、qmake的概念
1、QMAKESPEC环境变量
      举例来说，如果你在Windows下使用Microsoft Visual Studio，然后你需要把QMAKESPEC环境变量设置为win32-msvc。如果你在Solaris上使用gcc，你需要把QMAKESPEC环境变量设置为solaris-g++。

      在qt/mkspecs中的每一个目录里面，都有一个包含了平台和编译器特定信息的qmake.conf文件。这些设置适用于你要使用qmake的任何项目，请不要修改它，除非你是一个专家。例如，假如你所有的应用程序都必须和一个特定的库连接，你可以把这个信息添加到相应的qmake.conf文件中。



2、项目(.pro)文件
     一个项目文件是用来告诉qmake关于为这个应用程序创建makefile所需要的细节。例如，一个源文件和头文件的列表、任何应用程序特定配置、例如一个必需要连接的额外库、或者一个额外的包含路径，都应该放到项目文件中。

“#”注释
       你可以为项目文件添加注释。注释由“#”符号开始，一直到这一行的结束。

模板
      模板变量告诉qmake为这个应用程序生成哪种makefile。下面是可供使用的选择：

      app - 建立一个应用程序的makefile。这是默认值，所以如果模板没有被指定，这个将被使用。

     lib - 建立一个库的makefile。

     vcapp - 建立一个应用程序的Visual Studio项目文件。

     vclib - 建立一个库的Visual Studio项目文件。

     subdirs - 这是一个特殊的模板，它可以创建一个能够进入特定目录并且为一个项目文件生成makefile并且为它调用make的makefile。


“app”模板告诉qmake为建立一个应用程序生成一个makefile。当使用这个模板时，下面这些qmake系统变量是被承认的。你应该在你的.pro文

件中使用它们来为你的应用程序指定特定信息。

HEADERS - 应用程序中的所有头文件的列表。

SOURCES - 应用程序中的所有源文件的列表。

FORMS - 应用程序中的所有.ui文件（由Qt设计器生成）的列表。

LEXSOURCES - 应用程序中的所有lex源文件的列表。

YACCSOURCES - 应用程序中的所有yacc源文件的列表。

TARGET - 可执行应用程序的名称。默认值为项目文件的名称。（如果需要扩展名，会被自动加上。）

DESTDIR - 放置可执行程序目标的目录。

DEFINES - 应用程序所需的额外的预处理程序定义的列表。

INCLUDEPATH - 应用程序所需的额外的包含路径的列表。

DEPENDPATH - 应用程序所依赖的搜索路径。

VPATH - 寻找补充文件的搜索路径。

DEF_FILE - 只有Windows需要：应用程序所要连接的.def文件。

RC_FILE - 只有Windows需要：应用程序的资源文件。

RES_FILE - 只有Windows需要：应用程序所要连接的资源文件。

你只需要使用那些你已经有值的系统变量，例如，如果你不需要任何额外的INCLUDEPATH，那么你就不需要指定它，qmake会为所需的提供默认

值。例如，一个实例项目文件也许就像这样：

TEMPLATE = app
DESTDIR  = c:\helloapp
HEADERS += hello.h
SOURCES += hello.cpp 
SOURCES += main.cpp
DEFINES += QT_DLL
CONFIG  += qt warn_on release

如果条目是单值的，比如template或者目的目录，我们是用“=”，但如果是多值条目，我们使用“+=”来为这个类型添加现有的条目。使用“

=”会用新值替换原有的值，例如，如果我们写了DEFINES=QT_DLL，其它所有的定义都将被删除。

“lib”模板
“lib”模板告诉qmake为建立一个库而生成makefile。当使用这个模板时，除了“app”模板中提到系统变量，还有一个VERSION是被支持的。

你需要在为库指定特定信息的.pro文件中使用它们。

VERSION - 目标库的版本号，比如，2.3.1。

“subdirs”模板
“subdirs”模板告诉qmake生成一个makefile，它可以进入到特定子目录并为这个目录中的项目文件生成makefile并且为它调用make。

在这个模板中只有一个系统变量SUBDIRS可以被识别。这个变量中包含了所要处理的含有项目文件的子目录的列表。这个项目文件的名称是和子

目录同名的，这样qmake就可以发现它。例如，如果子目里是“myapp”，那么在这个目录中的项目文件应该被叫做myapp.pro。



CONFIG变量
配置变量指定了编译器所要使用的选项和所需要被连接的库。配置变量中可以添加任何东西，但只有下面这些选项可以被qmake识别。

下面这些选项控制着使用哪些编译器标志：

release - 应用程序将以release模式连编。如果“debug”被指定，它将被忽略。

debug - 应用程序将以debug模式连编。

warn_on - 编译器会输出尽可能多的警告信息。如果“warn_off”被指定，它将被忽略。

warn_off - 编译器会输出尽可能少的警告信息。



下面这些选项定义了所要连编的库/应用程序的类型：

qt - 应用程序是一个Qt应用程序，并且Qt库将会被连接。

thread - 应用程序是一个多线程应用程序。

x11 - 应用程序是一个X11应用程序或库。

windows - 只用于“app”模板：应用程序是一个Windows下的窗口应用程序。

console - 只用于“app”模板：应用程序是一个Windows下的控制台应用程序。

dll - 只用于“lib”模板：库是一个共享库（dll）。

staticlib - 只用于“lib”模板：库是一个静态库。

plugin - 只用于“lib”模板：库是一个插件，这将会使dll选项生效。

例如，如果你的应用程序使用Qt库，并且你想把它连编为一个可调试的多线程的应用程序，你的项目文件应该会有下面这行：

    CONFIG += qt thread debug

注意，你必须使用“+=”，不要使用“=”，否则qmake就不能正确使用连编Qt的设置了，比如没法获得所编译的Qt库的类型了。


三、qmake的安装
   一般在安装Qt库的时候就将qmake安装好了，故在此不作阐述。



四、qmake的使用
   第一、需要手动书写.pro文件
    .pro文件就是将需要连接、编译的.h、.cpp及其它一些资源的信息、配置设置等以特定的文件格式排列在一起的文本文件。在这里用例子

说明.pro文件格式，如下：
   #  hello.pro
    SOURCES = hello.cpp
    HEADERS = hello.h
    CONFIG += qt warn_on release
   # file end
详细解释：

    SOURCES = hello.cpp
这一行指定了实现应用程序的源程序文件。在这个例子中，恰好只有一个文件，hello.cpp。大部分应用程序需要多个文件，这种情况下可以把

文件列在一行中，以空格分隔，就像这样：

    SOURCES = hello.cpp main.cpp

另一种方式，每一个文件可以被列在一个分开的行里面，通过反斜线另起一行，就像这样：

    SOURCES = hello.cpp \
  main.cpp

一个更冗长的方法是单独地列出每一个文件，就像这样：

    SOURCES += hello.cpp
    SOURCES += main.cpp

这种方法中使用“+=”比“=”更安全，因为它只是向已有的列表中添加新的文件，而不是替换整个列表。

HEADERS这一行中通常用来指定为这个应用程序创建的头文件，举例来说：

    HEADERS += hello.h

列出源文件的任何一个方法对头文件也都适用。

CONFIG这一行是用来告诉qmake关于应用程序的配置信息。

    CONFIG += qt warn_on release

在这里使用“+=”，是因为我们添加我们的配置选项到任何一个已经存在中。这样做比使用“=”那样替换已经指定的所有选项是更安全的。

CONFIG一行中的qt部分告诉qmake这个应用程序是使用Qt来连编的。这也就是说qmake在连接和为编译添加所需的包含路径的时候会考虑到Qt库

的。

CONFIG一行中的warn_on部分告诉qmake要把编译器设置为输出警告信息的。

CONFIG一行中的release部分告诉qmake应用程序必须被连编为一个发布的应用程序。在开发过程中，程序员也可以使用debug来替换release。

项目文件就是纯文本（比如，可以使用像记事本、vim和xemacs这些编辑器）并且必须存为“.pro”扩展名。应用程序的执行文件的名称必须和

项目文件的名称一样，但是扩展名是跟着平台而改变的。举例来说，一个叫做“hello.pro”的项目文件将会在Windows下生成“hello.exe”，

而在Unix下生成“hello”。
如果你想设置一个不同的名字，你可以在项目文件中设置它：

    TARGET = helloworld

最后一步是设置CONFIG变量。因为这是一个Qt应用程序，我们需要把“qt”放到CONFIG这一行中，这样qmake才会在连接的时候添加相关的库，

并且保证moc和uic的连编行也被包含到Makefile中。

最终完成的项目文件应该是这样的：

    CONFIG += qt
    HEADERS += hello.h
    SOURCES += hello.cpp
    SOURCES += main.cpp 

添加特定平台的源文件
在编了几个小时的程序之后，你也许开始为你的应用程序编写与平台相关的部分，并且决定根据平台的不同编写不同的代码。所以现在你有两

个信文件要包含到你的项目文件中－hello_win.cpp和hello_x11.cpp。我们不能仅仅把这两个文件放到SOURCES变量中，因为那样的话会把这两

个文件都加到Makefile中。所以我们在这里需要做的是根据qmake所运行的平台来使用相应的作用域来进行处理。

为Windows平台添加的依赖平台的文件的简单的作用域看起来就像这样：

    win32 {
 SOURCES += hello_win.cpp
    }

所以如果qmake运行在Windows上的时候，它就会把hello_win.cpp添加到源文件列表中。如果qmake运行在其它平台上的时候，它会很简单地把

这部分忽略。现在接下来我们要做的就是添加一个X11依赖文件的作用域。

当你做完了这部分，你的项目文件应该和这样差不多：

    CONFIG += qt debug
    HEADERS += hello.h
    SOURCES += hello.cpp
    SOURCES += main.cpp 
    win32 {
 SOURCES += hello_win.cpp
    }
    x11 {
 SOURCES += hello_x11.cpp
    }

像前面一样使用qmake来生成Makefile。

如果一个文件不存在，停止qmake
如果某一个文件不存在的时候，你也许不想生成一个Makefile。我们可以通过使用exists()函数来检查一个文件是否存在。我们可以通过使用

error()函数把正在运行的qmake停下来。这和作用域的工作方式一样。只要很简单地用这个函数来替换作用域条件。对main.cpp文件的检查就

像这样：

    !exists( main.cpp ) {
 error( "No main.cpp file found" )
    }

“!”用来否定这个测试，比如，如果文件存在，exists( main.cpp )是真，如果文件不存在，!exists( main.cpp )是真。

    CONFIG += qt debug
    HEADERS += hello.h
    SOURCES += hello.cpp
    SOURCES += main.cpp 
    win32 {
 SOURCES += hello_win.cpp
    }
    x11 {
 SOURCES += hello_x11.cpp
    }
    !exists( main.cpp ) {
 error( "No main.cpp file found" )
    }

像前面一样使用qmake来生成Makefile。如果你临时改变main.cpp的名称，你会看到信息，并且qmake会停止处理。

检查多于一个的条件
假设你使用Windows并且当你在命令行运行你的应用程序的时候你想能够看到qDebug()语句。除非你在连编你的程序的时候使用console设置，

你不会看到输出。我们可以很容易地把console添加到CONFIG行中，这样在Windows下，Makefile就会有这个设置。但是如果告诉你我们只是想

在当我们的应用程序运行在Windows下并且当debug已经在CONFIG行中的时候，添加console。这需要两个嵌套的作用域；只要生成一个作用域，

然后在它里面再生成另一个。把设置放在最里面的作用域里，就像这样：

    win32 {
 debug {
     CONFIG += console
 }
    }

嵌套的作用域可以使用冒号连接起来，所以最终的项目文件看起来像这样：

    CONFIG += qt debug
    HEADERS += hello.h
    SOURCES += hello.cpp
    SOURCES += main.cpp 
    win32 {
 SOURCES += hello_win.cpp
    }
    x11 {
 SOURCES += hello_x11.cpp
    }
    !exists( main.cpp ) {
 error( "No main.cpp file found" )
    }
    win32:debug {
 CONFIG += console
    }

就这些了！你现在已经完成了qmake的教程，并且已经准备好为你的开发项目写项目文件了。


第二、生成Makefile
将书写的.pro文件放在源文件的目录下；
打开Qt 的命令输入框，使用cd命令将.pro文件所在的目录设置成当前目录；
单纯的生成Makefile文件只需要在命令框中输入：qmake -o Makefile hello.pro 
对于Visual Studio的用户，qmake也可以生成“.dsp”文件，例如：qmake -t vcapp -o hello.dsp hello.pro，这样就生成了Makefile文件。



第三、生成可执行程序
使用make命令或者nmake命令生成可执行文件。nmake和make的选择依据是：Delphi是make，Visual C++是nmake，Linux下GNU是make。
在命令框中输入相应的命令就可得到可执行文件。