CMake

[bingoogolapple]

前言

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

安装 CMake

• Ubuntu 上安装 CMake

  sudo apt install cmake
  cmake --version

• Mac 上安装 CMake

  brew install cmake
  cmake --version

• Windows 上安装 CMake
  • 下载 CMake
  • 添加 bin 目录到 PATH 环境变量中

Cross-platform development

• 使用 CMake 前新增文件时需要在每个平台的编译工具中添加一次
• 使用 CMake 后新增文件时只需要往 CMakeLists.txt 中添加一次即可

语法特性介绍

• 基本语法格式：指令(参数 1 参数 2...)
  • 参数使用括弧括起
  • 参数之间使用空格或分号分开
• 指令是大小写无关的，参数和变量是大小写相关的
  • 变量使用 ${} 方式取值，但是在 if 控制语句中是直接使用变量名

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

[bingoogolapple]

CMake 重要指令

• cmake_minimum_required - 指定 CMake 的最小版本要求
  • 语法：cmake_minimum_required(VERSION versionNumber [FATAL_ERROR])

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

• project - 定义工程名称，并可指定工程支持的语言
  • 语法：project(projectname [CXX] [C] [Java])

    # 指定工程名为 CNote
    project(CNote)
    # 指定工程名为 CNote，并制定工程语言为 C
    project(CNote C)

• set - 显式的定义变量
  • 语法：set(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

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

• include_directories - 向工程添加多个特定的头文件搜索路径 ---> 相当于指定 g++ 编译器的 -I（大写的 I）参数
  • 语法：include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)

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

• 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(-p1 -p2 -p3)

    # 添加编译参数 -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（小写的 L）参数
  • 语法：target_link_libraries(target library1<debug | optimized> 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})

[bingoogolapple]

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
  • 这三个变量指代的内容是一致的
  • 如果是 in-source build，指的就是工程顶层目录
  • 如果是 out-of-source build，指的是工程编译发生的目录
  • PROJECT_BINARY_DIR 跟其他指令稍有区别，不过现在，可以理解为他们是一致的
• CMAKE_SOURCE_DIR、PROJECT_SOURCE_DIR、_SOURCE_DIR
  • 这三个变量指代的内容是一致的，不论采用何种编译方式,都是工程顶层目录
  • 也就是在 in source build 时，他跟 CMAKE_BINARY_DIR 等变量一致
  • PROJECT_SOURCE_DIR 跟其他指令稍有区别，不过现在，可以理解为他们是一致的
• CMAKE_C_COMPILER：指定 C 编译器
• CMAKE_CXX_COMPILER：指定 C++ 编译器
• EXECUTABLE_OUTPUT_PATH：可执行文件输出的存放路径
• LIBRARY_OUTPUT_PATH：库文件输出的存放路径
• PROJECT_NAME：获取 project 配置的项目名称

[bingoogolapple]

CMake 编译工程

CMake 目录结构：项目主目录存在一个 CMakeLists.txt 文件

两种方式设置编译规则

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

编译流程

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

1. 手动编写 CMakeLists.txt
2. 执行命令 cmake PATH 生成 Makefile（PATH 是顶层 CMakeLists.txt 所在的目录）
3. 执行命令 make 进行编译

   .     # 表示当前目录
   ./    # 表示当前目录
   ..    # 表示上级目录
   ../   # 表示上级目录

两种构建方式

内部构建（in-source build）：不推荐使用

内部构建会在同级目录下产生一大堆中间文件，这些中间文件并不是我们最终所需要的，和工程源文件放在一起会显得杂乱无章

# 在当前目录下，编译本目录的 CMakeLists.txt，生成 Makefile 和其他文件
# 如果电脑上已经安装了 VS，可能会调用微软 MSVC 编译器导致不会生成 Makefile，使用【cmake -G "MinGW Makefiles" .】代替【cmake .】即可，仅第一次需要代替，后续都可以直接使用【cmake .】
cmake .
# 执行 make 命令，生成 target
make

外部构建（out-of-source build）：推荐使用

将编译输出文件与源文件放到不同目录中

# 1. 在当前目录下，创建 build 文件夹
mkdir build
# 2. 进入到 build 文件夹
cd build
# 3. 编译上级目录的 CMakeLists.txt，生成 Makefile 和其他文件
# 如果 Windows 电脑上已经安装了 VS，可能会调用微软 MSVC 编译器导致不会生成 Makefile，使用【cmake -G "MinGW Makefiles" ..】代替【cmake ..】即可，仅第一次需要代替，后续都可以直接使用【cmake ..】
cmake ..
# 4. 生成 target：Windows 电脑使用 mingw32-make，Linux 和 Mac 使用 make
make