VS Code で Linux 上の C++ を使用する

このチュートリアルでは、Linux 上で GCC C++ コンパイラー (g++) と GDB デバッガーを使用するように Visual Studio Code を構成します。GCC は GNU Compiler Collection の略で、GDB は GNU デバッガーです。

VS Code の構成後、VS Code で簡単な C++ プログラムをコンパイルしてデバッグします。このチュートリアルでは、GCC、GDB、Ubuntu、または C++ 言語については説明しません。これらの主題については、Web 上で利用できる優れたリソースが多数あります。

問題が発生した場合は、VS Code ドキュメント リポジトリでこのチュートリアルの issue をお気軽に提出してください。

前提条件

このチュートリアルを正常に完了するには、次のことを行う必要があります

1. Visual Studio Code をインストールします。

2. VS Code 用 C++ 拡張機能をインストールします。C/C++ 拡張機能は、拡張機能ビュー (⇧⌘X (Windows、Linux Ctrl+Shift+X)) で「c++」を検索してインストールできます。

   

GCC がインストールされていることを確認する

ソース コードの編集には VS Code を使用しますが、ソース コードは Linux 上で g++ コンパイラーを使用してコンパイルします。デバッグには GDB も使用します。これらのツールは Ubuntu にはデフォルトでインストールされていないため、インストールする必要があります。幸い、それは簡単です。

まず、GCC がすでにインストールされているかどうかを確認します。確認するには、ターミナル ウィンドウを開いて次のコマンドを入力します

gcc -v

GCC がインストールされていない場合は、ターミナル ウィンドウから次のコマンドを実行して Ubuntu パッケージ リストを更新します。Linux ディストリビューションが古いと、新しいパッケージのインストールが妨げられることがあります。

sudo apt-get update

次に、このコマンドで GNU コンパイラー ツールと GDB デバッガーをインストールします

sudo apt-get install build-essential gdb

Hello World を作成する

ターミナル ウィンドウから、VS Code プロジェクトを格納するための projects という名前の空のフォルダーを作成します。次に、helloworld というサブフォルダーを作成し、そこに移動して、次のコマンドを入力してそのフォルダーで VS Code を開きます

mkdir projects
cd projects
mkdir helloworld
cd helloworld
code .

code . コマンドは、現在の作業フォルダーで VS Code を開き、それが「ワークスペース」になります。チュートリアルを進めていくと、ワークスペースの .vscode フォルダーに 3 つのファイルが作成されます

• tasks.json (コンパイラーのビルド設定)
• launch.json (デバッガー設定)
• c_cpp_properties.json (コンパイラのパスと IntelliSense の設定)

hello world ソース コード ファイルを追加する

ファイル エクスプローラーのタイトル バーで、[新しいファイル] を選択し、ファイルに helloworld.cpp という名前を付けます。

次のソースコードを貼り付けます。

#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;

    return 0;
}

ここで ⌘S (Windows、Linux Ctrl+S) を押してファイルを保存します。ファイルが VS Code のサイド バーのファイル エクスプローラー ビュー (⇧⌘E (Windows、Linux Ctrl+Shift+E)) にリストされていることに注意してください

メインのファイルメニューで自動保存をチェックして、ファイルの変更を自動的に保存する自動保存を有効にすることもできます。

Visual Studio Code の端にあるアクティビティ バーを使用すると、検索、ソース管理、実行などのさまざまなビューを開くことができます。このチュートリアルの後半で実行ビューについて見ていきます。他のビューの詳細については、VS Code のユーザー インターフェイス ドキュメントを参照してください。

注: C++ ファイルを保存または開くと、C/C++ 拡張機能から Insiders バージョンの提供に関する通知が表示されることがあります。これにより、新機能や修正をテストできます。この通知は、X (通知をクリア) を選択して無視できます。

IntelliSense を探索する

helloworld.cpp ファイルで、vector または string にカーソルを合わせると、型情報が表示されます。msg 変数の宣言後、メンバー関数を呼び出すときのように msg. と入力し始めます。すぐに、すべてのメンバー関数を示す補完リストと、msg オブジェクトの型情報を示すウィンドウが表示されるはずです

Tab キーを押して、選択したメンバーを挿入できます。次に、開き括弧を追加すると、関数が必要とする引数に関する情報が表示されます。

helloworld.cpp を実行する

C++ 拡張機能は、マシンにインストールされている C++ コンパイラを使用してプログラムをビルドすることに注意してください。VS Code でhelloworld.cppを実行およびデバッグする前に、C++ コンパイラがインストールされていることを確認してください。

1. helloworld.cpp をアクティブ ファイルとして開きます。

2. エディターの右上隅にある再生ボタンを押します。

   

3. システムで検出されたコンパイラのリストから g++ build and debug active file を選択します。

   

helloworld.cpp を初めて実行するときにのみコンパイラを選択するように求められます。このコンパイラは、tasks.json ファイルで「デフォルト」コンパイラとして設定されます。

4. ビルドが成功すると、プログラムの出力は統合ターミナルに表示されます。

   

プログラムを初めて実行すると、C++ 拡張機能はtasks.jsonを作成します。これはプロジェクトの.vscodeフォルダーにあります。tasks.jsonにはビルド構成が格納されます。

新しいtasks.jsonファイルは以下の JSON のようになるはずです。

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

注意: tasks.json の変数については、変数リファレンスで詳細を確認できます。

command 設定は実行するプログラムを指定します。この場合は g++ です。args 配列は g++ に渡されるコマンドライン引数を指定します。これらの引数はコンパイラが期待する順序で指定する必要があります。

このタスクは g++ に、アクティブなファイル (${file}) を受け取り、それをコンパイルし、現在の日付ディレクトリ (${fileDirname}) に、アクティブなファイルと同じ名前で拡張子なし (${fileBasenameNoExtension}) の実行可能ファイルを作成するように指示します。この例では helloworld になります。

label の値はタスク リストに表示されるものです。好きなように名前を付けることができます。

detail の値は、タスク リストでタスクの説明として表示されるものです。類似のタスクと区別するために、この値を変更することを強くお勧めします。

これ以降、再生ボタンは tasks.json から読み取って、プログラムのビルド方法と実行方法を決定します。tasks.json に複数のビルド タスクを定義でき、デフォルトとしてマークされたタスクが再生ボタンで使用されます。デフォルトのコンパイラーを変更する必要がある場合は、Tasks: Configure default build task を実行できます。または、tasks.json ファイルを変更し、このセグメントを置き換えることでデフォルトを削除することもできます

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

これで

    "group": "build",

tasks.json の変更

"${file}" の代わりに "${workspaceFolder}/*.cpp" のような引数を使用して、複数の C++ ファイルをビルドするように tasks.json を変更できます。これにより、現在のフォルダー内のすべての .cpp ファイルがビルドされます。また、"${fileDirname}/${fileBasenameNoExtension}" をハードコードされたファイル名 (例: 'helloworld.out') に置き換えることで、出力ファイル名を変更することもできます。

helloworld.cpp をデバッグする

コードをデバッグするには、

1. helloworld.cpp に戻り、アクティブ ファイルにします。
2. エディターのマージンをクリックするか、現在の行で F9 を使用してブレークポイントを設定します。
3. 再生ボタンの横にあるドロップダウンから、C/C++ ファイルをデバッグを選択します。
4. システムで検出されたコンパイラのリストから C/C++: g++ build and debug active file を選択します (コンパイラの選択を求められるのは、helloworld.cpp を初めて実行またはデバッグするときだけです)。

再生ボタンには Run C/C++ File と Debug C/C++ File の 2 つのモードがあります。デフォルトでは最後に使用されたモードになります。再生ボタンにデバッグ アイコンが表示されている場合は、ドロップダウン メニュー項目を選択する代わりに、再生ボタンを選択するだけでデバッグできます。

デバッガーを探索する

コードのステップ実行を開始する前に、ユーザーインターフェイスのいくつかの変更点に注目してみましょう。

• 統合ターミナルはソースコード エディターの下部に表示されます。デバッグ出力タブには、デバッガーが起動して実行中であることを示す出力が表示されます。

• エディターは 12 行目をハイライトします。これはデバッガーを開始する前に設定したブレークポイントです。

  

• 左側の実行とデバッグビューにはデバッグ情報が表示されます。このチュートリアルで後ほど例を示します。

• コード エディターの上部にデバッグ コントロール パネルが表示されます。左側のドットを掴んで画面上を移動させることができます。

  

ワークスペースにすでに launch.json ファイルがある場合、再生ボタンは C++ ファイルの実行方法とデバッグ方法を判断する際にそのファイルから読み取ります。launch.json がない場合、再生ボタンは一時的な「クイック デバッグ」構成をその場で作成するため、launch.json はまったく不要になります!

コードをステップ実行する

これで、コードのステップ実行を開始する準備ができました。

1. デバッグ コントロール パネルのステップ オーバー アイコンをクリックするか、押します。

   

   これにより、プログラムの実行が for ループの最初の行に進み、msg 変数が作成および初期化されるときに呼び出される vector クラスと string クラス内のすべての内部関数呼び出しがスキップされます。横にある [変数] ウィンドウの変化に注目してください。

   

2. ステップ オーバーをもう一度押して、このプログラムの次のステートメントに進みます (ループを初期化するために実行されるすべての内部コードをスキップします)。これで、変数ウィンドウにはループ変数に関する情報が表示されます。

3. もう一度 [ステップ オーバー] を押して cout ステートメントを実行します。(C++ 拡張機能は、最後の cout が実行されるまでデバッグ コンソールに出力を表示しないことに注意してください。)

4. 必要に応じて、ベクター内のすべての単語がコンソールに出力されるまで [ステップ オーバー] を押し続けることができます。しかし、興味があれば、[ステップ イン] ボタンを押して C++ 標準ライブラリのソース コードをステップ実行してみてください!

   

   自分のコードに戻るには、[ステップ オーバー] を押し続ける方法があります。もう 1 つの方法は、コード エディターで helloworld.cpp タブに切り替え、ループ内の cout ステートメントのどこかに挿入ポイントを置き、F9 を押してコードにブレークポイントを設定することです。左側のガターに赤い点が表示され、この行にブレークポイントが設定されたことを示します。

   

   次に F5 を押して、標準ライブラリ ヘッダーの現在の行から実行を開始します。実行は cout で中断されます。必要に応じて、もう一度 F9 を押してブレークポイントをオフに切り替えることができます。

   ループが完了すると、統合ターミナルの [デバッグ コンソール] タブで出力と、GDB によって出力されるその他の診断情報を確認できます。

   

ウォッチを設定する

プログラムの実行中に変数の値を追跡するには、変数にウォッチを設定します。

1. 挿入ポイントをループ内に配置します。[ウォッチ] ウィンドウでプラス記号をクリックし、テキスト ボックスにループ変数の名前である word を入力します。ループをステップ実行しながら、[ウォッチ] ウィンドウを表示します。

   

2. ブレークポイントで実行が一時停止している間に任意の変数の値をすばやく表示するには、マウス ポインターをその変数に重ねます。

   

次に、tasks.json ファイルを作成して、プログラムのビルド (コンパイル) 方法を VS Code に指示します。このタスクは g++ コンパイラを呼び出して、ソース コードから実行可能ファイルを作成します。

次のステップでは、エディターのアクティブなファイルを使用して次のステップでビルド タスクを作成するためのコンテキストとして使用するため、エディターで helloworld.cpp を開いておくことが重要です。

launch.json を使用してデバッグをカスタマイズする

再生ボタンまたは F5 でデバッグすると、C++ 拡張機能は動的なデバッグ構成をその場で作成します。

実行時にプログラムに渡す引数を指定するなど、デバッグ構成をカスタマイズしたい場合があります。カスタム デバッグ構成はlaunch.jsonファイルで定義できます。

launch.json を作成するには、再生ボタンのドロップダウン メニューからデバッグ構成の追加を選択します。

すると、さまざまな事前定義されたデバッグ構成のドロップダウンが表示されます。g++ build and debug active file を選択します。

VS Code はlaunch.jsonファイルを作成します。これは次のようになります。

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "C/C++: g++ build and debug active file",
      "type": "cppdbg",
      "request": "launch",
      "program": "${fileDirname}/${fileBasenameNoExtension}",
      "args": [],
      "stopAtEntry": false,
      "cwd": "${workspaceFolder}",
      "environment": [],
      "externalConsole": false,
      "MIMode": "gdb",
      "miDebuggerPath": "/usr/bin/gdb",
      "setupCommands": [
        {
          "description": "Enable pretty-printing for gdb",
          "text": "-enable-pretty-printing",
          "ignoreFailures": true
        }
      ],
      "preLaunchTask": "C/C++: g++ build active file"
    }
  ]
}

上記の JSON では、program はデバッグしたいプログラムを指定します。ここでは、アクティブなファイルのフォルダー ${fileDirname} と拡張子のないアクティブなファイル名 ${fileBasenameNoExtension} に設定されており、helloworld.cpp がアクティブなファイルの場合は helloworld になります。args プロパティは、実行時にプログラムに渡す引数の配列です。

デフォルトでは、C++ 拡張機能はソースコードにブレークポイントを追加せず、stopAtEntry の値はfalseに設定されています。

デバッグを開始したときにデバッガーがmainメソッドで停止するように、stopAtEntry の値をtrueに変更します。

これ以降、再生ボタンと F5 は、デバッグのためにプログラムを起動するときに launch.json ファイルから読み取ります。

C/C++ の構成

C/C++ 拡張機能をより細かく制御したい場合は、c_cpp_properties.json ファイルを作成できます。これにより、コンパイラへのパス、インクルード パス、C++ 標準 (デフォルトは C++17) などの設定を変更できます。

C/C++ 構成 UI は、コマンド パレット (⇧⌘P (Windows、Linux Ctrl+Shift+P)) から C/C++: Edit Configurations (UI) コマンドを実行することで表示できます。

これにより、C/C++ 構成ページが開きます。ここで変更を加えると、VS Code はそれらを.vscodeフォルダー内のc_cpp_properties.jsonというファイルに書き込みます。

インクルード パス設定を変更する必要があるのは、プログラムにワークスペース内または標準ライブラリ パスにないヘッダー ファイルが含まれている場合のみです。

Visual Studio Code はこれらの設定を .vscode/c_cpp_properties.json に配置します。このファイルを直接開くと、次のようになります。

{
  "configurations": [
    {
      "name": "Linux",
      "includePath": ["${workspaceFolder}/**"],
      "defines": [],
      "compilerPath": "/usr/bin/gcc",
      "cStandard": "c11",
      "cppStandard": "c++17",
      "intelliSenseMode": "clang-x64"
    }
  ],
  "version": 4
}

C++ 構成の再利用

VS Code は Linux で gcc を使用するように構成されました。この構成は現在のワークスペースに適用されます。構成を再利用するには、JSON ファイルを新しいプロジェクト フォルダー (ワークスペース) の .vscode フォルダーにコピーし、必要に応じてソース ファイル名と実行可能ファイル名を変更します。

トラブルシューティング

コンパイラとリンクのエラー

エラー (undefined _main や attempting to link with file built for unknown-unsupported file format など) の最も一般的な原因は、ビルドを開始したりデバッグを開始したりするときに helloworld.cpp がアクティブなファイルでない場合に発生します。これは、コンパイラが launch.json、tasks.json、c_cpp_properties.json ファイルのようなソース コードではないものをコンパイルしようとしているためです。

次のステップ

• VS Code ユーザー ガイドを参照してください。
• C++ 拡張機能の概要を確認してください。
• 新しいワークスペースを作成し、そこに .json ファイルをコピーし、新しいワークスペース パス、プログラム名などの必要な設定を調整して、コーディングを開始しましょう!