win10+gcc+cmake+vscode 的最简demo

环境搭建

• 安装Vscode

  • 安装一些必须插件

• 安装MinGW, 安装arm_none-eabi-gcc(这个例子中不是必须的，是单片机才需要)

• 安装CMake

• 都安装完成后添加至环境变量中

• 测试能否获取版本

  

流程梳理

• 正常未使用cmake的流程： 编写代码--->编写makefile-->make编译-->执行

• 使用cmake的流程：编写代码--->编写CMakeLists.txt(用于自动生成makefile,可跨平台)--->执行cmake生成makefile(可跨平台)--->make编译--->执行

编写代码

• 代码目录结构如下 

• 

• 代码实现

• /* ./include/test.h */
  #pragma once
  ​
  #include <iostream>
  using namespace std;
  ​
  void myprint(void);
  ​
  ​
  ​
  /* ./source/test.cpp */
  #include "test.h"
  ​
  void myprint(void)
  {
      std::cout<<"myprint."<<endl;
  }
  ​
  ​
  ​
  /* ./main.cpp */
  #include "test.h"
  ​
  int main(void)
  {
      myprint();
      
      system("pause");
      return 0;
  }

• 编写CMakeLists.txt

  # 版本要求
  cmake_minimum_required(VERSION 3.0)
  # 工程名 可以随便命名，暂时没有显示调用，应该是内部调用了，必须要有
  project(cmake_test)
  # 设置编译器和参数 set()函数就是将 "g++"赋值给CMAKE_CXX_COMPILER
  # 实际上类似于 #define CMAKE_CXX_COMPILER "g++"
  set(CMAKE_CXX_COMPILER "g++")
  set(CMAKE_C_COMPILER "gcc")
  set(CMAKE_C_STANDARD 99)
  set(CMAKE_CXX_STANDARD 11)
  # 添加头文件 ${}表示取值
  include_directories(${PROJECT_SOURCE_DIR}/include)
  # 设置源文件路径 别名为SRC_DIR
  set(SRC_DIR "./main.cpp" "./source/test.cpp")
  ​
  ​
  # 设置可执行文件的输出路径，如果不存在会创建一个
  set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
  # 设置可执行文件名称，make之后bin目录下会出现demo.exe
  add_executable(demo ${SRC_DIR})
  ​
  # 用来显示信息，类似printf
  # message("=========test cmake message=============\r\n" 
  #         ${SRC_DIR} "\r\n"
  #         ${EXECUTABLE_OUTPUT_PATH} "\r\n"
  #         ${CMAKE_CXX_COMPILE} "\r\n"
          
  #         ${PROJECT_BINARY_DIR} "\r\n" # 这个是CMAKE自动创建的
  #         ${PROJECT_SOURCE_DIR} "\r\n" # 这个是CMAKE自动创建的
  ​
  #         ${PROJECT_NAME} "\r\n"
  ​
  #         "=========test end=============\r\n" 
  #         )

• 实际上不配置各种.json文件也是可以完成的

  • 新建build文件夹 mkdir build

  • 进入build cd ./build

  • 执行cmake cmake .. 因为CMakeLists.txt在上一级目录，所以需要 ..

  • 

  • 但是这里cmake调用了vs studio, 导致没有生成makefile, 所以后面的make也会失败

  • 执行 make 

  • 

  • 所以需要切换一下cmake的生成器

  • cmake -G "MinGW Makefiles" ..

  • 

  • 再执行make

  • 

  • 此时正常了

  • 执行 demo.exe

使用tasks.json 进行自动操作

• 创建tasks.json, 可以直接在.vscode下新建，或者如下的操作

• ctrl+shift+p 输入 tasks 选择配置任务即可

  {
      // See https://go.microsoft.com/fwlink/?LinkId=733558
      // for the documentation about the tasks.json format
      "version": "2.0.0",
      "tasks": [
          //! 创建 build 文件夹  即 mkdir build
          {
              "label": "mk_build",    //!< 任务名称
              "type": "shell",
              "command": "mkdir",
              "args": [
                  "build",
              ],
              "options": {
                  "cwd": "${workspaceFolder}",    //!< 执行在当前目录
              },
          },
          //! 调用 cmake 生成makefile  即  cmake -G "MinGW Makefiles" 
          {
              "label": "cmake",
              "type": "shell",
              "command": "cmake",
              "args": [
                  "-G",
                  "MinGW Makefiles", //!< 需要指定MinGW Makefiles 否则使用vs studio编译器,不会生成Makefile
                  "${workspaceFolder}", //!< CMakeLists.txt的路径
              ],
              "options": {
                  "cwd": "${workspaceFolder}/build", //!< 执行路径
              },
              "group": {
                  "kind": "build",
                  "isDefault": true,
              },
              "dependsOn": [
                  "mk_build", //!< 依赖mk_build任务，如果mk_build没执行过，则会先执行mk_build任务
              ],
          },
          //! 调用 make 编译代码 即 make -j16
          {
              "label": "build",
              "type": "shell",
              "command": "make",  //!< 或者mingw32-make
              "args": [
                  "-j16", //!< 使用16线程同时编译
              ],
              "options": {
                  "cwd": "${workspaceFolder}/build",
              },
              "group": {
                  "kind": "build",
                  "isDefault": true,
              },
              "dependsOn": [
                  "cmake",    //!< 需要依赖cmake任务生成的makefile
              ],
          },
          //! 执行.exe程序  即 ./demo.exe
          {
              "label": "execute",
              "type": "shell",
              "command": "./*.exe",
              "options": {
                  "cwd": "${workspaceFolder}/bin",    //!< .exe的路径，由CMakeLists.txt设置的
              },
              "group": {
                  "kind": "test",
                  "isDefault": true,
              },
              "dependsOn": [
                  "build",    //!< 需要编译完成后才有.exe程序
              ],
          },
          //! 删除编译内容 build目录 即 rm -r ./build
          {
              "label": "clean",
              "type": "shell",
              "command": "rm",    //!< 或者del 应该rm兼容性好一些
              "args": [
                  "-r",
                  "./build",
              ],
              "options": {
                  "cwd": "${workspaceFolder}",
              },
              "group": {
                  "kind": "build",
                  "isDefault": true,
              },
              // "dependsOn": [
              //     "build",
              // ],
          },
      ]
  }

• 如何执行task任务？

• 点击终端--->运行任务--->选择对应的任务名即label

• 名称对应一个任务，如果是直接运行execute,则会依次调用mk_build---->cmake---->build---->execute 然后输出结果

  因为tasks.json中设置了依赖关系，所以会依次调用，如果没有设置依赖关系，则需要按顺序挨个运行

结束语：部分借鉴了别的网友的博客，如有侵权，联系我删除