小白學習 CmakeLists.txt 寫法
原文地址：http://blog.csdn.net/dbzhang800/article/details/6314073
- 最大的Qt4程式群(KDE4)採用cmake作為構建系統
- Qt4的python繫結(pyside)採用了cmake作為構建系統
- 開源的影象處理庫 opencv 採用cmake 作為構建系統
- ...
看來不學習一下cmake是不行了，一點一點來吧，找個最簡單的C程式，慢慢複雜化，試試看：
|
例子一 |
單個原始檔 main.c |
|
例子二 |
==>分解成多個 main.c hello.h hello.c |
|
例子三 |
==>先生成一個靜態庫，連結該庫 |
|
例子四 |
==>將原始檔放置到不同的目錄 |
|
例子五 |
==>控制生成的程式和庫所在的目錄 |
|
例子六 |
==>使用動態庫而不是靜態庫 |
例子一
一個經典的C程式，如何用cmake來進行構建程式呢？
//main.c
#include <stdio.h>
int main()
{
printf("Hello World!/n");
return 0;
}
編寫一個 CMakeList.txt 檔案(可看做cmake的工程檔案)：
project(HELLO)
set(SRC_LIST main.c)
add_executable(hello ${SRC_LIST})
然後，建立一個任意目錄（比如本目錄下建立一個build子目錄），在該build目錄下呼叫cmake
- 注意：為了簡單起見，我們從一開始就採用cmake的 out-of-source 方式來構建（即生成中間產物與原始碼分離），並始終堅持這種方法，這也就是此處為什麼單獨建立一個目錄，然後在該目錄下執行 cmake 的原因
cmake .. -G"NMake Makefiles" nmake
或者
cmake .. -G"MinGW Makefiles" make
即可生成可執行程式 hello(.exe)
目錄結構
+ | +--- main.c +--- CMakeList.txt | /--+ build/ | +--- hello.exe
cmake 真的不太好用哈，使用cmake的過程，本身也就是一個程式設計的過程，只有多練才行。
我們先看看：前面提到的這些都是什麼呢？
CMakeList.txt
第一行project不是強制性的，但最好始終都加上。這一行會引入兩個變數
- HELLO_BINARY_DIR 和 HELLO_SOURCE_DIR
同時，cmake自動定義了兩個等價的變數
-
PROJECT_BINARY_DIR和PROJECT_SOURCE_DIR
因為是out-of-source方式構建，所以我們要時刻區分這兩個變數對應的目錄
可以通過message來輸出變數的值
message(${PROJECT_SOURCE_DIR})
set命令用來設定變數
add_exectuable告訴工程生成一個可執行檔案。
add_library則告訴生成一個庫檔案。
- 注意：CMakeList.txt 檔案中，命令名字是不區分大小寫的，而引數和變數是大小寫相關的。
cmake命令
cmake 命令後跟一個路徑(..)，用來指出 CMakeList.txt 所在的位置。
由於系統中可能有多套構建環境，我們可以通過-G來制定生成哪種工程檔案，通過cmake -h可得到詳細資訊。
要顯示執行構建過程中詳細的資訊(比如為了得到更詳細的出錯資訊)，可以在CMakeList.txt內加入：
- SET( CMAKE_VERBOSE_MAKEFILE on )
或者執行make時
- $ make VERBOSE=1
或者
- $ export VERBOSE=1
- $ make
例子二
一個原始檔的例子一似乎沒什麼意思，拆成3個檔案再試試看：
- hello.h 標頭檔案
#ifndef DBZHANG_HELLO_ #define DBZHANG_HELLO_ void hello(const char* name); #endif //DBZHANG_HELLO_
- hello.c
#include <stdio.h>
#include "hello.h"
void hello(const char * name)
{
printf ("Hello %s!/n", name);
}
- main.c
#include "hello.h"
int main()
{
hello("World");
return 0;
}
- 然後準備好CMakeList.txt 檔案
project(HELLO)
set(SRC_LIST main.c hello.c)
add_executable(hello ${SRC_LIST})
執行cmake的過程同上，目錄結構
+ | +--- main.c +--- hello.h +--- hello.c +--- CMakeList.txt | /--+ build/ | +--- hello.exe
例子很簡單，沒什麼可說的。
例子三
接前面的例子，我們將 hello.c 生成一個庫，然後再使用會怎麼樣？
改寫一下前面的CMakeList.txt檔案試試：
project(HELLO)
set(LIB_SRC hello.c)
set(APP_SRC main.c)
add_library(libhello ${LIB_SRC})
add_executable(hello ${APP_SRC})
target_link_libraries(hello libhello)
和前面相比，我們添加了一個新的目標 libhello，並將其連結進hello程式
然後想前面一樣，執行cmake，得到
+ | +--- main.c +--- hello.h +--- hello.c +--- CMakeList.txt | /--+ build/ | +--- hello.exe +--- libhello.lib
裡面有一點不爽，對不？
- 因為我的可執行程式(add_executable)佔據了 hello 這個名字，所以 add_library 就不能使用這個名字了
- 然後，我們去了個libhello 的名字，這將導致生成的庫為 libhello.lib(或 liblibhello.a)，很不爽
- 想生成 hello.lib(或libhello.a) 怎麼辦?
新增一行
set_target_properties(libhello PROPERTIES OUTPUT_NAME "hello")
就可以了
例子四
在前面，我們成功地使用了庫，可是原始碼放在同一個路徑下，還是不太正規，怎麼辦呢？分開放唄
我們期待是這樣一種結構
+ | +--- CMakeList.txt +--+ src/ | | | +--- main.c | /--- CMakeList.txt | +--+ libhello/ | | | +--- hello.h | +--- hello.c | /--- CMakeList.txt | /--+ build/
哇，現在需要3個CMakeList.txt 檔案了，每個原始檔目錄都需要一個，還好，每一個都不是太複雜
- 頂層的CMakeList.txt 檔案
project(HELLO) add_subdirectory(src) add_subdirectory(libhello)
- src 中的 CMakeList.txt 檔案
include_directories(${PROJECT_SOURCE_DIR}/libhello)
set(APP_SRC main.c)
add_executable(hello ${APP_SRC})
target_link_libraries(hello libhello)
- libhello 中的 CMakeList.txt 檔案
set(LIB_SRC hello.c)
add_library(libhello ${LIB_SRC})
set_target_properties(libhello PROPERTIES OUTPUT_NAME "hello")
恩，和前面一樣，建立一個build目錄，在其內執行cmake，然後可以得到
- build/src/hello.exe
- build/libhello/hello.lib
回頭看看，這次多了點什麼，頂層的 CMakeList.txt 檔案中使用 add_subdirectory 告訴cmake去子目錄尋找新的CMakeList.txt 子檔案
在 src 的 CMakeList.txt 檔案中，新增加了include_directories，用來指明標頭檔案所在的路徑。
例子五
前面還是有一點不爽：如果想讓可執行檔案在 bin 目錄，庫檔案在 lib 目錄怎麼辦？
就像下面顯示的一樣：
+ build/
|
+--+ bin/
| |
| /--- hello.exe
|
/--+ lib/
|
/--- hello.lib
- 一種辦法：修改頂級的 CMakeList.txt 檔案
project(HELLO) add_subdirectory(src bin) add_subdirectory(libhello lib)
不是build中的目錄預設和原始碼中結構一樣麼，我們可以指定其對應的目錄在build中的名字。
這樣一來：build/src 就成了 build/bin 了，可是除了 hello.exe，中間產物也進來了。還不是我們最想要的。
- 另一種方法：不修改頂級的檔案，修改其他兩個檔案
src/CMakeList.txt 檔案
include_directories(${PROJECT_SOURCE_DIR}/libhello)
#link_directories(${PROJECT_BINARY_DIR}/lib)
set(APP_SRC main.c)
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
add_executable(hello ${APP_SRC})
target_link_libraries(hello libhello)
libhello/CMakeList.txt 檔案
set(LIB_SRC hello.c)
add_library(libhello ${LIB_SRC})
set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)
set_target_properties(libhello PROPERTIES OUTPUT_NAME "hello")
例子六
在例子三至五中，我們始終用的靜態庫，那麼用動態庫應該更酷一點吧。 試著寫一下
如果不考慮windows下，這個例子應該是很簡單的，只需要在上個例子的 libhello/CMakeList.txt 檔案中的add_library命令中加入一個SHARED引數：
add_library(libhello SHARED ${LIB_SRC})
可是，我們既然用cmake了，還是兼顧不同的平臺吧，於是，事情有點複雜：
- 修改 hello.h 檔案
#ifndef DBZHANG_HELLO_
#define DBZHANG_HELLO_
#if defined _WIN32
#if LIBHELLO_BUILD
#define LIBHELLO_API __declspec(dllexport)
#else
#define LIBHELLO_API __declspec(dllimport)
#endif
#else
#define LIBHELLO_API
#endif
LIBHELLO_API void hello(const char* name);
#endif //DBZHANG_HELLO_
- 修改 libhello/CMakeList.txt 檔案
set(LIB_SRC hello.c)
add_definitions("-DLIBHELLO_BUILD")
add_library(libhello SHARED ${LIB_SRC})
set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)
set_target_properties(libhello PROPERTIES OUTPUT_NAME "hello")
恩，剩下來的工作就和原來一樣了。