VS Code C++ CMake构建插件

前言

我上一篇文章VS Code C++ 安装和环境配置(MSVC和MinGW)介绍了通过tasks.json和launch.json共存cl和g++的编译方式,这种直接使用编译命令的方法比较偏向于小项目以及复习编译工具基础,对于多源文件和编译选项很复杂的工程, 会使用编译器自带的批处理Make程序比如GNU的make, MSVC的nmake和第三方的ninja, 以及方便的CMake来帮助最终多任务的编译和生成. 今天介绍怎么在VS Code中使用CMake插件来构建C++工程.

为什么使用CMake

基于Make的构建程序一般都是通过读取相应Makefile文件(不同builder名称会有不同,功能一致)中的规则来生成最终的目标文件或者二进制文件,但是Makefile文件并不好写,对于c++这种编译型语言,跨平台也很麻烦,所以出现了CMake这种工具来帮助程序员生成Makefile文件来使用.

准备工作

• 在VS Code中按Ctrl+Shift+X打开EXTENSIONS搜索安装如下插件:

CMake //语法提示,用来编辑CMakeList.txt文档
CMake Tools //CMake功能插件

• 检查一下左下角的状态栏是否如下图的可点击按钮:
  CMake状态栏按钮

开始构建

• 写一个简单的main.cpp:

#include 

int main(int, char**) {
    std::cout << "Hello, world!\n";
    system("pause");
}

• 生成一个CMakeLists.txt: 这是CMake来确定编译器和参数用的关键文件.这里可以有两种选择,coder可以自己写一个或者使用CMake Tools插件的命令来生成,我本人推荐先用命令生成一个,然后再根据实际需求修改.按Ctrl+Shift+P呼出命令面板,找到CMake:Quick Start:

  CMake快速配置

  然后依次设置工程名称和目标类型,然后会自动生成一个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)
  

• 生成Makefile文件和Build:

  • 首先确定使用的编译工具包.按Ctrl+Shift+P呼出命令面板,定位CMake: Selecte a kit来选择对应的编译器工具包(包括使用的编译器,Make程序等). 也可以直接按状态栏的对应按钮来选择Kit. 如果安装正确的话(安装环境可以参照我上一篇文章VS Code C++ 安装和环境配置(MSVC和MinGW))会出现一个列表可供选择:
    

    选择编译工具包

  • 接着执行'CMake:Configuration'来生成对应kit中generator的Makefile文件. 这一步其实对应直接使用CMake -G'生成器'命令.

  • 上一步会在当前文件夹下的build文件夹生成对应的Makefile文件和其他CMake
    的文件,接着就是build了,可以呼出命令面板执行CMake:Build或者直接状态栏按Build. 这一步其实是执行了CMake的CMake --build ...命令. 最终链接成所需要的一个binary文件.

后记

• VS Code的CMake Tools插件只是用来替代手动使用CMake的各种命令.
• 可以根据项目的不同需要来修改CMakeLists.txt
• 这个插件对于MSVC的编译工具包,默认使用的是ninja生成器.
• 要查看这个插件所使用的对应CMake命令,可以查看output窗口的执行过程; 要详细查看CMake --build使用的参数,可以查看 CMakeCache 这个文件.