1. 程式人生 > >cmake使用總結(轉)---工程主目錄CMakeList檔案編寫

cmake使用總結(轉)---工程主目錄CMakeList檔案編寫


轉載http://blog.163.com/ji_wei8888/blog/static/486804462011991064371/

在linux 下進行開發很多人選擇編寫makefile 檔案進行專案環境搭建,而makefile 檔案依賴關係複雜,工作量很大,搞的人頭很大。採用自動化的專案構建工具cmake 可以將程式設計師從複雜的makefile 檔案中解脫出來。cmake 根據內建的規則和語法來自動生成相關的makefile 檔案進行編譯,同時還支援靜態庫和動態庫的構建,我把工作中用到的東東總結在此,方便忘記時隨時檢視,具體cmake的介紹和詳細語法還是參考官方文件(http://www.cmake.org/),有一篇中文的cmake 實踐
寫的不錯,可以google一下。

     使用cmake 很簡單,只需要執行cmake, make 兩個命令即可,用我工作中的一個工程舉例說明。

      假設當前的專案程式碼在src 目錄。 src 下有子目錄:server, utility, lib, bin, build

      server -----  存放專案的主功能類檔案

      utility  -----  存放專案要用到相關庫檔案,便已成為庫檔案存放到子目錄lib 中

      lib       -----  存放utility 生成的庫

      bin      -----  存放association 生成的二進位制檔案

      build   -----  編譯目錄,存放編譯生成的中間檔案

      cmake 要求工程主目錄和所有存放原始碼子目錄下都要編寫CMakeLists.txt 檔案,注意大小寫(cm 大寫,list中l 大寫且落下s).

      src/CMakeLists.txt 檔案如下:

      -------------------------------------------------------------------------------------------------------------

      #cmake file for project association                     #表示註釋


      #author:>---double__song
      #created:>--2011/03/01

      CMAKE_MINIMUM_REQUIRED(VERSION 2.8)      #cmake 最低版本要求,低於2.6 構建過程會被終止。

      PROJECT(server_project)                                             #定義工程名稱

      MESSAGE(STATUS "Project: SERVER")               #列印相關訊息訊息
      MESSAGE(STATUS "Project Directory: ${PROJECT_SOURCE_DIR}")

      SET(CMAKE_BUILE_TYPE DEBUG)                      #指定編譯型別


      SET(CMAKE_C_FLAGS_DEBUG "-g -Wall")          #指定編譯器
     
      ADD_SUBDIRECTORY(utility)                              #新增子目錄
      ADD_SUBDIRECTORY(server)
    -------------------------------------------------------------------------------------------------------------

相關解釋:

      1. CMakeLists.txt 檔案中不區分大小寫

      2. PROJECT(project_name)    定義工程名稱

          語法:project(projectname [cxx] [c] [java])

          可以指定工程採用的語言,選項分別表示:C++, C, java, 如不指定預設支援所有語言

      3. MESSAGE(STATUS, "Content")  列印相關訊息

          輸出訊息,供除錯CMakeLists.txt 檔案使用。

      4. SET(CMAKE_BUILE_TYPE DEBUG)  設定編譯型別debug 或者release。 debug 版會生成相關除錯資訊,可以使用GDB 進行 

          除錯;release不會生成除錯資訊。當無法進行除錯時檢視此處是否設定為debug.

      5. SET(CMAKE_C_FLAGS_DEBUG "-g -Wall") 設定編譯器的型別

          CMAKE_C_FLAGS_DEBUG            ----  C 編譯器

          CMAKE_CXX_FLAGS_DEBUG        ----  C++ 編譯器

       6. ADD_SUBDIRECTORY(utility) 新增要編譯的子目錄

           為工程主目錄下的存放原始碼的子目錄使用該命令,各子目錄出現的順序隨意。

       如上便是工程server_project 主目錄src 下的CMakeLists.txt 檔案,下一篇我們解釋子目錄utiltiy中的CMakeLists.txt 檔案。

子目錄utility 下的CMakeLists.txt 檔案如下:

--------------------------------------------------------------------------------------------------------------------
     #Cmake file for library utility.a
     #Author:       double__song
     #Created:     2011/3/3


     SET(SOURCE_FILES                                  #設定變數,表示所有的原始檔
     ConfigParser.cpp
     StrUtility.cpp
     )


     INCLUDE_DIRECTORIES(                          #相關標頭檔案的目錄
     /usr/local/include
     ${PROJET_SOURCE_DIR}/utility
     )


    LINK_DIRECTORIES(                                  #相關庫檔案的目錄
    /usr/local/lib

    )


    ADD_LIBRARY(association ${SOURCE_FILES})         #生成靜態連結庫libassociation.a

    TARGET_LINK_LIBRARY(association core)                #依賴的庫檔案

   
    SET_TARGET_PROPERTIES(utility  PROPERTIES    #表示生成的執行檔案所在路徑
    RUNTIME_OUTPUT_DIRECTORY> "${PROJECT_SOURCE_DIR}/lib")

--------------------------------------------------------------------------------------------------------------------
    相關解釋:

    1. SET(SOURCE_FILES .....)  

    表示要編譯的原始檔,所有的原始檔都要羅列到此處。set 設定變數,變數名SOURCE_FILES自定義。

    2. INCLUDE_DIRECTORY(...)  

    include標頭檔案時搜尋的所有目錄

    變數PROJECT_SOURCE_DIR 表示工程所在的路徑,系統預設的變數

    3. LINK_DIRECTORIES(...)

     庫檔案存放的目錄,在程式連線庫檔案的時候要再這些目錄下尋找對應的庫檔案

    4. ADD_LIBRARY(...) 

     表示生成靜態連結庫libassociaiton.a,由${PROJECT_SOURCE_DIR}代表的檔案生成。

     語法:ADD_LIBRARY(libname [SHARED|STATIC]

     SHARED 表示生成動態庫, STATIC表示生成靜態庫。

    5. TARGET_LINK_LIBRARY(association core) 

     表示庫association 依賴core庫檔案

     6. SET_TARGET_PROPERTIES

     設定編譯的庫檔案存放的目錄,還可用於其他屬性的設定。如不指定,

     生成的執行檔案在當前編譯目錄下的各子目錄下的build目錄下,好拗口!簡單一點:

     如指定在: ./src/lib 下

     不指定在: ./src/build/utility/build 目錄下

     生成的中間檔案在./src/build/utilty/build 目錄下,不受該命令額影響

     子目錄server 下的CMakeLists.txt 檔案:

      --------------------------------------------------------------------------------------------
     SET(SOURCE_FILES
     Gassociation.cpp
     ConfigurationHandler.cpp
     )

     INCLUDE_DIRECTORIES(

      /usr/local/include
      ${PROJECT_SOURCE_DIR}/utility
      ${PROJECT_SOURCE_DIR}/association
     )

     LINK_LIBRARIES(
     /usr/local/lib
     ${PROJECT_SOURCE_DIR}/lib
     )

     ADD_EXECUTABLE(server  ${SOURCE_FILES})

     TARGET_LINK_LIBRARIES(server
     utility

     )

     SET_TARGET_PROPERTIES(server  PROPERTIES    #表示生成的執行檔案所在路徑
     RUNTIME_OUTPUT_DIRECTORY  "${PROJECT_SOURCE_DIR}/bin")

     -------------------------------------------------------------------------------------------------------

     相關解釋:

     1. ADD_EXECUTABLE()     #指定要生成的執行檔案的名稱server

      其他用法同utilty/CMakeLists.txt

     2. SET_TARGET_PROPERTIES

      設定生成的執行檔案存放的路徑,

      注意:

      執行檔案server 依賴的子目錄utility 子目錄生成的靜態庫libutility.a,在指定的時候要寫成:
      TARGET_LINK_LIBRARIES(server   utility)

      而不能寫成:

      TARGET_LINK_LIBRARIES(server   libutility.a)

      否則編譯總會提示找不到libutility庫檔案。

      但使用第三方的庫卻要指定成具體的庫名,如:libACE-6.0.0.so

      這一點很詭異,暫時還沒找到原因。

      完成對應的CMakeLists.txt 檔案編寫後,便可以進行編譯了。

      編譯:

            進入 ./src/build

            執行cmake ..

            make

       cmake 的使用很簡單,更高階的應用好比版本資訊,打包,安裝等相關基本的應用後面會一一介紹,

      複雜的語法使用要參考官方文件。