CMake的简单使用

---

1、CMake介绍

• CMake是一个跨平台的安装编译工具，可以用简单的语句来描述所有平台的安装(编过程)
• CMake可以说已经成为大部分C++开源项目标配

优点：
1、开源代码，使用类BSD许可发布。
2、跨平台，并可以生成native编译配置文件，在linux/Unix平台，生成makefile,在苹果平台可以生成Xcode,在windows平台，可以生成MSVC的工程文件。
3、能够管理大型项目。
4、简化编译构建过程和编译过程。cmake的工具链：cmake+make。
5、高效率，因为cmake在工具链中没有libtool。
6、可扩展，可以为cmake编写特定功能的模块，扩展cmake功能。

缺点：
1、cmake只是看起来比较简单，使用并不简单；
2、每个项目使用一个CMakeLists.txt（每个目录一个），使用的是cmake语法。
3、cmake跟已有体系配合不是特别的理想，比如pkgconfig。

2、语法特性介绍

基本语法格式：指令(参数 1 参数 2…)

• 参数使用括弧括起
• 参数之间使用空格或分号分开

指令是大小写无关的，参数和变量是大小写相关的

set(HELLO hello.cpp)
add_executable(hello main.cpp hello.cpp)
ADD_EXECUTABLE(hello main.cpp ${HELLO})

变量使用${}方式取值，但是在 IF 控制语句中是直接使用变量名

3、CMake重要指令

cmake_minimum_required - 指定CMake的最小版本要求

• 语法：cmake_minimum_required(VERSION versionNumber [FATAL_ERROR])

CMake最小版本要求为2.8
cmake_minimum_required(VERSION 2.8)

project - 定义工程名称，并可指定工程支持的语言

• 语法：set(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

指定工程名为HELLOWORLD
project(HELLOWORLD)

set - 显式的定义变量

• 语法：set(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

定义SRC变量，其值为sayhello.cpp hello.cpp
set(SRC sayhello.cpp hello.cpp)

include_directories - 向工程添加多个特定的头文件搜索路径 —>相当于指定g++编译器的-I参数

• 语法： include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 …)

将/usr/include/myincludefolder 和 ./include 添加到头文件搜索路径
include_directories(/usr/include/myincludefolder ./include)

link_directories - 向工程添加多个特定的库文件搜索路径 —>相当于指定g++编译器的-L参数

• 语法： link_directories(dir1 dir2 …)

将/usr/lib/mylibfolder 和 ./lib 添加到库文件搜索路径
link_directories(/usr/lib/mylibfolder ./lib)

add_library - 生成库文件

• 语法： add_library(libname [SHARED|STATIC|MODULE] [EXCLUDE_FROM_ALL]source1 source2 … sourceN)

通过变量 SRC 生成 libhello.so 共享库
add_library(hello SHARED ${SRC})

add_compile_options - 添加编译参数

• 语法：add_compile_options(需要添加的编译参数，例如-std=c++11 -g -Wall)

添加编译参数 -Wall -std=c++11 -O2
add_compile_options(-Wall -std=c++11 -O2)

add_executable - 生成可执行文件

• 语法：add_executable(exename source1 source2 … sourceN)

编译main.cpp生成可执行文件main
add_executable(main main.cpp)

target_link_libraries - 为 target 添加需要链接的共享库 —>相同于指定g++编译器-l参数

• 语法： target_link_libraries(target library1 library2…)

将hello动态库文件链接到可执行文件main
target_link_libraries(main hello)

add_subdirectory - 向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制存放的位置

• 语法： add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

添加src子目录，src中需有一个CMakeLists.txt
add_subdirectory(src)

aux_source_directory - 发现一个目录下所有的源代码文件并将列表存储在一个变量中，这个指令临时被用来自动构建源文件列表

• 语法： aux_source_directory(dir VARIABLE)

定义SRC变量，其值为当前目录下所有的源代码文件
aux_source_directory(. SRC)
编译SRC变量所代表的源代码文件，生成main可执行文件
add_executable(main ${SRC})

4、CMake常用变量

• CMAKE_C_FLAGS gcc编译选项
  CMAKE_CXX_FLAGS g++编译选项

在CMAKE_CXX_FLAGS编译选项后追加-std=c++11
set( CMAKE_CXX_FLAGS “${CMAKE_CXX_FLAGS} -std=c++11”)

• CMAKE_BUILD_TYPE 编译类型(Debug, Release)

设定编译类型为debug，调试时需要选择debug
set(CMAKE_BUILD_TYPE Debug)
设定编译类型为release，发布时需要选择release
set(CMAKE_BUILD_TYPE Release)

• CMAKE_BINARY_DIR
  PROJECT_BINARY_DIR
  _BINARY_DIR

1. 这三个变量指代的内容是一致的。
2. 如果是 in source build，指的就是工程顶层目录。
3. 如果是 out-of-source 编译,指的是工程编译发生的目录。
4. PROJECT_BINARY_DIR 跟其他指令稍有区别，不过现在，你可以理解为他们是一致的。

• CMAKE_SOURCE_DIR
  PROJECT_SOURCE_DIR
  _SOURCE_DIR

1. 这三个变量指代的内容是一致的,不论采用何种编译方式,都是工程顶层目录。
2. 也就是在 in source build时,他跟 CMAKE_BINARY_DIR 等变量一致。
3. PROJECT_SOURCE_DIR 跟其他指令稍有区别,现在,你可以理解为他们是一致的。

• CMAKE_C_COMPILER：指定C编译器
• CMAKE_CXX_COMPILER：指定C++编译器
• EXECUTABLE_OUTPUT_PATH：可执行文件输出的存放路径
• LIBRARY_OUTPUT_PATH：库文件输出的存放路径

5、CMake编译工程

CMake目录结构： 项目主目录存在一个CMakeLists.txt文件
两种方式设置编译规则：

• 包含源文件的子文件夹包含CMakeLists.txt文件，主目录的CMakeLists.txt通过add_subdirectory添加子目录即可
• 包含源文件的子文件夹未包含CMakeLists.txt文件，子目录编译规则体现在主目录的CMakeLists.txt中

5.1 编译流程

在 linux 平台下使用 CMake 构建C/C++工程的流程如下:

• 手动编写 CMakeLists.txt
• 执行命令 cmake PATH 生成 Makefile ( PATH 是顶层CMakeLists.txt 所在的目录 )
• 执行命令 make 进行编译

5.2 两种构建方式

5.2.1 内部构建

内部构建(in-source build)：不推荐使用
内部构建会在同级目录下产生一大堆中间文件，这些中间文件并不是我们最终所需要的，和工程源文件放在一起会显得杂乱无章。

在当前目录下，编译本目录的CMakeLists.txt，生成Makefile和其他文件
cmake .
执行make命令，生成target
make

首先在linux系统下创建一个目录，名字随便（我这里为test_cmake1），然后进入该目录
mkdir test_camke1
cd test_camke1

创建名为Swap.cpp的文件，并编辑，保存
#include "Swap.h"
void Swap(int* a, int* b)
{
    int tmp = *a;
    *a = *b;
    *b = tmp;
}

创建名为Swap.h的文件，并编辑，保存
#pragam once
void Swap(int* a, int* b);

创建名为main.cpp的文件，并编辑，保存
#include "Swap.h"
#include 
using namespace std;
int main(int argc, const char **argv)
{
    int a = 0, b = 1;
    cout << a << " " << b << endl;
    Swap(&a, &b);
    cout << a << " " << b << endl;
    return 0;
}


最后创建名为CMakeLists.txt的文件，编辑，保存
# Set the minimum version of CMake that can be used
cmake_minimum_required(VERSION 2.8)

#project name
project(SWAP)

# Add an executable
# my_cmake_exe表示可执行的文件 ，main.cpp Swap.cpp表示需要的源文件
add_executable(my_cmake_exe main.cpp Swap.cpp)

最终有这四个文件

在目录下test_cmake1使用命令 cmake …，然后会新增一个目录和四个文件夹

再使用命令make，生产可执行文件my_cmake_exe


执行my_cmake_exe

5.2.2 外部构建

外部构建(out-of-source build)：推荐使用
将编译输出文件与源文件放到不同目录中

1. 在当前目录下，创建build文件夹
   mkdir build
2. 进入到build文件夹
   cd build
3. 编译上级目录的CMakeLists.txt，生成Makefile和其他文件
   cmake …
4. 执行make命令，生成target
   make

在test_cmake1目录下创建名字分别为include和src的文件
mkdir include
mkdir src

将Swap.h放在include目录下
将Swap.cpp放在src目录下

在test_cmake1目录中再建一个目录build

修改CMakeLists.txt文件
# Set the minimum version of CMake that can be used
cmake_minimum_required(VERSION 2.8)

#project name
project(SWAP)

#指明头文件搜索的路径
include_directories(./include)

# 定义一个变量SRC，表示当前src目录下的所有源文件
aux_source_directory(src SRC)

#设置生成可执行文件的路径
set(EXECUTABLE_OUTPUT_PATH ${CMAKE_BINARY_DIR}/bin)

# Add an executable
add_executable(my_cmake_exe main.cpp ${SRC})

进入build目录，使用命令cmake …

然后使用命令make，进入bin目录，发现有一个可执行文件

执行该文件