cmake-debug和release模式

一般在工程中，自动构建可能会编译两个版本的发布包，一个debug版本，一个release版本。那么通过cmake怎样来实现呢？本文就以这个需求为例，来介绍cmake中的逻辑控制。

目录结构

|-- bin
|-- build
|-- CMakeLists.txt
|-- src
|   `-- main.c

Debug-Release模式控制

顶层CMakeLists.txt

cmake_minimum_required(VERSION 3.12)
project(test07)

aux_source_directory(${PROJECT_SOURCE_DIR}/src src_dirs)

# 条件判断
if(CMAKE_BUILD_TYPE AND (CMAKE_BUILD_TYPE STREQUAL "Debug"))
    set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -Wall -O0")
    message("Debug mode:${CMAKE_C_FLAGS_DEBUG}")
    add_executable(test_debug ${src_dirs})

elseif(CMAKE_BUILD_TYPE AND (CMAKE_BUILD_TYPE STREQUAL "Release"))
    set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} -Wall -O3")
    message("Release mode:${CMAKE_C_FLAGS_RELEASE}")
    add_executable(test_release ${src_dirs})
else()
    message("else:${CMAKE_BUILD_TYPE}")
    message("else:${CMAKE_C_FLAGS_RELEASE}")
    add_executable(test_release ${src_dirs})
endif()

先简要的描述一下该CMakeLists.txt的控制逻辑。如果CMAKE_BUILD_TYPE的值为"Debug"就采用debug模式编译；如果CMAKE_BUILD_TYPE的值为"Release"就采用release模式编译；如果CMAKE_BUILD_TYPE的值为空，默认采用release模式

默认编译

从上图可以看出，CMAKE_C_FLAGS_RELEASE 编译选项的默认值为-O3 -DNDEBUG。最终生成可执行文件test_release，./test_release输出’hello cmake’。test_release文件大小为8600字节。

release 编译

从上图可以看出，通过cmake命令行指定CMAKE_BUILD_TYPE为Release，最终生成可执行文件test_release，./test_release输出’hello cmake’。test_release文件大小为8600字节。

debug编译

从上图可以看出，通过cmake命令行指定CMAKE_BUILD_TYPE为Debug，最终生成可执行文件test_release，./test_release输出’hello cmake’。test_release文件大小为9872字节。因为debug模式编译生成的可执行文件包含可调试的相关信息，所以文件大小会变大。

控制逻辑

通过上例知道，可以通过if命令来控制cmake的编译逻辑，接下来，详细介绍cmake中if命令的使用。

条件命令

if()
  
elseif() # optional block, can be repeated
  
else()              # optional block
  
endif()

if条件命名的语法非常简单。这里需要特别说明关于if()中variable的注意点，引用文档中的一段话：

The if command was written very early in CMake’s history, predating the ${} variable evaluation syntax, and for convenience evaluates variables named by its arguments as shown in the above signatures. Note that normal variable evaluation with ${} applies before the if command even receives the arguments.

这段话的意思是，由于if命令语法在变量引用${}语法之前出现，所以如果使用if(${var})，那么将会被引用两次；如果使用if(var)，将只会被if本身的语法引用一次。也就是要注意两次引用问题。

举个栗子：

# 在前面的CMakeLists.txt中
if(CMAKE_BUILD_TYPE AND (CMAKE_BUILD_TYPE STREQUAL "Debug"))

如果是通过cmake .. 编译，而没有指定CMAKE_BUILD_TYPE的话，那么if命令本身会引用变量CMAKE_BUILD_TYPE，其值为空，if条件判断为假；
如果是通过cmake -DCMAKE_BUILD_TYPE=Debug .. 编译，if命令本身会引用变量CMAKE_BUILD_TYPE，其值为Debug，if条件判断为真；

# 如果将变量CMAKE_BUILD_TYPE通过${}再引用一次，会发生什么？
if(${CMAKE_BUILD_TYPE} AND (CMAKE_BUILD_TYPE STREQUAL "Debug"))

由于 ${CMAKE_BUILD_TYPE}的值为空，if(${CMAKE_BUILD_TYPE}相当于if(空变量)，然后if命令再对"空变量"进行引用，显然，语法上错误。即会报如下图错误：

如果你非要使用if($var)，那你必须明确的知道变量var的值是另一个变量的变量名。

例如，将前面的CMakeLists.txt做如下修改(虽然没有什么实际意义，仅作为解释语法特点)

cmake_minimum_required(VERSION 3.12)
project(test07)

aux_source_directory(${PROJECT_SOURCE_DIR}/src src_dirs)

set(mode "CMAKE_BUILD_TYPE") # 修改点

# 条件判断
if(${mode} AND (CMAKE_BUILD_TYPE STREQUAL "Debug")) # 修改点
    set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -Wall -O0")
    message("Debug mode:${CMAKE_C_FLAGS_DEBUG}")
    add_executable(test_debug ${src_dirs})

elseif(${mode} AND (CMAKE_BUILD_TYPE STREQUAL "Release")) # 修改点
    set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} -Wall -O3")
    message("Release mode:${CMAKE_C_FLAGS_RELEASE}")
    add_executable(test_release ${src_dirs})
else()
    message("else:${CMAKE_BUILD_TYPE}")
    message("else:${CMAKE_C_FLAGS_RELEASE}")
    add_executable(test_release ${src_dirs})
endif()