[开发工具]mac vscode 编译c++ 多目录代码 demo

背景

mac 上使用 vscode 开发c++ 代码。针对多目录编译配置的问题做一个demo。记录一下遇到的问题。
首先需要安装插件 
	C/C++ IntelliSense
	Code Runner 【非必须。如果需要右键run 建议安装】
说明：本教程未使用cmake 编译。 仅仅使用了依赖.vscode 的配置文件编译 & 右键编译+运行。 

一、项目结构

vscode_jni
	.vscode
		c_cpp_properties.json
		launch.json
		setting.json
		tasks.json
	api
		demo.hpp
	core
		demo.cpp
	target

	main.cpp

二、测试代码

c_cpp_properties.json 修改部分

{
    "configurations": [
        {
            "name": "macos-gcc-x64",
            "includePath": [
                "${workspaceFolder}/api",
                "${workspaceFolder}/**"
            ],
            "compilerPath": "/usr/bin/g++",
            "cStandard": "${default}",
            "cppStandard": "${default}",
            "intelliSenseMode": "macos-gcc-x64",
            "compilerArgs": [
                "-Wall",
                "-Wextra",
                "-Wpedantic"
            ]
        }
    ],
    "version": 4
}

launch.json

{
  "version": "0.2.0",
  "configurations": [
  {//这个大括号里是我们的‘调试(Debug)’配置
    "name": "Debug", // 配置名称
    "type": "cppdbg", // 配置类型，cppdbg对应cpptools提供的调试功能；可以认为此处只能是cppdbg
    "request": "launch", // 请求配置类型，可以为launch（启动）或attach（附加）
    "program": "${workspaceFolder}/target/${fileBasenameNoExtension}.o", // 将要进行调试的程序的路径
    "args": [], // 程序调试时传递给程序的命令行参数，这里设为空即可
    "stopAtEntry": false, // 设为true时程序将暂停在程序入口处，相当于在main上打断点
    "cwd": "${fileDirname}", // 调试程序时的工作目录，此处为源码文件所在目录
    "environment": [], // 环境变量，这里设为空即可
    "externalConsole": false, // 为true时使用单独的cmd窗口，跳出小黑框；设为false则是用vscode的内置终端，建议用内置终端
    "internalConsoleOptions": "neverOpen", // 如果不设为neverOpen，调试时会跳到“调试控制台”选项卡，新手调试用不到
    "MIMode": "gdb", // 指定连接的调试器，gdb是minGW中的调试程序
    "miDebuggerPath": "/usr/local/bin/gdb", // 指定调试器所在路径，如果你的minGW装在别的地方，则要改成你自己的路径，注意间隔是\\
    "preLaunchTask": "build" // 调试开始前执行的任务，我们在调试前要编译构建。与tasks.json的label相对应，名字要一样
}
  ]
}

setting.json 未变动

tasks.json

{
    // See https://go.microsoft.com/fwlink/?LinkId=733558
    // for the documentation about the tasks.json format
    "version": "2.0.0",
    "tasks": [
        {
           //这个大括号里是‘构建（build）’任务
           "label": "build", //任务名称，可以更改，不过不建议改
           "type": "shell", //任务类型，process是vsc把预定义变量和转义解析后直接全部传给command；shell相当于先打开shell再输入命令，所以args还会经过shell再解析一遍
           "command": "g++", //编译命令，这里是gcc，编译c++的话换成g++
            "args": [
                "${workspaceFolder}/core/*.cpp",
                "main.cpp",
                // "${file}",
                // "*.cpp",


                //-L "-Lxxx/lib",
                // -I "xxx/include",
               "-I${workspaceFolder}/api",

                "-o",//指定输出文件的路径和名称
                "${workspaceFolder}/target/${fileBasenameNoExtension}.o",
                "-g", //生成和调试有关的信息
                "-Wall", // 开启额外警告
                // "-static-libstdc++",  // 静态链接libgcc  -static-libgcc / -stdlib=libc++
                "-fexec-charset=UTF-8", // 生成的程序使用GBK编码，不加这一条会导致Win下输出中文乱码
                "-std=c++11", // 语言标准，可根据自己的需要进行修改，写c++要换成c++的语言标准，比如c++11
            // "-stdlib=libc++"
            ],
            
            "group": {  //group表示‘组’，我们可以有很多的task，然后把他们放在一个‘组’里
                "kind": "build",//表示这一组任务类型是构建
                "isDefault": true//表示这个任务是当前这组任务中的默认任务
            },
            "presentation": { //执行这个任务时的一些其他设定
                "echo": true,//表示在执行任务时在终端要有输出
                "reveal": "always", //执行任务时是否跳转到终端面板，可以为always，silent，never
                "focus": false, //设为true后可以使执行task时焦点聚集在终端，但对编译来说，设为true没有意义，因为运行的时候才涉及到输入
                "panel": "shared" //new:每次执行这个task时都新建一个终端面板，也可以设置为 shared ，共用一个面板，不过那样会出现‘任务将被终端重用’的提示，比较烦人
            },
            "problemMatcher": "$gcc" //捕捉编译时编译器在终端里显示的报错信息，将其显示在vscode的‘问题’面板里
        
        }
        ,
        {
            "label": "run",
            "type": "shell",
            "dependsOn": "build",
            "command": "${workspaceFolder}/target/${fileBasenameNoExtension}.o",
            "group": {
                "kind": "test",
                "isDefault": true
            },
            "presentation": {
                "echo": true,
                "reveal": "always",
                "focus": true,
                "panel": "shared"
            }
        }
    ]
}

demo.hpp

#ifndef DEMO_H_
#define DEMO_H_

class demo
{
private:
    /* data */
public:
    int add2sum(int a, int b);
};

#endif

demo.cpp

#include <iostream>
#include "demo.hpp"
using namespace std;

int demo::add2sum(int a, int b)
{
    std::cout << "demo::add2sum" << std::endl;

    return a + b;
}

main.cpp

#include "demo.hpp"

int main()
{

    demo d1;
    d1.add2sum(1, 5);

    return 0;
}

三、调试

shift+command+B 编译

首先打开 main.cpp 使用快捷键 shift+command+B 编译
如果运行成功可以看到如下显示【如果出错自行调正 task.json 配置信息】
Executing task: g++ /Users/XXX/Downloads/workspace/c++/vscode_jni/core/*.cpp main.cpp -I/Users/XXX/Downloads/workspace/c++/vscode_jni/api -o /Users/XXX/Downloads/workspace/c++/vscode_jni/target/main.o -g -Wall -fexec-charset=UTF-8 -std=c++11 <

控制台 进入 cd /Users/XXX/Downloads/workspace/c++/vscode_jni/
执行 ./main.o
一切顺利可以看到
“demo::add2sum ”

右键编译

为了和上述编译区分开来 这里生成的文件后缀使用 so
打开 code runner的 Executor Map 下的 setting.json

添加如下配置

 "code-runner.executorMap": {
          "cpp":"g++ $dircore/*.cpp main.cpp -I$dirapi -o $dirtarget/$fileNameWithoutExt.so && $dirtarget/$fileNameWithoutExt.so"
    },

此时打开 main.cpp 使用右键 Run code 即可执行
一切正常可以在控制台看到
“demo::add2sum ”

PS：调试过程中在这一步遇到 main.cpp 引入头文件 爆红的问题，鼠标放上去提示 “… configurationProvider 显示…”。 当时 使用快捷键 Shift+command+P 然后输入 configurationProvider 直接禁用掉了。
代码地址 :「部分配置有改动」
https://gitee.com/Mylomen/vscode_jni