Bỏ qua để đến nội dung

Cài đặt C++ trên macOS (Clang + VS Code)

Bài này hướng dẫn cấu hình Visual Studio Code trên macOS để dùng trình biên dịch Clang/LLVM (clang++) và trình gỡ lỗi (debugger) LLDB. Sau khi cài xong, bạn sẽ biên dịch, chạy và debug một chương trình C++ ngay trong VS Code.

Bài này không dạy về Clang hay ngôn ngữ C++. Mục tiêu là có một môi trường chạy được để bắt đầu học các bài tiếp theo.

  1. Cài Visual Studio Code và bật lệnh code trong Terminal.
  2. Cài extension C/C++ của Microsoft cho VS Code.

Nếu chưa làm 2 bước này, xem bài Cài đặt Visual Studio Code cho C++.

Extension C/C++ của Microsoft trong khung Extensions của VS Code

Clang có thể đã có sẵn trên máy Mac của bạn. Để kiểm tra, mở Terminal (tìm bằng Spotlight Cmd+Space, gõ “Terminal”) và gõ:

Terminal window
clang --version

Nếu thấy thông tin phiên bản là đã có. Nếu chưa có, chạy lệnh sau để cài Command Line Tools của Xcode (bộ công cụ dòng lệnh dành cho lập trình viên, đã gồm Clang):

Terminal window
xcode-select --install

Một hộp thoại hiện ra, bấm Install và chờ cài xong. Bạn không cần cài cả ứng dụng Xcode đầy đủ.

Trong Terminal, chạy các lệnh sau:

Terminal window
mkdir projects
cd projects
mkdir helloworld
cd helloworld
code .

Các lệnh này tạo thư mục projects để chứa mọi dự án VS Code của bạn, tạo thư mục con helloworld, đi vào đó và mở nó bằng VS Code.

Lệnh code . mở VS Code tại thư mục hiện tại, thư mục này trở thành workspace của bạn. Nếu VS Code hỏi có tin tưởng tác giả của thư mục không, chọn Yes, I trust the authors vì đây là thư mục bạn tự tạo.

Trong quá trình làm theo bài, VS Code sẽ tạo 3 file trong thư mục .vscode của workspace:

  • tasks.json: thiết lập build (biên dịch)
  • launch.json: thiết lập debugger
  • c_cpp_properties.json: đường dẫn trình biên dịch và thiết lập IntelliSense

Trên thanh tiêu đề của khung Explorer, bấm nút New File và đặt tên file là helloworld.cpp.

Nút New File trên thanh tiêu đề khung Explorer

Dán đoạn code sau vào file:

#include <iostream>
#include <vector>
#include <string>
using namespace std;
int main()
{
vector<string> msg {"Hello", "C++", "World", "from", "VS Code", "and the C++ extension!"};
for (const string& word : msg)
{
cout << word << " ";
}
cout << endl;
}

Nhấn Cmd+S để lưu. File vừa tạo hiện trong khung Explorer (Cmd+Shift+E) ở thanh bên của VS Code:

File helloworld.cpp trong khung Explorer

Bạn có thể bật File > Auto Save để VS Code tự lưu mỗi khi bạn sửa code.

IntelliSense giúp bạn viết code nhanh hơn với các tính năng như tự hoàn thành code, hiện thông tin tham số, thông tin nhanh và danh sách thành viên.

Rê chuột lên chữ vector hoặc string để xem thông tin kiểu dữ liệu. Nếu bạn gõ msg. ở dòng 10, VS Code hiện danh sách các hàm thành viên có thể gọi:

Danh sách gợi ý hàm thành viên khi gõ msg.

Nhấn Tab để chèn mục đang chọn. Khi bạn gõ tiếp dấu mở ngoặc (, IntelliSense hiện thông tin các tham số hàm cần.

Nếu IntelliSense chưa được cấu hình, mở Command Palette (Cmd+Shift+P), gõ Select IntelliSense Configuration và chọn Use clang++ trong danh sách trình biên dịch.

Extension C/C++ dùng trình biên dịch đã cài trên máy để build chương trình, nên hãy chắc chắn bạn đã có Clang trước khi chạy.

  1. Mở helloworld.cpp để nó là file đang được chọn (active file).

  2. Bấm nút Play (hình tam giác) ở góc trên bên phải trình soạn thảo.

    Nút Play ở góc trên bên phải trình soạn thảo

  3. Chọn C/C++: clang++ build and debug active file trong danh sách trình biên dịch VS Code tìm thấy trên máy.

    Danh sách chọn cấu hình, chọn clang++ build and debug active file

    VS Code chỉ hỏi chọn trình biên dịch ở lần chạy đầu tiên. Trình biên dịch này được đặt làm mặc định trong file tasks.json.

  4. Build xong, kết quả chạy chương trình hiện trong khung Debug Console.

    Kết quả chạy chương trình trong Debug Console

Chúc mừng, bạn vừa chạy chương trình C++ đầu tiên trong VS Code!

Lần chạy đầu tiên, extension C/C++ tạo file tasks.json trong thư mục .vscode của dự án. Đây là ví dụ tasks.json trên macOS:

{
"tasks": [
{
"type": "cppbuild",
"label": "C/C++: clang++ build active file",
"command": "/usr/bin/clang++",
"args": [
"-fcolor-diagnostics",
"-fansi-escape-codes",
"-g",
"${file}",
"-o",
"${fileDirname}/${fileBasenameNoExtension}"
],
"options": {
"cwd": "${fileDirname}"
},
"problemMatcher": ["$gcc"],
"group": {
"kind": "build",
"isDefault": true
},
"detail": "Task generated by Debugger."
}
],
"version": "2.0.0"
}

Ý nghĩa các trường chính:

  • command: chương trình sẽ chạy, ở đây là clang++.
  • args: các tham số dòng lệnh truyền cho clang++, theo đúng thứ tự trình biên dịch yêu cầu. Task này bảo trình biên dịch lấy file đang mở (${file}), biên dịch, và tạo file kết quả (tham số -o) trong thư mục của file đó (${fileDirname}), cùng tên nhưng không có đuôi (${fileBasenameNoExtension}). Với ví dụ này, kết quả là file helloworld. Tham số -g thêm thông tin để debug được.
  • label: tên task hiện trong danh sách task, đặt tùy ý.
  • detail: mô tả task trong danh sách. Nên đổi thành nội dung riêng để phân biệt với các task tương tự.
  • problemMatcher: bộ đọc kết quả biên dịch để tìm lỗi và cảnh báo. Với clang++, dùng $gcc cho kết quả tốt nhất.

Các biến dạng ${file}, ${fileDirname} được giải thích đầy đủ ở bảng tham chiếu biến của VS Code.

Từ giờ, nút Play luôn đọc tasks.json để biết cách build và chạy chương trình. Bạn có thể khai báo nhiều task build, task được đánh dấu mặc định sẽ được nút Play dùng. Muốn đổi trình biên dịch mặc định, chạy lệnh Tasks: Configure Default Build Task trong Command Palette. Hoặc sửa tasks.json, bỏ đánh dấu mặc định bằng cách thay đoạn:

"group": {
"kind": "build",
"isDefault": true
},

bằng:

"group": "build",
  • Muốn build nhiều file C++ cùng lúc, thay "${file}" bằng "${workspaceFolder}/*.cpp". Khi đó mọi file .cpp trong thư mục hiện tại đều được build.
  • Muốn đặt tên cố định cho file kết quả, thay "${fileDirname}/${fileBasenameNoExtension}" bằng một tên cụ thể, ví dụ "${workspaceFolder}/myProgram.out".
  1. Quay lại helloworld.cpp để nó là file đang chọn.

  2. Đặt breakpoint (điểm dừng) bằng cách bấm vào lề trái trình soạn thảo, hoặc nhấn F9 ở dòng hiện tại.

    Breakpoint (chấm đỏ) trong helloworld.cpp

  3. Ở menu thả xuống cạnh nút Play, chọn Debug C/C++ File.

    Menu thả xuống của nút Play, chọn Debug C/C++ File

  4. Chọn C/C++: clang++ build and debug active file trong danh sách trình biên dịch (chỉ hỏi ở lần chạy hoặc debug đầu tiên).

    Danh sách chọn cấu hình debug clang++

  5. Task build chạy và in kết quả ra khung Terminal.

    Kết quả task build trong Terminal

Nút Play có 2 chế độ: Run C/C++ File và Debug C/C++ File, mặc định là chế độ dùng lần gần nhất. Nếu nút Play đang hiện biểu tượng debug, bạn chỉ cần bấm nút Play để debug.

Trước khi chạy từng bước, để ý vài thay đổi trên giao diện:

  • Khung Terminal tích hợp xuất hiện ở dưới trình soạn thảo. Tab Debug Console hiện thông báo cho biết debugger đang chạy.

  • Trình soạn thảo tô sáng dòng có breakpoint bạn đặt trước khi debug:

    Dòng có breakpoint được tô sáng khi bắt đầu debug

  • Khung Run and Debug trên thanh Activity Bar hiện thông tin debug.

  • Phía trên trình soạn thảo xuất hiện thanh điều khiển debug. Bạn có thể kéo thanh này đi chỗ khác bằng phần chấm chấm ở bên trái.

    Thanh điều khiển debug

  1. Bấm biểu tượng Step over trên thanh điều khiển debug, cho đến khi câu lệnh for (const string& word : msg) được tô sáng.

    Nút Step over trên thanh điều khiển debug

    Lệnh Step Over bỏ qua (không đi vào) các hàm bên trong lớp vector và string được gọi khi tạo biến msg. Để ý khung Variables thay đổi: nội dung của msg đã hiện, vì câu lệnh tạo msg đã chạy xong.

  2. Bấm Step over lần nữa để sang câu lệnh tiếp theo (bỏ qua phần code nội bộ khởi tạo vòng lặp). Khung Variables giờ hiện thông tin biến của vòng lặp.

  3. Bấm Step over lần nữa để chạy câu lệnh cout.

  4. Bạn có thể bấm Step over tiếp cho đến khi in hết các từ trong vector. Nếu tò mò, thử bấm Step Into để đi vào bên trong mã nguồn của thư viện chuẩn C++!

Đôi khi bạn muốn theo dõi giá trị một biến trong lúc chương trình chạy. Cách làm là đặt watch cho biến đó.

  1. Ở khung Watch, bấm dấu cộng và gõ word, tên biến của vòng lặp. Giờ hãy nhìn khung Watch trong lúc chạy từng bước qua vòng lặp.

    Khung Watch theo dõi biến word

  2. Thêm một watch nữa: thêm câu lệnh int i = 0; trước vòng lặp, và ++i; bên trong vòng lặp. Sau đó thêm watch cho i như bước trên.

  3. Khi chương trình đang dừng, rê chuột lên biến bất kỳ để xem nhanh giá trị.

    Rê chuột lên biến để xem giá trị

Khi bạn debug bằng nút Play hoặc F5, extension C/C++ tự tạo một cấu hình debug tạm thời.

Có lúc bạn muốn tùy chỉnh cấu hình debug, ví dụ truyền tham số cho chương trình khi chạy. Khi đó, bạn khai báo cấu hình trong file launch.json.

Để tạo launch.json, chọn Add Debug Configuration trong menu thả xuống của nút Play.

Mục Add Debug Configuration trong menu của nút Play

VS Code hiện danh sách các cấu hình debug có sẵn. Chọn C/C++: clang++ build and debug active file.

Danh sách chọn cấu hình debug clang++

VS Code tạo file launch.json, nội dung tương tự:

{
"configurations": [
{
"name": "C/C++: clang++ build and debug active file",
"type": "cppdbg",
"request": "launch",
"program": "${fileDirname}/${fileBasenameNoExtension}",
"args": [],
"stopAtEntry": false,
"cwd": "${fileDirname}",
"environment": [],
"externalConsole": false,
"MIMode": "lldb",
"preLaunchTask": "C/C++: clang++ build active file"
}
],
"version": "2.0.0"
}
  • program: chương trình cần debug, là file trong thư mục của file đang mở (${fileDirname}) với tên ${fileBasenameNoExtension}. Nếu file đang mở là helloworld.cpp thì chương trình là helloworld.
  • args: mảng các tham số truyền cho chương trình khi chạy.
  • stopAtEntry: mặc định là false, extension C/C++ không tự thêm breakpoint nào. Đổi thành true để debugger dừng ngay ở hàm main khi bắt đầu debug.
  • MIMode: lldb là debugger đi kèm Clang trên macOS.
  • preLaunchTask: phải trùng với label của task build trong tasks.json.

Từ giờ, nút Play và F5 đọc launch.json khi khởi động debug.

Muốn kiểm soát extension C/C++ nhiều hơn, bạn tạo file c_cpp_properties.json. File này cho phép đổi các thiết lập như đường dẫn trình biên dịch, đường dẫn thư mục header (include path), chuẩn C++ dùng để biên dịch (ví dụ C++17)…

Mở giao diện cấu hình bằng lệnh C/C++: Edit Configurations (UI) trong Command Palette (Cmd+Shift+P).

Lệnh C/C++: Edit Configurations (UI) trong Command Palette trên macOS

Trang C/C++ Configurations mở ra.

Trang C/C++ Configurations với trình biên dịch Clang

VS Code ghi các thiết lập này vào .vscode/c_cpp_properties.json. Mở trực tiếp file đó, bạn sẽ thấy nội dung tương tự:

{
"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": "macos-clang-arm64"
}
],
"version": 4
}

Bạn chỉ cần sửa Include path khi chương trình dùng file header nằm ngoài workspace và ngoài thư viện chuẩn.

Extension dùng thiết lập compilerPath để suy ra vị trí các file header của thư viện chuẩn C++. Khi biết các file đó nằm đâu, extension mới cung cấp được gợi ý code chính xác và tính năng Go to Definition (nhảy tới chỗ khai báo).

Extension C/C++ tự điền compilerPath bằng trình biên dịch tìm thấy trên máy, theo thứ tự:

  1. Tìm tên các trình biên dịch quen thuộc trong PATH. Thứ tự trình biên dịch trong danh sách phụ thuộc vào thứ tự trong PATH.
  2. Sau đó tìm ở các đường dẫn Xcode cố định, ví dụ /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/.

Xem thêm ở tài liệu cấu hình IntelliSense.

Ở trang C/C++ Configurations, kéo xuống mở Advanced Settings và kiểm tra Mac framework path trỏ tới thư mục header của hệ thống, ví dụ /Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/System/Library/Frameworks.

Nguyên nhân hay gặp của các lỗi như undefined _main hoặc attempting to link with file built for unknown-unsupported file format là lúc bắt đầu build hoặc debug, file đang chọn không phải helloworld.cpp. Khi đó trình biên dịch cố biên dịch một file không phải mã nguồn, ví dụ launch.json, tasks.json hoặc c_cpp_properties.json. Hãy bấm vào tab helloworld.cpp rồi chạy lại.

Nếu gặp lỗi build nhắc tới “C++11 extensions”, có thể task build chưa dùng tham số --std=c++17 của clang++. Mặc định clang++ có thể dùng chuẩn C++98, chuẩn này không hỗ trợ cách khởi tạo vector bằng dấu {} trong helloworld.cpp. Hãy thêm "--std=c++17" vào mảng args trong tasks.json, hoặc thay toàn bộ nội dung tasks.json bằng đoạn ở phần Hiểu file tasks.json rồi thêm tham số này.

Từ macOS Catalina trở đi, có thể gặp lỗi không nhập được dữ liệu khi debug, kể cả khi đã đặt "externalConsole": true: cửa sổ terminal mở ra nhưng không gõ được gì. Lỗi này đang được theo dõi ở issue #5079.

Cách khắc phục là cho VS Code mở Terminal một lần. Thêm task sau vào mảng tasks trong tasks.json:

{
"label": "Open Terminal",
"type": "shell",
"command": "osascript -e 'tell application \"Terminal\"\ndo script \"echo hello\"\nend tell'",
"problemMatcher": []
}

Chạy task này bằng Terminal > Run Task… rồi chọn Open Terminal. Sau khi bạn đồng ý yêu cầu cấp quyền của macOS, cửa sổ console bên ngoài sẽ hiện ra bình thường khi debug.

  • Khi tạo dự án mới, tạo workspace mới, chép các file JSON trong thư mục .vscode sang, sửa lại đường dẫn, tên chương trình nếu cần, và bắt đầu viết code.
  • Đọc tiếp: Tạo dự án (project) C++ đầu tiên.