四、更好一點的Hello World · cmake實踐

#四、更好一點的Hello World [TOC] 沒有最好，只有更好從本小節開始，后面所有的構建我們都將采用out-of-source外部構建，約定的構建目錄是工程目錄下的build 自錄。本小節的任務是讓前面的Hello World更像一個工程，我們需要作的是： 1，為工程添加一個子目錄src，用來放置工程源代碼; 2，添加一個子目錄doc，用來放置這個工程的文檔hello.txt 3，在工程目錄添加文本文件COPYRIGHT, README； 4，在工程目錄添加一個runhello.sh 腳本，用來調用hello 二進制4，將構建后的目標文件放入構建目錄的bin子目錄； 5，最終安裝這些文件：將hello 二進制與runhello.sh 安裝至/usr/bin，將doc目錄的內容以及COPYRIGHT/README安裝到/usr/share/doc/cmake/t2 ###1，準備工作：在/backup/cmake/ 目錄下建立t2目錄。將t1工程的main.c 和CMakeLists.txt 拷貝到t2目錄中。 ###2，添加子目錄src：mkdir src mv main.c src 現在的工程看起來是這個樣子：一個子目錄src ，一個CMakeLists.txt 。上一節我們提到，需要為任何子目錄建立一個CMakeLists.txt，進入子目錄src ，編寫CMakeLists.txt 如下：ADD_EXECUTABLE(hello main.c) 將t2工程的CMakeLists.txt 修改為：PROJECT(HELLO) ADD_SUBDIRECTORY(src bin) 然后建立build 目錄，進入build 目錄進行外部編譯。cmake .. make 構建完成后，你會發現生成的目標文件hello 位于build/bin 目錄中。語法解釋：ADD_SUBDIRECTORY 指令ADD_SUBDIRECTORY(source_dir [binary_dir] [EXCLUDE_FROM_ALL]) 這個指令用于向當前工程添加存放源文件的子目錄，并可以指定中間二進制和目標二進制存放的位置。EXCLUDE_FROM_ALL 參數的含義是將這個目錄從編譯過程中排除，比如，工程的example ，可能就需要工程構建完成后，再進入example 目錄單獨進行構建(當然，你也可以通過定義依賴來解決此類問題)。上面的例子定義了將src子目錄加入工程，并指定編譯輸出(包含編譯中間結果)路徑為bin 目錄。如果不進行bin 目錄的指定，那么編譯結果(包括中間結果)都將存放在build/src 目錄(這個目錄跟原有的src 目錄對應)，指定bin目錄后，相當于在編譯時將src 重命名為bin ，所有的中間結果和目標二進制都將存放在bin 目錄。這里需要提一下的是SUBDIRS 指令，使用方法是： SUBDIRS(dir1 dir2...) ，但是這個指令已經不推薦使用。它可以一次添加多個子目錄，并且，即使外部編譯，子目錄體系仍然會被保存。如果我們在上面的例子中將ADD_SUBDIRECTORY (src bin) 修改為SUBDIRS(src) 。那么在build 目錄中將出現一個src目錄，生成的目標代碼hello 將存放在src 目錄中。 ###3，換個地方保存目標二進制不論是SUBDIRS 還是ADD_SUBDIRECTORY 指令(不論是否指定編譯輸出目錄)，我們都可以通過SET 指令重新定義EXECUTABLE_OUTPUT_PATH 和LIBRARY_OUTPUT_PATH 變量來指定最終的目標二進制的位置(指最終生成的hello 或者最終的共享庫，不包含編譯生成的中間文件) SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin) SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib) 在第一節我們提到了<projectname>_BINARY_DIR 和PROJECT_BINARY_DIR 變量，他們指的編譯發生的當前目錄，如果是內部編譯，就相當于PROJECT_SOURCE_DIR 也就是工程代碼所在目錄，如果是外部編譯，指的是外部編譯所在目錄，也就是本例中的build 目錄。所以，上面兩個指令分別定義了：可執行二進制的輸出路徑為build/bin 和庫的輸出路徑為build/lib. 本節我們沒有提到共享庫和靜態庫的構建，所以，你可以不考慮第二條指令。問題是，我應該把這兩條指令寫在工程的CMakeLists.txt 還是src目錄下的CMakeLists.txt，把握一個簡單的原則，在哪里ADD_EXECUTABLE 或ADD_LIBRARY，如果需要改變目標存放路徑，就在哪里加入上述的定義。在這個例子里，當然就是指src 下的CMakeLists.txt 了。 ###4，如何安裝安裝的需要有兩種，一種是從代碼編譯后直接make install 安裝，一種是打包時的指定目錄安裝。所以，即使最簡單的手工編寫的Makefile，看起來也是這個樣子的： ```` DESTDIR=install: mkdir -p $(DESTDIR)/usr/bin install -m 755 hello $(DESTDIR)/usr/bin ``` 你可以通過: `make install` 將hello 直接安裝到/usr/bin 目錄，也可以通過`make install DESTDIR=/tmp/test `將他安裝在/tmp/test/usr/bin 目錄，打包時這個方式經常被使用。稍微復雜一點的是還需要定義PREFIX ，一般autotools 工程，會運行這樣的指令: `./configure –prefix=/usr 或者./configure --prefix=/usr/local` 來指定PREFIX比如上面的Makefile 就可以改寫成: ``` DESTDIR=PREFIX=/usrinstall: mkdir -p $(DESTDIR)/$(PREFIX)/bin install -m 755 hello $(DESTDIR)/$(PREFIX)/bin ``` 那么我們的HelloWorld 應該怎么進行安裝呢？這里需要引入一個新的cmake 指令INSTALL 和一個非常有用的變量CMAKE_INSTALL_PREFIX 。 CMAKE_INSTALL_PREFIX 變量類似于configure 腳本的–prefix ，常見的使用方法看起來是這個樣子： cmake -DCMAKE_INSTALL_PREFIX=/usr . INSTALL 指令用于定義安裝規則，安裝的內容可以包括目標二進制、動態庫、靜態庫以及文件、目錄、腳本等。 INSTALL 指令包含了各種安裝類型，我們需要一個個分開解釋：目標文件的安裝： ``` INSTALL(TARGETS targets...[[ARCHIVE|LIBRARY|RUNTIME][DESTINATION <dir>][PERMISSIONS permissions...][CONFIGURATIONS [Debug|Release|...]][COMPONENT <component>][OPTIONAL]] ``` [...]) 參數中的TARGETS后面跟的就是我們通過ADD_EXECUTABLE 或者ADD_LIBRARY定義的目標文件，可能是可執行二進制、動態庫、靜態庫。目標類型也就相對應的有三種，ARCHIVE特指靜態庫，LIBRARY 特指動態庫，RUNTIME 特指可執行目標二進制。 DESTINATION 定義了安裝的路徑，如果路徑以/開頭，那么指的是絕對路徑，這時候CMAKE_INSTALL_PREFIX 其實就無效了。如果你希望使用CMAKE_INSTALL_PREFIX 來定義安裝路徑，就要寫成相對路徑，即不要以/開頭，那么安裝后的路徑就是`${CMAKE_INSTALL_PREFIX}/<DESTINATION 定義的路徑>` 舉個簡單的例子： ``` INSTALL(TARGETS myrun mylib mystaticlibRUNTIME DESTINATION binLIBRARY DESTINATION libARCHIVE DESTINATION libstatic) ``` 上面的例子會將：可執行二進制myrun安裝到${CMAKE_INSTALL_PREFIX}/bin目錄動態庫libmylib安裝到${CMAKE_INSTALL_PREFIX}/lib 目錄靜態庫libmystaticlib安裝到${CMAKE_INSTALL_PREFIX}/libstatic 目錄特別注意的是你不需要關心TARGETS具體生成的路徑，只需要寫上TARGETS 名稱就可以了。普通文件的安裝： ``` INSTALL(FILES files... DESTINATION <dir>[PERMISSIONS permissions...][CONFIGURATIONS [Debug|Release|...]][COMPONENT <component>][RENAME <name>] [OPTIONAL]) ``` 可用于安裝一般文件，并可以指定訪問權限，文件名是此指令所在路徑下的相對路徑。如果默認不定義權限PERMISSIONS，安裝后的權限為： OWNER_WRITE, OWNER_READ, GROUP_READ, 和WORLD_READ，即644 權限。非目標文件的可執行程序安裝(比如腳本之類)： INSTALL(PROGRAMS files... DESTINATION <dir>[PERMISSIONS permissions...][CONFIGURATIONS [Debug|Release|...]][COMPONENT <component>][RENAME <name>] [OPTIONAL]) 跟上面的FILES 指令使用方法一樣，唯一的不同是安裝后權限為: OWNER_EXECUTE, GROUP_EXECUTE, 和WORLD_EXECUTE，即755 權限目錄的安裝： ``` INSTALL(DIRECTORY dirs... DESTINATION <dir>[FILE_PERMISSIONS permissions...][DIRECTORY_PERMISSIONS permissions...][USE_SOURCE_PERMISSIONS][CONFIGURATIONS [Debug|Release|...]][COMPONENT <component>][[PATTERN <pattern> | REGEX <regex>] [EXCLUDE] [PERMISSIONS permissions...]] [...]) ``` 這里主要介紹其中的DIRECTORY 、PATTERN 以及PERMISSIONS 參數。DIRECTORY 后面連接的是所在Source 目錄的相對路徑，但務必注意：abc 和abc/ 有很大的區別。如果目錄名不以/結尾，那么這個目錄將被安裝為目標路徑下的abc，如果目錄名以/結尾，代表將這個目錄中的內容安裝到目標路徑，但不包括這個目錄本身。 PATTERN 用于使用正則表達式進行過濾，PERMISSIONS 用于指定PATTERN 過濾后的文件權限。我們來看一個例子: ``` INSTALL(DIRECTORY icons scripts/ DESTINATION share/myproj PATTERN "CVS" EXCLUDEPATTERN "scripts/*"PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ) ``` 這條指令的執行結果是：將icons 目錄安裝到<prefix>/share/myproj ，將scripts/ 中的內容安裝到<prefix>/share/myproj 不包含目錄名為CVS 的目錄，對于scripts/* 文件指定權限為OWNER_EXECUTE OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ. 安裝時CMAKE 腳本的執行： ``` INSTALL([[SCRIPT <file>] [CODE <code>]] [...]) ``` SCRIPT 參數用于在安裝時調用cmake 腳本文件（也就是<abc>.cmake 文件）CODE 參數用于執行CMAKE 指令，必須以雙引號括起來。比如： ``` INSTALL(CODE "MESSAGE(\"Sample install message.\")") ``` 安裝還有幾個被標記為過時的指令，比如INSTALL_FILES 等，這些指令已經不再推薦使用，所以，這里就不再贅述了。下面，我們就來改寫我們的工程文件，讓他來支持各種文件的安裝，并且，我們要使用CMAKE_INSTALL_PREFIX 指令。 ###5，修改Helloworld支持安裝在本節開頭我們定義了本節的任務如下： 1，為工程添加一個子目錄src，用來存儲源代碼; 2，添加一個子目錄doc，用來存儲這個工程的文檔hello.txt 3，在工程目錄添加文本文件COPYRIGHT, README； 4，在工程目錄添加一個runhello.sh 腳本，用來調用hello二進制4，將構建后的目標文件放入構建目錄的bin子目錄； 5，最終安裝這些文件：將hello 二進制與runhello.sh 安裝至/<prefix>/bin ，將doc 目錄中的hello.txt 以及COPYRIGHT/README安裝到/<prefix>/share/doc/cmake/t2 首先我們先補上為添加的文件。添加doc 目錄及文件: ``` cd /backup/cmake/t2mkdir doc ``` `vi doc/hello.txt`隨便填寫一些內容并保存在工程目錄添加runhello.sh 腳本，內容為：hello 添加工程目錄中的COPYRIGHT 和READMEtouch COPYRIGHTtouch README 下面改寫各目錄的CMakeLists.txt 文件。 1，安裝COPYRIGHT/README 直接修改主工程文件CMakelists.txt，加入以下指令：INSTALL(FILES COPYRIGHT README DESTINATION share/doc/cmake/t2) 2，安裝runhello.sh 直接修改主工程文件CMakeLists.txt，加入如下指令：INSTALL(PROGRAMS runhello.sh DESTINATION bin) 3，安裝doc中的hello.txt 這里有兩種方式：一是通過在doc 目錄建立 CMakeLists.txt 并將doc目錄通過ADD_SUBDIRECTORY 加入工程來完成。另一種方法是直接在工程目錄通過INSTALL(DIRECTORY 來完成)，前者比較簡單，各位可以根據興趣自己完成，我們來嘗試后者，順便演示以下DIRECTORY 的安裝。因為hello.txt 要安裝到/<prefix>/share/doc/cmake/t2 ，所以我們不能直接安裝整個doc目錄，這里采用的方式是安裝doc 目錄中的內容，也就是使用”doc/”在工程文件中添加 ``` INSTALL(DIRECTORY doc/ DESTINATION share/doc/cmake/t2) ``` 6，嘗試我們修改的結果：現在進入build 目錄進行外部編譯，注意使用CMAKE_INSTALL_PREFIX 參數，這里我們將它安裝到了/tmp/t2 目錄：cmake -DCMAKE_INSTALL_PREFIX=/tmp/t2/usr .. 然后運行 ``` make make install ``` 讓我們進入/tmp/t2 目錄看一下安裝結果： >./usr ./usr/share ./usr/share/doc ./usr/share/doc/cmake ./usr/share/doc/cmake/t2 ./usr/share/doc/cmake/t2/hello.txt ./usr/share/doc/cmake/t2/README ./usr/share/doc/cmake/t2/COPYRIGHT ./usr/bin./usr/bin/hello ./usr/bin/runhello.sh 如果你要直接安裝到系統，可以使用如下指令： cmake -DCMAKE_INSTALL_PREFIX=/usr .. 7，一個疑問如果我沒有定義CMAKE_INSTALL_PREFIX 會安裝到什么地方？你可以嘗試以下， ``` cmake .. make make install ``` 你會發現CMAKE_INSTALL_PREFIX 的默認定義是/usr/local 8，小結：本小節主要描述了如何在工程中使用多目錄、各種安裝指令以及CMAKE_INSTALL_PREFIX變量(你真夠牛的，這么點東西居然羅唆了這么多文字) 在下一小節，我們將探討如何在cmake中構建動態庫和靜態庫，以及如何使用外部頭文件和外部共享庫，畢竟，這是程序編寫中最長使用的（對了，你知道用怎樣的gcc 參數可以直接構建靜態庫和動態庫嗎？）