【Cmake】Cmake基础学习

CMake学习

一、基础学习

1. 利用Cmake进行单个源代码构建可执行文件

（1）基础命令

最基本的 CMake项目是由单个源代码文件构建的可执行文件。对于这样的简单项目，只需要一个包含三个命令的 CMakeLists.txt 文件。

注意: 虽然 CMake 支持大写、小写和混合大小写命令，但是小写命令更受欢迎，并将在本教程中使用。

• add_executable()
• cmake_minimum_required()
• project()

#指定使用 CMake 的最低版本号(用于兼容)
cmake_minimum_required(VERSION 2.8)

# set the project name（指定项目名称）
project(Tutorial)

# add the executable（指定生成可执行文件的名称和相关源文件）
add_executable(Tutorial tutorial.cpp)

测试用例： tutorial.cpp 文件在 step1 目录中，可用于计算数字的平方根 。

#include 
#include 
#include 
#include 

int main(int argc, char* argv[])
{
    if (argc < 2) {
        std::cout << "Usage: " << argv[0] << " number" << std::endl;
        return 1;
    }

    // convert input to double
    const double inputValue = atof(argv[1]);

    // calculate square root
    const double outputValue = sqrt(inputValue);
    std::cout << "The square root of " << inputValue
              << " is " << outputValue
              << std::endl;
    return 0;
}

（2）build和Run

① 在step1目录下创建一个 构建目录 build

mkdir bulid

② 切换到该构建目录并运行 cmake 以配置项目并生成本机构建系统

cd bulid
cmake ../  
#构建系统是需要指定 CMakeLists.txt 所在路径，此时在 build 目录下，所以用 .. 表示 CMakeLists.txt 在上一级目录。

此时在 build 目录下会生成 Makefile 文件 。

③ 调用构建系统来实际编译/链接项目

cmake --build .
#--build 指定编译生成的文件存放目录，其中就包括可执行文件，. 表示存放到当前目录

此时，在 build 目录下生成了一个 Tutorial 可执行文件，试着执行它：

④ 执行可执行文件

./Tutorial

此时目录结构

（3）添加版本号和配置头文件

有时候，让在 CMakelists.txt 文件中定义的变量在源代码中也可用会很有用。在这种情况下，我们希望打印项目版本。

实现这一点的一种方法是使用配置的头文件。我们创建一个包含一个或多个要替换的变量的输入文件。这些变量有特殊的语法，看起来像@VAR@。然后，我们使用 configure _ file ()命令将输入文件复制到给定的输出文件，并用 CMakelists.txt 文件中的当前值 VAR 替换这些变量。

虽然我们可以直接在源代码中编辑版本，但是最好使用这个特性，因为它创建了一个单一的真相来源，并且避免了重复。

【注意】要使用版本号，cmake版本需要在3.12，版本太低可能会会报错。

① 修改 CMakeLists.txt 文件，使用 project 命令设置项目名称和版本号。

# set the project name and version
project(Tutorial VERSION 1.0)

② 配置头文件将版本号传递给源代码：

configure_file(TutorialConfig.h.in TutorialConfig.h)

③ 由于 TutorialConfig.h 文件会被自动写入 build 目录，因此必须将该目录添加到搜索头文件的路径列表中。将以下行添加到 CMakeLists.txt 文件的末尾：

target_include_directories(Tutorial PUBLIC
                           ${PROJECT_BINARY_DIR}
                           )