[IDE] VSCode C++ 디버깅 환경 세팅(task.json, launch.json): Clang on MacOS

💡 본 문서는 'M1 맥북에서 VSCODE C++ 개발환경 설정'에 대해 정리해놓은 글입니다.
VSCode로 개발환경을 세팅하다보면 tasks.json, launch.json 등 어떻게 할지 헷갈릴때가 많습니다. 이는 일부 OS dependency한 설정도 많기에 일단 제 개발환경인 M1 Mac에서 디버깅하는 방법에 대해 정리해 놓았으니 참고하시기 바랍니다.

1. 개발 환경 세팅

1.1 VSCODE 다운로드

mac OS 환경 및 M1 이라면 Apple Silicon 버전 다운로드합니다.

• 직접 다운로드: https://code.visualstudio.com/#alt-downloads
• brew를 이용한 설치: https://polarcompass.tistory.com/140?category=514165

1.2 VSCode Extension 설치

1.2.1 C++ Extension 설치

C++ extension 설치

1.2.2 CodeLLDB 디버깅 Extension 설치

CodeLLDB

1.3 Clang 설치 및 확인

터미널 창에 아래 내용을 입력하여 clang이 M1에 설치되어 있나 확인합니다.

$ clang --version

만약, 설치되어 있지 않으면 아래 코드를 입력하거나 xcode를 설치하면 해결됩니다.

$ xcode-select --install

2. 디버깅 환경 세팅

폴더 이름을 본인이 원하는 이름으로 생성하고, 내부에 기본 cpp 파일 외 앞으로 다음 세개의 파일을 셋팅하는 것을 목표로 한다.

•  tasks.json  - complier build settings
•  launch.json - debugger settings
•  c_cpp_properties.json  - complier path and IntelliSense settings

이후에 새로운 폴더를 생성하면 위의 세개 파일을 복사해서 붙여넣으면 동일한 세팅값으로 개발이 가능하다.

2.1 cpp 파일 생성

왼쪽 바의 하단 그림의 위치의 아이콘을 클릭하여 test.cpp라는 이름으 새로운 파일을 생성합니다.

파일제목.cpp 생성

이후 파일 내부에 아래 코드를 복붙한 후 Ctrl + S 로 저장합니다.

#include <iostream>
using namespace std;

int main()
{
    cout << "HelloWorld\n";
}

2.2 Build test.cpp: tasks.json 파일 생성

test.cpp를 build 하기 위하여 tasks.json 파일을 생성해야 합니다. 이를 위해 VSCode 내의 상단바 메인 메뉴에서 Terminal(터미널) > Configure Default Build Task(기본 빌드 작업 구성...) 로 들어갑니다. 이후 C/C++ clang++ build active file 선택합니다.

tasks.json 가 생성되면 아래 코드를 복붙합니다.

{
  // See https://go.microsoft.com/fwlink/?LinkId=733558
  // for the documentation about the tasks.json format
  "version": "2.0.0",
  "tasks": [
    {
      "type": "shell",
      "label": "clang++ build active file",
      "command": "/usr/bin/clang++",
      "args": [
        "-std=c++17",
        "-stdlib=libc++",
        "-g",
        // 현재 VSCode 상 프로젝트 폴더가 ${workspaceFolder}이며 이를 기준으로 실행 파일의 위치를 기재
        "${workspaceFolder}/dp/RGBDistance.cpp",
        "-o",
        "${fileDirname}/${fileBasenameNoExtension}"
      ],
      "options": {
        "cwd": "${workspaceFolder}"
      },
      "problemMatcher": ["$gcc"],
      "group": {
        "kind": "build",
        "isDefault": true
      }
    }
  ]
}

이후 test.cpp 파일로 돌아와서 Cmd+Shift+B  로 파일을 build 합니다.

2.3 Execute & Debug test.cpp: launch.json 파일 생성

다음은 launch.json 을 만들어준다. Fn + F5 눌러 debug를 실행해줍니다. 이를 위해 VSCode 내의 상단바 메인 메뉴에서 Run > Add Configuration... 을 선택한 후 C++ (GDB/LLDB) 선택합니다. 그 다음 다음과 같은 선택지를 보게 됩니다.

그 후  launch.json 파일이 생성 된 후 아래와 같은 코드 복붙합니다.

{
  // Use IntelliSense to learn about possible attributes.
  // Hover to view descriptions of existing attributes.
  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
  "version": "0.2.0",
  "configurations": [
    {
      "name": "clang++ - Build and debug active file",
      "type": "lldb",
      "request": "launch",
      "program": "${fileDirname}/${fileBasenameNoExtension}",
      "args": [],
      "stopAtEntry": true,
      "cwd": "${workspaceFolder}",
      "environment": [],
      "externalConsole": false,
      "MIMode": "lldb",
      "preLaunchTask": "clang++ build active file"
    }
  ]
}

※ 주의점

tasks.json 의 label 부분과 launch.json의 preLaunchTask 부분 이름이 같아야 합니다. launch.json을 읽는 것으로 보이는데, launch.json 내부의 preLaunchTask와 같은 tasks.json 내부의 label을 찾아서 실행하는 것으로 보입니다. 

tasks.json

"label": "clang++ build active file",

launch.json

"preLaunchTask": "clang++ build active file"

한글로 되어있을 경우엔 되도록 영어로 바꿔 주도록 합니다.

2.4 C/C++ configuration 세팅

이제 c_cpp_properties.json 파일 세팅 하기 위해 Ctrl+Shift+P 단축키로 Command Palette 열어줍니다.

이후 C/C++:Edit Configurations (UI) 로 UI 형태로 세팅하거나 C/C++:Edit Configurations (JSON) 으로 아래 코드를 복붙합니다.

{
  "configurations": [
    {
      "name": "Mac",
      "includePath": ["${workspaceFolder}/**"],
      "defines": [],
      "macFrameworkPath": [
        "/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/System/Library/Frameworks"
      ],
      "compilerPath": "/usr/bin/clang",
      "cStandard": "c11",
      "cppStandard": "c++17",
      "intelliSenseMode": "clang-x64"
    }
  ],
  "version": 4
}

3. 나의 디버깅 세팅

3.1 tasks.json

특정 위치에서 파일을 실행시켰을 때, Debug/ 폴더 내부에 바이너리 실행파일 및 *.dSYM/ 폴더를 넣도록 구성하였습니다.

{
  // See https://go.microsoft.com/fwlink/?LinkId=733558
  // for the documentation about the tasks.json format
  "version": "2.0.0",
  "tasks": [
    {
      "type": "shell",
      "label": "clang++ build active file",
      "command": "/usr/bin/clang++",
      "args": [
        "-std=c++17",
        "-stdlib=libc++",
        "-g",
        "${file}",
        "-o",
        "Debug/${fileBasenameNoExtension}"
      ],
      "options": {
        "cwd": "${workspaceFolder}"
      },
      "problemMatcher": ["$gcc"],
      "group": {
        "kind": "build",
        "isDefault": true
      }
    }
  ]
}

• "${workspaceFolder}/dp/RGBDistance.cpp" -> "${file}"
• "Debug/${fileBasenameNoExtension}" -> "Debug/${fileBasenameNoExtension}"
• 참고: https://code.visualstudio.com/docs/editor/variables-reference

3.2 launch.json

Debug/ 폴더 내부에 바이너리 실행파일을 찾아서 실행하도록 구성하였습니다.

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
      {
        "name": "clang++ - Build and debug active file",
        "type": "lldb",
        "request": "launch",
        "program": "Debug/${fileBasenameNoExtension}",
        "args": [],
        "stopAtEntry": true,
        "cwd": "${workspaceFolder}",
        "environment": [],
        "externalConsole": false,
        "MIMode": "lldb",
        "preLaunchTask": "clang++ build active file"
      }
    ]
}

참고

• [VSCode] Using Clang in Visual Studio Code: https://code.visualstudio.com/docs/cpp/config-clang-mac
• [VSCode] Variables Reference(Predefined): https://code.visualstudio.com/docs/editor/variables-reference 
• [Blog] 맥북 M1 VSCODE C++ 설정 환경 설정 개발환경 세팅 AppleSilicon: https://polarcompass.tistory.com/12