对CMake Tool创建的第一个hello world工程的说明

一、工程主体

这里我们通过vscode的CMake Tool为我们自动创建一个CMake工程。

具体如何操作可以参考我的另一篇博文：
vscode使用CMake Tool插件构建第一个CMake的helloworld工程

创建完成后，生成了一个main.cpp, 一个CMakeLists.txt, 以及一个build目录。

打开CMakeLists.txt, 可以看到内容如下：

cmake_minimum_required(VERSION 3.0.0)
project(hello VERSION 0.1.0)

include(CTest)
enable_testing()

add_executable(hello main.cpp)

set(CPACK_PROJECT_NAME ${PROJECT_NAME})
set(CPACK_PROJECT_VERSION ${PROJECT_VERSION})
include(CPack)

我们目前暂时重点关注以下几行，这几行是核心内容，其他的内容甚至都可以暂时去除也没什么关系：

// 指定cmake使用的最低版本号
cmake_minimum_required(VERSION 3.0.0)

// 设定工程的名字为hello， 版本号为0.1.0
project(hello VERSION 0.1.0)

// 生成名为hello的可执行文件，相关的源文件是main.cpp
add_executable(hello main.cpp)

二、CMakeLists.txt语法说明

通过这个例子，可以对CMake有个大致的了解。下面对其做一些简单的说明。

我们来重新看一下 CMakeLists.txt，这个文件是 cmake 的构建定义文件，文件名是大小写相关的，如果工程存在多个目录，需要确保每个要管理的目录都存在一个CMakeLists.txt。(关于多目录构建，后面我们会提到，这里不作过多解释)。

• PROJECT 指令的语法是：

PROJECT(projectname [CXX] [C] [Java])

你可以用这个指令定义工程名称，并可指定工程支持的语言，支持的语言列表是可以忽略的，默认情况表示支持所有语言。这个指令隐式的定义了两个 cmake 变量:<projectname>_BINARY_DIR 以及<projectname>_SOURCE_DIR，这里就是HELLO_BINARY_DIR 和 HELLO_SOURCE_DIR。

同时 cmake 系统也帮助我们预定义了 PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR变量，他们的值分别跟 HELLO_BINARY_DIR 与 HELLO_SOURCE_DIR 一致。为了统一起见，建议以后直接使用 PROJECT_BINARY_DIR，PROJECT_SOURCE_DIR，即使修改了工程名称，也不会影响这两个变量。如果使用了<projectname>_SOURCE_DIR，修改工程名称后，也需要同时修改这些变量，不方便。

• SET 指令的语法是：

SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

现阶段，你只需要了解 SET 指令可以用来显式的定义变量即可。比如我们用到的是 SET(SRC_LIST main.c)，如果有多个源文件，也可以定义成：

SET(SRC_LIST main.c t1.c t2.c)。

• ADD_EXECUTABLE

ADD_EXECUTABLE(hello ${SRC_LIST})

定义了这个工程会生成一个文件名为 hello 的可执行文件，相关的源文件是 SRC_LIST 中
定义的源文件列表， 本例中你也可以直接写成 ADD_EXECUTABLE(hello main.cpp)。

这里需要特别解释的是作为工程名的 hello 和生成的可执行文件 hello 是没有任何关系的, 你完全可以写成

ADD_EXECUTABLE(my_exe main.cpp)

最简单的语法规则是：

1. 变量使用${}方式取值，但是在 IF 控制语句中是直接使用变量名
2. 指令(参数 1 参数 2…)
   参数使用括弧括起，参数之间使用空格或分号分开。
   以上面的 ADD_EXECUTABLE 指令为例，如果存在另外一个 func.c 源文件，就要写成：
   ADD_EXECUTABLE(hello main.c func.c)或者
   ADD_EXECUTABLE(hello main.c;func.c)
3. 指令是大小写无关的，参数和变量是大小写相关的。

工程的清理：

make clean

三、关于内部构建和外部构建的说明

还有另外一个非常重要的提示，就是：我们上述的例子中进行的是内部构建(in-sourcebuild)，而 cmake 强烈推荐的是外部构建(out-of-source build)。

关于内部构建和外部构建，将在另一篇博文中做详细介绍。