1. 程式人生 > >閱讀 CMakeLists

閱讀 CMakeLists

ring tor 靜態庫 add 包含 comm 源代碼 file 模式

新手,入門閱讀 CMakeLists,希望讀者能給點建議

發現兩篇文章,我感覺很好~

《閱讀 CMakeLists》(下面只copy此篇)文章來源:http://blog.sina.com.cn/s/blog_8380edd00100wyei.html

《CMake 入門實戰》 文章地址:http://www.hahack.com/codes/cmake/

樓主最近幾天被Orz和PageGeometry弄得有點頭大,需要通過源碼 + CMakeLists 來建立工程和sln,但是到底CMakeLists.txt 裏寫的是些什麽東西呢。

【語法】

註釋 # :
#我是註釋

命令語法 COMMAND:
COMMAND(參數1 參數2 ...)

字符串列

A;B;C //分號分割或空格分隔的值

變量
set(Foo a b c) // 設置變量 Foo
command(${Foo}) //等價於 command(a b c)
command("${Foo}") // 等價於 command("a b c")
command("/${Foo}") // 轉義,和 a b c無關聯


流控制結構
IF()...ELSE() /ELSEIF()...ENDIF()
WHILE()...ENDWHILE()
FOREACH()...ENDFOREACH()

【常用命令】

(按A~Z排列)

ADD_EXECUTABLE
add_exectuable : 工程生成一個可執行文件。
add_executable(hello ${SRC_LIST}) //生成一個名為hello.exe的可執行文件

ADD_LIBRARY
add_library : 生成一個庫文件。
add_library(libhello ${LIB_SRC}) //生成libhello.lib文件
add_library(libhello SHARED ${LIB_SRC}) //生成動態庫文件

ADD_CUSTOM_TARGET
自定義目標,生成一個自定義文件類型

add_subdirectory :增加子文件夾,2個參數的話就是 源→目標 文件夾生成對應
add_subdirectory(src) :建立src子文件夾
add_subdirectory(src bin) :在cmake目標文件夾中與源文件夾對應 src→bin文件夾

ADD_DEPENDENCIES( target1 t2 t3 )
目標target1依賴於t2 t3

ADD_DEFINITIONS( "-Wall -ansi")
本意是供設置 -D... /D... 等編譯預處理需要的宏定義參數,對比 REMOVE_DEFINITIONS()

AUX_SOURCE_DIRECTORY ( “sourcedir” variable)
收集目錄中的文件名並賦值給變量

EXEC_PROGRAM ( bin [work_dir] ARGS <..> [OUTPUT_VARIABLE var] [RETURN_VALUE var] )
執行外部程序

FILE ( WRITE|READ|APPEND|GLOB| GLOB_RECURSE|REMOVE|MAKE_DIRECTORY ...)
文件操作

FIND_FILE
FIND_PATH
FIND_LIBRARY
FIND_PACKAGE
上述4個註意 CMAKE_LIBRARY_PATH

FIND_PROGRAM

INCLUDE_DIRECTORIES ( "dir1" "dir2" ... )
include_directories : 包含指定目錄下的指定文件夾
include_directories(${PROJECT_SOURCE_DIR}/libhello) //包含當前目錄下的libhello文件夾

INSTALL ( FILES “f1” “f2”DESTINATION . )
DESTINATION (目標文件夾)相對於 ${CMAKE_INSTALL_PREFIX}

LINK_DIRECTORIES ("dir1" "dir2")
庫文件路徑。註意:由於歷史原因,相對路徑會原樣傳遞給鏈接器。盡量使用FIND_LIBRARY而避免使用這個。

LINK_LIBRARIES ( lib1 lib2 ...)
設置所有目標需要鏈接的庫

LIST ( APPEND|INSERT|LENGTH|GET| REMOVE_ITEM|REMOVE_AT|SORT ...)
列表操作

MESSAGE (...) 輸出信息,方便檢查調試

message(${PROJECT_SOURCE_DIR})

project

建立一個工程
project 不是強制性的,但最好始終都加上。這一行會引入兩個變量
?HELLO_BINARY_DIR 和 HELLO_SOURCE_DIR
同時,cmake自動定義了兩個等價的變量
?PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR
如果是out-of-source方式構建(源代碼和生成的中間產物分離),所以要時刻區分這兩個變量對應的目錄

SET
set (SRC_LIST hello.cpp) //源文件列表 hello.cpp
set (APP_SRC main.c) //語義基本同上,具體不太了解
set (EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin) //指定生成hello.exe到目標文件夾

SET_TARGET_PROPERTIES ( ... ): 設置目標的屬性 OUTPUT_NAME, VERSION, ....
set_target_properties(libhello PROPERTIES OUTPUT_NAME "hello") //使libhello.lib輸出文件名為hello.exe

SEPARATE_ARGUMENTS ( VAR )
轉換空格分隔的字符串到列表

STRING ( TOUPPER|TOLOWER|LENGTH| SUBSTRING|REPLACE|REGEX ...)
字符串操作

TARGET_LINK_LIBRARIES ( target-name lib1 lib2 ...)
target_link_libraries : 將指定庫文件鏈接到某個執行文件
target_link_libraries(hello libhello) //將libhello.lib文件鏈接到hello.exe

【常見變量】


----工程路徑------


?CMAKE_SOURCE_DIR
?PROJECT_SOURCE_DIR
?<projectname>_SOURCE_DIR
這三個變量指代的內容是一致的,是工程頂層目錄

?CMAKE_BINARY_DIR
?PROJECT_BINARY_DIR
?<projectname>_BINARY_DIR
這三個變量指代的內容是一致的,如果是in source編譯,指得就是工程頂層目錄,如果 是out-of-source編譯,指的是工程編譯發生的目錄

?CMAKE_CURRENT_SOURCE_DIR
指的是當前處理的CMakeLists.txt所在的路徑。

?CMAKE_CURRRENT_BINARY_DIR
如果是in-source編譯,它跟CMAKE_CURRENT_SOURCE_DIR一致,如果是out-ofsource 編譯,他指的是target編

譯目錄。

?CMAKE_CURRENT_LIST_FILE
輸出調用這個變量的CMakeLists.txt的完整路徑

----CMAKE_BUILD_TYPE-----

控制 Debug 和 Release 模式的構建

?CMakeList.txt文件
SET(CMAKE_BUILD_TYPE Debug)?命令行參數
cmake DCMAKE_BUILD_TYPE=Relea

-----編譯器參數-----


?CMAKE_C_FLAGS
?CMAKE_CXX_FLAGS
也可以通過指令ADD_DEFINITIONS()添加

CMAKE_INCLUDE_PATH
配合 FIND_FILE() 以及 FIND_PATH() 使用。如果頭文件沒有存放在常規路徑/usr/include, /usr/local/include等),
則可以通過這些變量就行彌補。如果不使用 FIND_FILE 和 FIND_PATH的話,CMAKE_INCLUDE_PATH,沒有任何作

用。

?CMAKE_LIBRARY_PATH

配合 FIND_LIBRARY() 使用。否則沒有任何作用

?CMAKE_MODULE_PATH

cmake 為上百個軟件包提供了查找器(finder):FindXXXX.cmake

當使用非cmake自帶的finder時,需要指定finder的路徑,這就是CMAKE_MODULE_PATH,配合 FIND_PACKAGE

()使用

CMAKE_INSTALL_PREFIX
控制make install是文件會安裝到什麽地方。默認定義是/usr/local 或 %PROGRAMFILES%

BUILD_SHARED_LIBS
如果不進行設置,使用ADD_LIBRARY且沒有指定庫類型,默認編譯生成的庫是靜態庫。

UNIX 與 WIN32
?UNIX,在所有的類UNIX平臺為TRUE,包括OS X和cygwin
?WIN32,在所有的win32平臺為TRUE,包括cygwin

更多CMake信息參考

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

學習如何寫CMakeLists參考如下網址,寫的不錯

    • http://blog.csdn.net/dbzhang800/article/details/6314073

閱讀 CMakeLists