cmake使用详解

超、凢脫俗 2022-04-24 04:36 492阅读 1赞

### 文章目录 ###

*   *  cmake使用笔记
     *   *  基本使用方法
         *  相较于makefile的优点
         *  常用语法
         *   *  cmake\_minimum\_required
             *  project
             *  PROJECT\_SOURCE\_DIR
             *  set
             *  include\_directories
             *  link\_directories
             *  options
         *  常用变量
         *   *  CMAKE\_CURRENT\_LIST\_DIR
             *  CMAKE\_ARCHIVE\_OUTPUT\_DIRECTORY
             *  CMAKE\_LIBRARY\_OUTPUT\_DIRECTORY
             *  CMAKE\_RUNTIME\_OUTPUT\_DIRECTORY
             *  LIBRARY\_OUTPUT\_PATH
             *  EXECUTABLE\_OUTPUT\_PATH
         *  编译链接标志
         *   *  CMAKE\_C\_FLAGS
             *  CMAKE\_C\_FLAGS\_\[DEBUG|RELEASE|MINSIZEREL|RELWITHDEBINFO\]
             *  CMAKE\_CXX\_FLAGS
             *  CMAKE\_CXX\_FLAGS\_\[DEBUG|RELEASE|MINSIZEREL|RELWITHDEBINFO\]
         *  链接部分
         *   *  add\_library
             *  add\_executable
             *  target\_link\_libraries
         *  其他
         *   *  add\_subdirectory
         *  Debug和Release版本
         *  调试手段
         *   *  message
             *  CMAKE\_VERBOSE\_MAKEFILE
         *  cmake示例
         *  小结

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

## cmake使用笔记 ##

之前一直使用MakeFile，看过一些开源项目后，了解到了cmake，它是一个跨平台的编译工具，不但能生成类unix系统下的makefile还能生成windows下project文件，这使得熟悉某个集成开发环境（IDE）的开发者可以用标准的方式建构他的软件，这种可以使用各平台的原生建构系统的能力是 CMake 和 SCons 等其他类似系统的区别之处。

### 基本使用方法 ###

cmake所的所有语句写在CMakeLists.txt中，  
因为cmake生成makefile或project然后在编译时会生成很多中间文件，打乱项目文件结构，所以我们一般新建一个build目录，在里面编译。  
基本操作只需要二步即可 ：  
1、cmake CMakeLists.txt文件目录  
2、make  
3、如果配置了安装路径，还可以进行make install 等.  
![Alt text][]

### 相较于makefile的优点 ###

目前个人体感上的优点。  
1、跨平台。  
2、语法相较于makefile简洁不少，makefile有的，cmake基本都有。  
3、编译显示自带进度，颜色，看着很舒服，(当然makefile肯定也能实现，省了不少事罢了)。  
![Alt text][Alt text 1]

下面讲讲常用语句:

### 常用语法 ###

#### cmake\_minimum\_required ####

CMake要求的最低版本

#### project ####

项目名称

cmake_minimum_required (VERSION 2.8.7)
    project (test_project)

#### PROJECT\_SOURCE\_DIR ####

项目根目录，也就是CmakeLists.txt目录的绝对路径。

#### set ####

设置变量  
例如

###
    # variables
    ###
    set(SOURCES_DIRECTORY ${
        PROJECT_SOURCE_DIR}/sources)
    set(OPEN_SOURCES_DIRECTORY ${
        PROJECT_SOURCE_DIR}/open_sources)
    set(INCLUDES_DIRECTORY ${
        PROJECT_SOURCE_DIR}/includes)
    
    set(MUDUO_LOGGER_INCLUDES ${
        INCLUDES_DIRECTORY}/muduo_logger)
    set(MUDUO_NETWORK_INCLUDES ${
        INCLUDES_DIRECTORY}/muduo_network)
    set(CPP_REDIS_INCLUDES ${
        OPEN_SOURCES_DIRECTORY}/cpp_redis/includes)

#### include\_directories ####

包含头文件路径，类似于makfilede的-I  
例如

###
    # includes
    ###
    include_directories(${
        INCLUDES_DIRECTORY}
             ${
        MUDUO_LOGGER_INCLUDES} 
             ${
        MUDUO_NETWORK_INCLUDES}
             ${
        SOURCES_DIRECTORY}/sip_server
             ${
        CPP_REDIS_INCLUDES}
             ${
        OPEN_SOURCES_DIRECTORY}/includes
             ${
        OPEN_SOURCES_DIRECTORY}/includes/mysql++)

#### link\_directories ####

链接路径，类似于makfilede的-L

###
    # libraries
    ###
    link_directories("${PROJECT_SOURCE_DIR}/library")
    link_directories("${OPEN_SOURCES_DIRECTORY}/library")

#### options ####

开关宏，类似于c/c++ \#if \#elseif \#endif.  
可以在使用cmake时通过 -D 来打开开关

如 :

cmake -Dx86_platfrom=ON ../
    -- X86 Platform
    -- Configuring done
    -- Generating done

# x86 / arm switch
    option(x86_platfrom    "Set to switch to build use x86" OFF)
    option(arm_platfrom    "Set to switch to build use arm" ON)
    if (x86_platfrom)
        message(STATUS "X86 Platform")
    else ()
    	SET(CMAKE_SYSTEM_NAME Linux)
    	SET(CMAKE_SYSTEM_PROCESSOR arm) 
    	SET(TOOLCHAIN_DIR "/opt/hisi-linux/x86-arm/arm-hisiv400-linux")
    	SET(CMAKE_FIND_ROOT_PATH ${
        TOOLCHAIN_DIR})
    	SET(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
    	SET(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
    	SET(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
    
    	SET(CMAKE_C_COMPILER ${
        TOOLCHAIN_DIR}/bin/arm-hisiv400-linux-gnueabi-gcc)
    	SET(CMAKE_CXX_COMPILER ${
        TOOLCHAIN_DIR}/bin/arm-hisiv400-linux-gnueabi-g++)
    
        message(STATUS "arm Platform")
    endif ()

### 常用变量 ###

#### CMAKE\_CURRENT\_LIST\_DIR ####

表示正在处理的CMakeLists.txt 文件的所在的目录的绝对路径（2.8.3 以及以后版本才支持）

#### CMAKE\_ARCHIVE\_OUTPUT\_DIRECTORY ####

用于设置 ARCHIVE 目标的输出路径

#### CMAKE\_LIBRARY\_OUTPUT\_DIRECTORY ####

用于设置 LIBRARY 目标的输出路径

#### CMAKE\_RUNTIME\_OUTPUT\_DIRECTORY ####

用于设置 RUNTIME 目标的输出路径

#### LIBRARY\_OUTPUT\_PATH ####

用于设置 库文件 的输出路径

#### EXECUTABLE\_OUTPUT\_PATH ####

用于设置 可执行文件的输出路径

例如

###
    # outputs
    ###
    #set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
    #set(CMAKE_PKGCONFIG_OUTPUT_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/pkgconfig)
    #set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
    
    set(LIBRARY_OUTPUT_PATH ${
        PROJECT_SOURCE_DIR}/library)
    set(EXECUTABLE_OUTPUT_PATH ${
        PROJECT_SOURCE_DIR}/bin)

### 编译链接标志 ###

#### CMAKE\_C\_FLAGS ####

#### CMAKE\_C\_FLAGS\_\[DEBUG|RELEASE|MINSIZEREL|RELWITHDEBINFO\] ####

C 编译标志相关变量。

#### CMAKE\_CXX\_FLAGS ####

#### CMAKE\_CXX\_FLAGS\_\[DEBUG|RELEASE|MINSIZEREL|RELWITHDEBINFO\] ####

C++ 编译标志相关变量。

CMAKE\_C\_FLAGS 或CMAKE\_CXX\_FLAGS 可以指定编译标志  
CMAKE\_C\_FLAGS\_\[DEBUG|RELEASE|MINSIZEREL|RELWITHDEBINFO\]或 CMAKE\_CXX\_FLAGS\_\[DEBUG|RELEASE|MINSIZEREL|RELWITHDEBINFO\] 则指定特定构建类型的编译标志，这些编译标志将被加入到 CMAKE\_C\_FLAGS 或 CMAKE\_CXX\_FLAGS 中去，例如，如果构建类型为 DEBUG，那么 CMAKE\_CXX\_FLAGS\_DEBUG 将被加入到 CMAKE\_CXX\_FLAGS中去

###
    # compilation options
    ###
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -g -W -Wall -Wextra -O3")

### 链接部分 ###

#### add\_library ####

添加要生成的库文件  
语法：add\_library(<name> \[STATIC | SHARED | MODULE\] \[EXCLUDE\_FROM\_ALL\] source1source2 … sourceN)

用于指定从一组源文件 source1 source2 … sourceN 编译出一个库文件且命名为 name，默认是静态库.  
例如

###
    #library
    ###
    add_library(async_logging ${
        muduo_logger_sources})
    
    add_library(muduo_server ${
        muduo_network_sources})

#### add\_executable ####

add\_executable 命令  
语法：add\_executable(<name> \[WIN32\] \[MACOSX\_BUNDLE\]\[EXCLUDE\_FROM\_ALL\] source1 source2 … sourceN)  
用于指定从一组源文件 source1 source2 … sourceN 编译出一个可执行文件且命名为 name

###
    # executable
    ###
    add_executable(sip_server ${
        test_excutable })
    add_executable(mysql_use_test ${
        mysql_use_test_sources})

#### target\_link\_libraries ####

语法： target\_link\_libraries(<target> \[item1 \[item2 \[…\]\]\]\[\[debug|optimized|general\] \] …)  
用于指定 target 链接的依赖项 item1 item2 …。  
例如:

###
    # link librarys
    ###
    target_link_libraries(async_logging pthread)
    
    target_link_libraries(muduo_server async_logging)
    target_link_libraries(muduo_server pthread)
    
    target_link_libraries(test_excutable async_logging
                                     muduo_server
                                     pthread
                                     cpp_redis
                                     tacopie)

### 其他 ###

#### add\_subdirectory ####

如果想添加一个子项目或者模块，可以用它进行构建的子目录  
语法：add\_subdirectory(source\_dir \[binary\_dir\] \[EXCLUDE\_FROM\_ALL\])

add_subdirectory(${
        OPEN_SOURCES_DIRECTORY}/cpp_redis)

### Debug和Release版本 ###

暂不多详述,简单介绍一下。  
debug 版的项目生成的可执行文件需要有调试信息并且不需要进行优化,、  
release 版的不需要调试信息但需要优化。这些特性在 gcc/g++ 中是通过编译时的参数来决定的,如果将优化程度调到最高需要设置参数-O3,最低是 -O0 即不做优化;添加调试信息的参数是 -g -ggdb ,如果不添加这个参数,调试信息就不会被包含在生成的二进制文件中。

例

PROJECT(main)
    CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
    SET(CMAKE_SOURCE_DIR .)
    
    SET(CMAKE_CXX_FLAGS_DEBUG"$ENV{CXXFLAGS} -O0 -Wall -g -ggdb")
    SET(CMAKE_CXX_FLAGS_RELEASE"$ENV{CXXFLAGS} -O3 -Wall")
    
    AUX_SOURCE_DIRECTORY(. DIR_SRCS)
    ADD_EXECUTABLE(main ${
        DIR_SRCS})

两个变量 CMAKE\_CXX\_FLAGS\_DEBUG 和CMAKE\_CXX\_FLAGS\_RELEASE, 分别用于 debug 和 release 的编译选项。编辑 CMakeList.txt 后需要执行 ccmake 命令生成 Makefile 。在进入项目的根目录,输入 “ccmake .” 进入一个图形化界面。

### 调试手段 ###

#### message ####

打印信息，类似于 echo/printf ，主要用于查cmake文件的语法错误。

set(mysql_use_test_sources ${
        SOURCES_DIRECTORY}/test_sources/mysql_user_accounts.cpp)
    message("mysql_use_test_sources ： ${mysql_use_test_sources}")

#### CMAKE\_VERBOSE\_MAKEFILE ####

显示详细的原始编译信息，主要用于定位一些链接错误，看看库路径什么的是否配置对。

# print compile info
    set(CMAKE_VERBOSE_MAKEFILE ON)

或者执行make时  
$ make VERBOSE=1  
或者  
$ export VERBOSE=1  
$ make  
你讲能看到如下所示详细编译信息  
![Alt text][Alt text 2]

### cmake示例 ###

cmake_minimum_required (VERSION 2.8.7)
    project (ws_tcp_server)
    
    ###
    # variables
    ###
    set(SOURCES_DIRECTORY ${
        PROJECT_SOURCE_DIR}/sources)
    set(OPEN_SOURCES_DIRECTORY ${
        PROJECT_SOURCE_DIR}/open_sources)
    set(INCLUDES_DIRECTORY ${
        PROJECT_SOURCE_DIR}/includes)
    
    set(MUDUO_LOGGER_INCLUDES ${
        INCLUDES_DIRECTORY}/muduo_logger)
    set(MUDUO_NETWORK_INCLUDES ${
        INCLUDES_DIRECTORY}/muduo_network)
    set(CPP_REDIS_INCLUDES ${
        OPEN_SOURCES_DIRECTORY}/cpp_redis/includes)
    
    ###
    # includes
    ###
    include_directories(${
        INCLUDES_DIRECTORY}
             ${
        MUDUO_LOGGER_INCLUDES} 
             ${
        MUDUO_NETWORK_INCLUDES}
             ${
        CPP_REDIS_INCLUDES})
    
    ###
    # libraries
    ###
    link_directories("${PROJECT_SOURCE_DIR}/library")
    
    ###
    # outputs
    ###
    #set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
    #set(CMAKE_PKGCONFIG_OUTPUT_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/pkgconfig)
    #set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
    
    set(LIBRARY_OUTPUT_PATH ${
        PROJECT_SOURCE_DIR}/library)
    set(EXECUTABLE_OUTPUT_PATH ${
        PROJECT_SOURCE_DIR}/bin)
    
    ###
    # compilation options
    ###
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DMYSQLPP_MYSQL_HEADERS_BURIED -std=c++11 -g -W -Wall -Wextra -O3")
    
    # print compile info
    #set(CMAKE_VERBOSE_MAKEFILE ON)
    
    ###
    # sources file
    ###
    set(MUDUO_NETWORK_SOURCES_DIRECTORY ${
        SOURCES_DIRECTORY}/muduo_network)
    set(MUDUO_LOGGER_SOURCES_DIRECTORY ${
        SOURCES_DIRECTORY}/muduo_logger)
    set(TEST_EXUTE_SOURCES_DIRECTORY ${
        SOURCES_DIRECTORY}/test_exute)
    
    foreach(dir ${
        MUDUO_LOGGER_SOURCES_DIRECTORY})
      # get directory sources and headers
      file(GLOB s_${
        dir} "${dir}/*.cpp")
      file(GLOB h_${
        dir} "${dir}/*.hpp")
    
      # set async_logger sources
      set(muduo_logger_sources ${
        s_${
        dir}} ${
        h_${
        dir}})
    endforeach()
    
    foreach(dir ${
        MUDUO_NETWORK_SOURCES_DIRECTORY})
      # get directory sources and headers
      file(GLOB s_${
        dir} "${dir}/*.cpp")
      file(GLOB h_${
        dir} "${dir}/*.hpp")
    
      # set muiduo_network sources
      set(muduo_network_sources ${
        s_${
        dir}} ${
        h_${
        dir}})
    endforeach()
    
    #message("muduo_network_sources: ${muduo_network_sources}")
    
    set(test_exute_sources
        ${
        WS_SERVER_SOURCES_DIRECTORY}/test_exute.cpp
        ${
        WS_SERVER_SOURCES_DIRECTORY}/main.cpp)
    
    #message("test_exute_sources ： ${test_exute_sources}")
    
    ###
    #library
    ###
    add_library(async_logging ${
        muduo_logger_sources})
    add_library(muduo_server ${
        muduo_network_sources})
    
    ###
    # executable
    ###
    add_executable(test_exute ${
        test_exute_sources})

### 小结 ###

这些是到目前对cmake使用，所用到的一些基本语法，和基本编译调试手段的一点笔记，后续如有新玩法另加。

[Alt text]: /images/20220219/b7d3d561af924a8ab4fae38b9d27a20d.png
[Alt text 1]: /images/20220219/66aa82da50b04d8bab0d1f0518e03106.png
[Alt text 2]: /images/20220219/b10badb85f264e599ba87dc687524b39.png