CmakeList的编写和参数详解

  在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 文件如下：

[cpp]  view plain  copy

1. #cmake file for project association                     #表示注释   
2.       #author:>---double__song  
3.       #created:>--2011/03/01  
4.   
5.       CMAKE_MINIMUM_REQUIRED(VERSION 2.8)    #cmake 最低版本要求，低于2.6 构建过程会被终止。   
6.   
7.       PROJECT(server_project)                          #定义工程名称  
8.   
9.       MESSAGE(STATUS "Project: SERVER")               #打印相关消息消息   
10.       MESSAGE(STATUS "Project Directory: ${PROJECT_SOURCE_DIR}")  
11.       SET(CMAKE_BUILE_TYPE DEBUG)                      #指定编译类型  
12.       SET(CMAKE_C_FLAGS_DEBUG "-g -Wall")          #指定编译器   
13.         
14.       ADD_SUBDIRECTORY(utility)                              #添加子目录   
15.       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 文件如下：

[cpp]  view plain  copy

1.  #Cmake file for library utility.a  
2.  #Author:       double__song  
3.  #Created:     2011/3/3  
4.   
5.  SET(SOURCE_FILES                                  #设置变量，表示所有的源文件  
6.  ConfigParser.cpp  
7.  StrUtility.cpp  
8.  )  
9.  INCLUDE_DIRECTORIES(                          #相关头文件的目录  
10.  /usr/local/include  
11.  ${PROJET_SOURCE_DIR}/utility  
12.  )  
13.   
14. LINK_DIRECTORIES(                                  #相关库文件的目录  
15. /usr/local/lib  
16. )  
17.   
18. ADD_LIBRARY(association ${SOURCE_FILES})         #生成静态链接库libassociation.a  
19. TARGET_LINK_LIBRARY(association core）                #依赖的库文件  
20.   
21. SET_TARGET_PROPERTIES(utility  PROPERTIES    #表示生成的执行文件所在路径  
22. 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 文件：

[cpp]  view plain  copy

1. --------------------------------------------------------------------------------------------  
2.     SET(SOURCE_FILES  
3.     Gassociation.cpp  
4.     ConfigurationHandler.cpp  
5.     )  
6.     INCLUDE_DIRECTORIES（  
7.     /usr/local/include  
8.      ${PROJECT_SOURCE_DIR}/utility  
9.      ${PROJECT_SOURCE_DIR}/association  
10.     )  
11.     LINK_LIBRARIES(  
12.     /usr/local/lib  
13.     ${PROJECT_SOURCE_DIR}/lib  
14.     )  
15.     ADD_EXECUTABLE(server  ${SOURCE_FILES})  
16.     TARGET_LINK_LIBRARIES(server  
17.     utility  
18.     ）  
19.     SET_TARGET_PROPERTIES(server  PROPERTIES    #表示生成的执行文件所在路径  
20.     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 的使用很简单，更高级的应用好比版本信息，打包，安装等相关基本的应用后面会一一介绍， 复杂的语法使用要参考官方文档。