公司引擎是用cmake根據目標平台來構建工程的,剛接觸的時候深深體會到cmake的方便:如果目標平台是windows,它可以幫你自動構建出vs工程;如果是安卓,自動構建出eclipse工程,如果是IOS,自動構建出xcode工程。想想以前用vs建工程的時候,如果要引入第三方庫,必須要手動配置第三方庫路徑,如果引入的庫少,那還沒什么,如果多的話就悲劇了,配個環境都要半天。再想想以前在linux平台下手動寫Makefile的時候,如果工程比較小,模塊少還好辦,如果工程大,模塊多,各種寫依賴關系都要讓你抓狂。有了cmake這個工具,我們完全可以靠它來幫我們構建vs工程,寫Makefile文件。既然cmake構建工程這么方便,當然需要拿來用,可是對於我這個小白來說,怎么學呢?果斷谷歌,百度,不過並沒有找到比較有價值的學習資料,很多人都是貼出了cmake的源文件CMakeLists.txt,然后對文件中的每行都講了下作用。看完這些,我依然不知道為什么要這么寫,為什么這行要這樣寫,那行要那樣寫?后來才反應過來,cmake官網肯定有講啊,雖然是英文的,雖然自己英文比較挫,沒辦法,誰叫沒有其它資料呢(其實官網講的才說最權威的,不要因為是英文就畏懼,看多了其實英文也沒那么難,很多人自認為英文不行或者看英文吃力就去網上找各種中文資料,結果可能花費了大量時間在找資料上,到最后啥都沒學到)。本文主要通過講解cmake中一些比較簡單的命令來構建自己的工程,作為初學者的入門。
1、兩行命令幫你構建輸出hello world的vs工程
為了自動構建工程,需要在源文件所在的最上層目錄寫一個CMakeLists.txt文件,它是cmake的源文件,也可以看作是cmake的腳本文件,這個文件描述了cmake怎樣幫我們自動構建工程。現在我們有一個hello.cpp文件,需要用這個文件來構建一個vs工程,手動的方法就是打開vs,新建一個工程hello,然后把hello.cpp添加到hello工程里面。而有了cmake,只需要在CMakeLists.txt寫兩行命令,第一行給自己工程命個名hello,第二行hello工程需要的源文件hello.cpp。然后通過下面幾個步驟,就可以生成一個vs工程了,生成其它工程的步驟相同,只是在選擇目標工程的時候不同。
1.1 編寫CMakeLists.txt文件和hello.cpp文件
CMakeLists.txt
project(hello)
add_executable(hello hello.cpp)
hello.cpp
#include <stdio.h> int main (int argc, char *argv[]) { printf("hello world!"); return 0; }
1.2 設置路徑
1.3 設置目標工程為vs工程
1.4 產生vs工程
1.5 打開vs工程,編譯運行程序
2 添加子模塊
對於比較大的工程來說,包含多個子模塊是很常見的事,因為通常每個人只是負責他自己的模塊。那么怎樣將各個模塊加入到主工程中呢?首先我們需要使用cmake來創建各個子模塊的工程,然后再將這些模塊加入到整個工程中。假設現在我們有一個子模塊myhello,它提供了一個函數PrintHelloWorld來打印hello world!,主模塊hello調用這個函數來打印。首先我們在hello.cpp所在目錄創建myhello文件夾,將myhello.cpp和myhello.h放到里面,然后在這個文件夾中創建CMakeLists.txt。這三個文件的具體內容如下:
myhello/myhello.h:
void PrintHelloWorld();
myhello/myhello.cpp
#include <stdio.h> void PrintHelloWorld() { printf("hello world!"); }
myhello/CMakeLists.txt
add_library(myhello myhello.cpp)
這個CMakeLists.txt主要是告訴cmake,為myhello創建一個庫工程。
hello.cpp
#include "myhello/myhello.h" int main (int argc, char *argv[]) { PrintHelloWorld(); return 0; }
CMakeLists.txt
cmake_minimum_required(VERSION 3.5)
project(hello)
add_subdirectory(myhello) set (EXTRA_LIBS ${EXTRA_LIBS} myhello) add_executable(hello hello.cpp) target_link_libraries (hello ${EXTRA_LIBS})
add_subdirectory將myhello子工程加入到主工程,target_link_libraries將子模myhello鏈接到hello中。然后重新cmake下,打開vs就可以編譯運行啦。
3 添加可配置的頭文件
cmake可以通過可配置的頭文件來產生實際的頭文件,如下面的可配置頭文件hello.h.in,里面@@引用的變量可以通過CMakeLists.txt來設置,最后通過cmake來替換hello.h.in文件中的變量並生成hello.h內容。
hello.h.in
#define VERSION_MAJOR @VERSION_MAJOR@ #define VERSION_MINOR @VERSION_MINOR@
CMakeLists.txt
cmake_minimum_required(VERSION 3.5) project(hello) include_directories("${PROJECT_BINARY_DIR}") set(VERSION_MAJOR 1) set(VERSION_MINOR 0) configure_file( "${PROJECT_SOURCE_DIR}/hello.h.in" "${PROJECT_BINARY_DIR}/hello.h" ) add_subdirectory(myhello) set (EXTRA_LIBS ${EXTRA_LIBS} myhello) add_executable(hello hello.cpp) target_link_libraries (hello ${EXTRA_LIBS})
上面加紅的命令主要用來設置hello.h.in中的兩個變量,並且讓cmake生成hello.h文件。生成的hello.h如下:
hello.h
#define VERSION_MAJOR 1 #define VERSION_MINOR 0
再修改下hello.cpp文件使用這兩個變量,
hello.cpp
#include "myhello/myhello.h" #include "hello.h" #include <stdio.h> int main (int argc, char *argv[]) { printf("version:%d.%d\n", VERSION_MAJOR, VERSION_MINOR); PrintHelloWorld(); return 0; }
打開vs工程,編譯運行輸出者兩個變量的值。這樣就可以通過在CMakeLists.txt中設置變量的內容來動態修改.h文件,增加了代碼的靈活性。
4 檢測系統是否有支持工程需要的函數
對於跨平台的工程來說,檢查系統是否支持某些特性是很有必要的,這樣程序中就可以通過系統的特性來選擇具體執行哪些代碼。其中檢查是否支持某些函數是我們經常要做的事情,如epoll函數,可能有的linux系統就不支持,對於不支持的系統我們只能用poll來替代等。在cmake中檢查系統是否支持某個函數也很簡單,先包含一個CheckFunctionExists庫,然后使用check_function_exists來判斷就行了。
CMakeLists.txt
cmake_minimum_required(VERSION 3.5) project(hello) include (CheckFunctionExists) check_function_exists (printf HAVE_PRINTF) include_directories("${PROJECT_BINARY_DIR}") set(VERSION_MAJOR 1) set(VERSION_MINOR 0) configure_file( "${PROJECT_SOURCE_DIR}/hello.h.in" "${PROJECT_BINARY_DIR}/hello.h" ) add_subdirectory(myhello) set (EXTRA_LIBS ${EXTRA_LIBS} myhello) add_executable(hello hello.cpp) target_link_libraries (hello ${EXTRA_LIBS})
在配置的頭文件hello.h.in中加入#cmakedefine HAVE_PRINTF,這樣如果系統中有printf函數,最終生成的hello.h中會定義HAVE_PRINTF這個宏,否則不會生成這個宏,在hello.cpp文件中可以根據這個宏來是否定義來判斷是否應該使用printf函數。
hello.h.in
#define VERSION_MAJOR @VERSION_MAJOR@ #define VERSION_MINOR @VERSION_MINOR@ #cmakedefine HAVE_PRINTF
hello.cpp
#include "myhello/myhello.h" #include "hello.h" #include <stdio.h> int main (int argc, char *argv[]) { #ifdef HAVE_PRINTF printf("version:%d.%d\n", VERSION_MAJOR, VERSION_MINOR); #endif PrintHelloWorld(); return 0; }
運行結果:
5 配置可選項
有時候代碼可能包含了所有平台的模塊代碼,但是對於特定的目標平台,只需要配置該平台需要模塊的代碼,而不需要配置其它平台模塊的代碼。這種需求可以通過cmake的配置可選項來完成,配置可選項就是cmake在生成工程的時候提示你一些選項,根據你的選項來具體選擇需要添加到工程中的模塊代碼。例如我現在需要提高是否使用myhello模塊的選項,可以在CMakeLists.txt中加option命令來實現,代碼如下:
cmake_minimum_required(VERSION 3.5) project(hello) include (CheckFunctionExists) check_function_exists (printf HAVE_PRINTF) include_directories("${PROJECT_BINARY_DIR}") set(VERSION_MAJOR 1) set(VERSION_MINOR 0) option (USE_MYHELLO "Use myhello" ON) configure_file( "${PROJECT_SOURCE_DIR}/hello.h.in" "${PROJECT_BINARY_DIR}/hello.h" ) add_subdirectory(myhello) set (EXTRA_LIBS ${EXTRA_LIBS} myhello) add_executable(hello hello.cpp) target_link_libraries (hello ${EXTRA_LIBS})
並且在hello.h.in中添加由cmake根據選項來定義USE_MYHELLO宏。
#define VERSION_MAJOR @VERSION_MAJOR@ #define VERSION_MINOR @VERSION_MINOR@ #cmakedefine HAVE_PRINTF #cmakedefine USE_MYHELLO
這樣在運行cmake的時候,會提示我們一些選項來進行選擇:
通過USE_MYHELLO是否被選擇,cmake來確定是否要在hello.h中定義USE_MYHELLO宏,最終我們可以在hello.cpp中判斷USE_MYHELLO宏是否定義來是否使用myhello模塊中的PrintHelloWorld函數。
hello.cpp
#include "myhello/myhello.h" #include "hello.h" #include <stdio.h> int main (int argc, char *argv[]) { #ifdef HAVE_PRINTF printf("version:%d.%d\n", VERSION_MAJOR, VERSION_MINOR); #endif #ifdef USE_MYHELLO PrintHelloWorld(); #else printf("xx hello world!"); #endif return 0; }
最后通過選中或者不選中USE_MYHELLO選擇,得到的結果會不同。
選中結果
沒選中結果:
6 總結
本文主要介紹了下cmake的比較常用的一些命令:project、include、include_directories、set、option、configure_file、add_subdirectory、add_executable、target_link_libraries、add_library,算是一個入門吧。需要用好cmake,熟悉cmake的命令和多寫cmake腳本是必須的,具體每個命令的介紹看以參考官方文檔:https://cmake.org/cmake/help/v3.5/manual/cmake-commands.7.html,腳步的編寫語法可以參考官網文檔:https://cmake.org/cmake/help/v3.5/manual/cmake-language.7.html。以后大點的工程創建完全可以交給cmake來完成,同時也是熟悉cmake的過程。
參考:https://cmake.org/cmake/help/v3.5/index.html